[guide] docs: env-vars.md — add 7 missing operator-facing variables (workspace cleanup, advisory thresholds, hub public-origin chain) - #5740
Conversation
Adds rows for HIVE_WORKSPACE_CLEANUP_INTERVAL and HIVE_WORKSPACE_CLEANUP_MAX_AGE (workspace_cleanup.go tuning knobs), HIVE_ADVISORY_ISSUE_AGING_AFTER and HIVE_ADVISORY_ISSUE_STALE_AFTER (advisory issue-activity thresholds, incl. the stale<=aging revert guard), and HIVE_HUB_PUBLIC_URL / HIVE_PUBLIC_URL / HIVE_HUB_BASE_URL (hub public-origin chain), and notes the chain role of the already documented HIVE_DASHBOARD_URL and HIVE_HUB_URL. Refs #5739 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: hive-guide <sec-check@hive.kubestellar.io>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
clubanderson
left a comment
There was a problem hiding this comment.
Reviewed env-var docs against the code paths that read each variable. Defaults/precedence match workspace_cleanup.go, advisory_issue_activity.go, access_notify.go/url_reachability.go, main.go, and the TUI client constants. Documentation-only change; go build ./... passes.
|
LGTM label has been added. DetailsGit tree hash: c6212e99d95a816fec6a38999cdb779680a268f1 |
|
Thank you for your contribution! Your PR has been merged. Check out what's new:
Stay connected: Slack #kubestellar-dev | Multi-Cluster Survey |
Documentation Fix
Adds the 7 undocumented operator-facing environment variables from #5739 to
src/docs/env-vars.md, in the sections matching the components that read them:Core runtime (
src/pkg/dashboard/workspace_cleanup.go):HIVE_WORKSPACE_CLEANUP_INTERVAL(default1h) andHIVE_WORKSPACE_CLEANUP_MAX_AGE(default2h) — Go durations; unset/unparseable/non-positive fall back to defaults.Hub, SaaS, alerts, and backups:
HIVE_ADVISORY_ISSUE_AGING_AFTER(default24h) andHIVE_ADVISORY_ISSUE_STALE_AFTER(default72h) fromsrc/pkg/hub/advisory_issue_activity.go, including the guard where stale ≤ aging silently reverts both to defaults.HIVE_HUB_PUBLIC_URL,HIVE_PUBLIC_URL,HIVE_HUB_BASE_URL— the hub public-origin chain (src/pkg/hub/access_notify.go:29,src/pkg/hub/url_reachability.go:219) with its full 5-variable precedence order, plus chain-role notes on the existingHIVE_DASHBOARD_URLandHIVE_HUB_URLrows.Verified:
go test ./pkg/config/ -run TestEnvVarsDocDocumentsOnlyRealVariablespasses (every added row names a variable the code reads).Scope claimed:
src/docs/env-vars.mdonly. Disjoint from open PRs #5737 (tests), #5717 (CI script), #5697 (pkg/hub wrapkey code), #5642 (ADOPTERS.md), #5635 (docs/rfc-4002), #5559 (UPGRADE.md), #4032 (proxy).Fixes #5739
Filed by guide agent (ACMM L5 — hold-gated mode). Hold-gated: human review required.
— hive: agent=guide backend=copilot model=claude-sonnet-4-6