Repository navigation
[Automated] Draft docs (kagent): Bump Substrate to 0.5.0-alpha1 and share PostgreSQL via kagent install - #584
Open
github-actions[bot] wants to merge 1 commit into
Open
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…hare PostgreSQL via kagent install 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#2708 — Bump Substrate to 0.5.0-alpha1 and share PostgreSQL via kagent install
Docs versions:
1.x(first shipped in v1.0.0-alpha10)What changes for users:
kagent installnow installs kagent, Agent Substrate, the Substrate PodCertificate controller, and a shared development PostgreSQL database that uses Pod Certificates. Direct Helm installs no longer deploy PostgreSQL or Substrate and must usedatabase.postgres.connectionStringSecretRef; checkpoint forks are temporarily rejected withFAILED_PRECONDITIONwhile suspended snapshots include process memory.What the docs now say: The install, operations, memory, upgrade, uninstall, Substrate, MCP, and UI pages now describe the CLI install path, Secret-based PostgreSQL settings, the development database limits, and the temporary checkpoint fork limitation. Generated environment, Helm, and CLI reference pages were left untouched because the update-ref workflow owns them.
Not verified: No cluster; the installation, Helm values, and checkpoint commands are unrun.
How
kagent-2708was drafted, and what was not verifiedPlan, and what changed it
body.mdand the code diff show checkpoint forks are rejected for now, andreference/env-vars.mdsays the stale reference tables are generated.Why a documentation change is necessary
The pull request changes the supported installation path:
kagent installnow creates the development PostgreSQL database, Substrate prerequisites, Substrate releases, and the kagent release. Existing docs said to install Agent Substrate manually, warned thatkagent installcould not produce a working 1.0 installation, and documented removed Helm values such asdatabase.postgres.url,database.postgres.urlFile, anddatabase.postgres.bundled.*.The same pull request changes observable runtime behavior for checkpoints. Existing pages told readers to fork checkpoints, but the diff and tests show
ForkSessionnow rejects process-memory checkpoints withFAILED_PRECONDITIONuntil lifecycle v2 restores Data snapshots on suspend.What changed on disk
docs-site/content/kagent/1.x/setup/installation.md— Replaced the manual Agent Substrate and Helm flow with thekagent installflow.docs-site/content/kagent/1.x/operations/operational-considerations.md— Updated production PostgreSQL guidance toconnectionStringSecretRef,role, and Pod Certificate behavior.docs-site/content/kagent/1.x/agents/agent-memory.md— Updated memory setup to use a connection Secret instead ofurlFileand mounted volumes.docs-site/content/kagent/1.x/operations/upgrade-from-0x.md— Updated migration install guidance for the new database Secret values.docs-site/content/kagent/1.x/operations/uninstall.md— Updated cleanup guidance for CLI-created PostgreSQL resources, Substrate PodCertificate, and CA pools.docs-site/content/kagent/1.x/about/substrate-runtime/suspend-and-resume.md— Documented current Full snapshot behavior and temporary fork rejection.docs-site/content/kagent/1.x/about/architecture/agent-substrate.md— Changed the snapshot/tag description so it no longer promises fork availability.docs-site/content/kagent/1.x/examples/agent-substrate.md— Removed runnable fork steps and added the current limitation.docs-site/content/kagent/1.x/examples/agents-via-mcp.md— Removed MCP fork walkthroughs and markedfork_sessionas temporarily rejected.docs-site/content/kagent/1.x/observability/launch-ui.md— Updated the UI checkpoint controls description for the disabled Fork action.docs-site/content/kagent/1.x/about/what-is-kagent.md— Reframed the feature card from fork to checkpoints.docs-site/content/kagent/1.x/examples/a2a-byo.md— Updated the Agent Substrate card subtitle.docs-site/content/kagent/1.x/get-started/your-first-mcp-tool.md— Updated the Agent Substrate card subtitle.How to verify this change
docs-site/content/kagent/1.x/setup/installation.md: runKAGENT_HELM_EXTRA_ARGS="--set controller.grpc.reflection=true" kagent install --namespace kagent.kubectl get pods -n kagent,kubectl get pods -n ate-system, andkubectl get secret kagent-postgres -n kagent -o jsonpath='{.data.connectionString}'.operations/operational-considerations.md, run the Helm command, and check that the controller pod readsKAGENT_POSTGRES_DATABASE_URLfrom the named Secret andKAGENT_POSTGRES_DATABASE_ROLEfrom the configured role.CheckpointService/ForkSession; the response should fail withFAILED_PRECONDITION.What was not verified
database.postgres.bundled,database.postgres.url,database.postgres.urlFile, andKAGENT_POSTGRES_DATABASE_URL_FILEentries; they were not edited because the update-ref workflow owns them.diff-truncated.mdsayshelm/kagent-crds/values.yamlandui/src/generated/ateapi_pb.tsare not in the code diff.How the pages were chosen (triage report)
Draft a documentation change
kagent-dev/kagent#2708 — Bump Substrate to 0.5.0-alpha1 and share PostgreSQL via kagent install
kagent-dev/websitekagent installthe way to install Kagent, Substrate, and a shared development PostgreSQL database together. Kagent, Substrate, and PostgreSQL authenticate with rotating Pod Certificates instead of passwords. The Kagent Helm chart no longer deploys PostgreSQL or bundles Substrate as a subchart.go/core/pkg/env/database.go. Still quoted at:docs-site/content/kagent/1.x/reference/env-vars.md:53docs-site/content/kagent/1.x/reference/env-vars.md:188docs-site/content/kagent/1.x/reference/env-vars.md:208go/core/pkg/env/database.go. Still quoted at:docs-site/content/kagent/1.x/reference/env-vars.md:54docs-site/content/kagent/1.x/reference/env-vars.md:189go/core/pkg/env/cli.go. Still quoted at:docs-site/content/kagent/1.x/reference/env-vars.md:204AGENTS.mdDEVELOPMENT.mdMakefileREADME.mdcontrib/cncf/technical-review.mddocs/architecture/persistence-checkpoints-and-forks.mdDraft branch:
pr-tracker-draft-kagent-2708Important
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.