Skip to content

docs(helm): clarify test chart requirements - #530

Closed
imbajin wants to merge 13 commits into
apache:masterfrom
hugegraph:codex/helm-test-chart-compat
Closed

imbajin wants to merge 13 commits into
apache:masterfrom
hugegraph:codex/helm-test-chart-compat

Conversation

@imbajin

@imbajin imbajin commented Oct 15, 2026 •

Copy link
Copy Markdown
Member

Older Helm charts can pass helm test without proving that associated indexes are ready. The bilingual deployment and operations guides now identify the chart required for index-state checks and server.testGremlin, and the assertion example links point to a source revision that contains the section.

Documentation link checks and git diff --check pass. The source example URL was checked against GitHub. This is a prose/link correction; no local service or cluster was started.

The org review is stacked on codex/helm-easy-defaults to show only this follow-up. The ASF PR targets master, where the original guides are already merged.

Paired review: hugegraph#51

- add bilingual installation and access instructions
- document strict defaults and explicit overrides
- cover internal images, persistent storage and GitOps
- explain upgrade, credentials and startup troubleshooting
- name the HStore Server image in both inventories
- link the current topology and rollout constraints
- clarify the limits of disk loss recovery guidance
- show PD REST service credentials and Secret usage
- separate partition patrol from manual leader balance
- explain Store replacement and compression behavior
- retain simple PD credential examples
- explain shell history and process argument exposure
- link optional private credential and payload handling
- document index-state checks and their coverage limits
- explain business assertions and execution credentials
- link the full operations example
- add Helm pages to the shared navigation tree
- align per-Pod index checks with completed index jobs
- update native navigation validation expectations
- preserve upstream deployment and foundation guides
- retain Helm routes and shared navigation entries
- recalculate native navigation validation expectations
- describe the existing 150-second internal retry window
- distinguish the hook deadline from Helm command timeout
- keep private HTTP access with an optional PD port-forward path
- require completed index jobs and stable schema during checks
- explain persistent HStore cache state and recovery timing
- remove the claim that retries settle cached index work
- identify the chart needed for index readiness checks
- clarify that older test success does not verify indexes
- keep bilingual assertion examples on a valid source link
- preserve the merged ASF documentation baseline
- allow the org review to show only the compatibility fix
- retain the existing Helm documentation branch unchanged

# Conflicts:
#	content/cn/docs/quickstart/hugegraph/hugegraph-helm-operations.md
#	content/cn/docs/quickstart/hugegraph/hugegraph-helm.md
#	content/en/docs/quickstart/hugegraph/hugegraph-helm-operations.md
#	content/en/docs/quickstart/hugegraph/hugegraph-helm.md
@imbajin

imbajin commented Oct 15, 2026

Copy link
Copy Markdown
Member Author

Closing per request: Helm updates already merged into master in PR #527; any minor improvements will be folded into existing PRs without opening standalone PRs.

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