Skip to content

[Automated] Draft docs (kagent): build(ui): serve the UI from distroless nginx with a Go entrypoint - #660

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-kagent-3316
Open

github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-kagent-3316

Conversation

@github-actions

@github-actions github-actions Bot commented Nov 1, 2026

Copy link
Copy Markdown
Contributor

kagent-dev/kagent#3316 — build(ui): serve the UI from distroless nginx with a Go entrypoint

Docs versions: 1.x (first shipped in v1.0.0-rc1)

No code-path rule covers 8 touched file(s). The planner could route these only by identifier search, so the candidate pages may miss what they changed, including in the other mode:

  • scripts/setup-cluster/README.md
  • ui/.nvmrc
  • ui/README.md
  • ui/docs/app-extensions.md
  • ui/entrypoint/main.go
  • ui/index.html
  • ...and 2 more

What changes for users: The UI image now runs on distroless nginx with a Go entrypoint. Runtime UI settings still render from the pod environment, but custom exec probes cannot run because the image has no shell or curl; custom probes must use httpGet or tcpSocket.

What the docs now say: The Operational considerations page now has a Customize UI probes section that shows ui.startupProbe and ui.readinessProbe with httpGet probes, names the chart defaults, and warns against exec probes for the UI image.

Not verified: No configured cluster in this CI run; the configuration is unrun.

How kagent-3316 was drafted, and what was not verified

Plan, and what changed it

  • Planned: Choose between the installation and operations pages for the UI image behavior and probe caveat.
  • Learned: installation.md covers the default fresh install, while operational-considerations.md already owns Helm runtime settings such as images and probes.
  • Did: Added a Customize UI probes section to operational-considerations.md.

Why a documentation change is necessary

The declared release note says that the UI image now has no shell and that custom exec probes must use httpGet or tcpSocket instead. The code diff changes the Helm values comments for ui.startupProbe and ui.readinessProbe from allowing exec probes to saying that the image has no shell or curl. The operations page already discusses Helm settings that affect pod runtime behavior, but it did not tell operators that custom UI probes must avoid exec.

What changed on disk

  • docs-site/content/kagent/1.x/operations/operational-considerations.md — Added UI probe guidance for the distroless UI image.

How to verify this change

  1. Save a Helm values file that customizes the UI probes with httpGet.
    ui:
      startupProbe:
        httpGet:
          path: /health
          port: http
        initialDelaySeconds: 1
        periodSeconds: 5
        failureThreshold: 20
      readinessProbe:
        httpGet:
          path: /health
          port: http
        periodSeconds: 30
  2. Apply the values to the kagent release, then wait for the UI Deployment to roll out.
    helm upgrade kagent \
      oci://ghcr.io/kagent-dev/kagent/helm/kagent \
      --namespace kagent \
      --reuse-values \
      --values ui-probes.yaml
    kubectl rollout status deployment/kagent-ui -n kagent --timeout=300s
  3. Inspect the rendered Deployment.
    kubectl get deployment/kagent-ui -n kagent -o yaml \
      | yq '.spec.template.spec.containers[].startupProbe, .spec.template.spec.containers[].readinessProbe'
    The output shows httpGet.path: /health, httpGet.port: http, and no exec key.

Proposed release note

The UI image now runs on a distroless nginx base with no shell; UI settings work as before, and custom exec probes must use httpGet or tcpSocket.

What was not verified

  • The configuration was not applied to a cluster, so every command in this diff is unrun.
  • Internal links are unchecked because this run did not run Hugo.
How the pages were chosen (triage report)

Feature clusters

Kept apart on purpose. Merging wrongly produces a guide that documents two things and explains neither, so these are reported for a person to merge rather than grouped automatically:

Draft a documentation change

kagent-dev/kagent#3316 — build(ui): serve the UI from distroless nginx with a Go entrypoint

  • Product: kagent (upstream) → kagent-dev/website
  • Docs version: 1.x
  • Release note: The UI image now runs on a distroless nginx base with no shell; UI settings work as before, and custom exec probes must use httpGet or tcpSocket.
  • Not tested: no cluster was available, so every command in this diff is unrun
  • No rule covers 8 touched file(s). The candidate pages below come from the files that DID match a rule, so they may scope this narrower than the change is. Read these before deciding the change is only about the pages listed:
    • scripts/setup-cluster/README.md
    • ui/.nvmrc
    • ui/README.md
    • ui/docs/app-extensions.md
    • ui/entrypoint/main.go
    • ui/index.html
    • ...and 2 more

Draft branch: pr-tracker-draft-kagent-3316


Important

The test suite has not run on this pull request. It was opened by github-actions[bot], and GitHub does not start workflows for pull requests opened with the repository's own token. This repository's checks are held as action_required until somebody presses Approve and run on the Checks tab. Checks that come from GitHub Apps rather than Actions, such as DCO, run on their own.

Please approve the checks before reviewing the content: an absence of failures here means the tests have not run, not that they passed.

…ess nginx with a Go entrypoint

Signed-off-by: GitHub Action <action@github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant