Repository navigation
[Automated] Draft docs (kagent): fix(database): retry failed PostgreSQL logins and report them as… - #734
Open
github-actions[bot] wants to merge 1 commit into
Open
[Automated] Draft docs (kagent): fix(database): retry failed PostgreSQL logins and report them as…#734github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…QL logins and report them as… 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.
The target's own content scan fails where the base build passed (docs-theme-extras
markdown-leaks/built-html-integrity):kagent-dev/kagent#3550 — fix(database): retry failed PostgreSQL logins and report them as Unavailable
Docs versions:
mainNo code-path rule covers 7 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:
go/api/gen/kagent/config/v1/config.pb.gogo/core/internal/grpcserver/interceptors.gogo/core/pkg/app/app.gogo/core/pkg/config/defaults.gogo/core/pkg/postgres/pool.gohelm/README.mdWhat changes for users: Failed PostgreSQL logins now retry for up to
config.database.pool.connectRetryTimeout, which defaults to90sand can be set to0sto try once. When the final failed login happens before SQL runs, controller APIs returnUnavailable "database unavailable"and log the cause.What the docs now say: The operational considerations page now lists
config.database.pool.connectRetryTimeoutbeside the other database pool settings, shows it in the external PostgreSQL values example, and explains the retry limits and non-retried cases.How
kagent-3550was draftedPlan, and what changed it
connectRetryTimeouton the page that owns external PostgreSQL andconfig.database.pool.operations/upgrade-from-0x.mdandsetup/installation.mdonly point readers to that operational page for database settings, whileoperations/operational-considerations.mdalready carries the pool example and field table.docs-site/content/kagent/main/operations/operational-considerations.mdonly.Why a documentation change is necessary
The pull request adds
config.database.pool.connectRetryTimeout, changes the default database-login behavior to retry for90s, and lets operators restore the old one-attempt behavior with0s. The operational considerations page already documents external PostgreSQL and theconfig.database.poolfields, but it did not list the new field or the default. A reader tuning a production database connection would not know why API calls can now wait through a failed login, how to shorten that retry, or which failures are not retried.How to verify this change
kagent.yamlvalues file withconfig.database.pool.connectRetryTimeout: 90s, then render the controller configuration by using thehelm template ... --show-only templates/controller-configmap.yamlcommand on the operational considerations page.yq '.data."controller.yaml" | from_yaml | .database.pool.connectRetryTimeout'on the rendered ConfigMap. The output shows90s.601s, render again, and runkagent config validate --component controller --config controller.yaml. The command rejects the rendered configuration because the value is greater than600s.Proposed release note
No separate
proposed-release-note.md:markers.notes_placeableisfalsefor this product run.Failed PostgreSQL logins, such as during a restart or serverless database resume, now retry for up to
config.database.pool.connectRetryTimeout. The setting defaults to90sand can be set to0sto try once. When the final failed login happens before SQL runs, controller APIs returnUnavailable "database unavailable"and log the cause; rejected credentials and failures after login are not retried.Files in this pull request
docs-site/content/kagent/main/operations/operational-considerations.mdHow the pages were chosen (triage report)
Feature clusters
These clusters look incomplete. Each names a pull request this run never saw, so documenting the cluster as it stands may describe half a feature — the classic failure is a guide telling a reader to set a field that a later change gave a default. Read the absent pull request before drafting:
Draft a documentation change
kagent-dev/kagent#3550 — fix(database): retry failed PostgreSQL logins and report them as Unavailable
kagent-dev/websiteInternal "internal server error". Nothing is logged, and clients can't tell that a retry would work.go/api/gen/kagent/config/v1/config.pb.gogo/core/internal/grpcserver/interceptors.gogo/core/pkg/app/app.gogo/core/pkg/config/defaults.gogo/core/pkg/postgres/pool.gohelm/README.mdDraft branch:
pr-tracker-draft-kagent-3550