Repository navigation
[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
Open
[Automated] Draft docs (kagent): build(ui): serve the UI from distroless nginx with a Go entrypoint#660github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…ess nginx with a Go entrypoint Signed-off-by: GitHub Action <action@github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdui/.nvmrcui/README.mdui/docs/app-extensions.mdui/entrypoint/main.goui/index.htmlWhat 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
execprobes cannot run because the image has no shell orcurl; custom probes must usehttpGetortcpSocket.What the docs now say: The Operational considerations page now has a Customize UI probes section that shows
ui.startupProbeandui.readinessProbewithhttpGetprobes, names the chart defaults, and warns againstexecprobes for the UI image.Not verified: No configured cluster in this CI run; the configuration is unrun.
How
kagent-3316was drafted, and what was not verifiedPlan, and what changed it
installation.mdcovers the default fresh install, whileoperational-considerations.mdalready owns Helm runtime settings such as images and probes.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
httpGetortcpSocketinstead. The code diff changes the Helm values comments forui.startupProbeandui.readinessProbefrom allowing exec probes to saying that the image has no shell orcurl. The operations page already discusses Helm settings that affect pod runtime behavior, but it did not tell operators that custom UI probes must avoidexec.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
httpGet.httpGet.path: /health,httpGet.port: http, and noexeckey.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
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:
docs-site/content/kagent/1.x/setup/installation.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land thereDraft a documentation change
kagent-dev/kagent#3316 — build(ui): serve the UI from distroless nginx with a Go entrypoint
kagent-dev/websitescripts/setup-cluster/README.mdui/.nvmrcui/README.mdui/docs/app-extensions.mdui/entrypoint/main.goui/index.htmlDraft branch:
pr-tracker-draft-kagent-3316Important
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 asaction_requireduntil 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.