Repository navigation
docs: explain easy Helm deployments - #527
Conversation
- 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
bitflicker64
left a comment
bitflicker64
left a comment
There was a problem hiding this comment.
Blocking: yes. Summary: The EN and CN Helm pages match the chart merged in apache/hugegraph#3338, but the new pages have no data/version_routes.json entries, so the site build fails on this head and merging would break the master deploy. They are also missing from data/docs_nav.json. Evidence: CI run 38523883968 on this head (details inline); the merge-base run 38282058093 on 1b57c23 passed. I checked the page text against apache/hugegraph master 4b77b7bc: values.yaml, the cluster and strict presets, the credential patterns in values.schema.json, the storage, registry, wait-image and startup-budget logic in _helpers.tpl, the Service and PVC templates, the Helm test hook, the docs/operations.md anchors, Server UserAPI and PD TaskAPI. EN and CN match, and git diff --check is clean.
- document index-state checks and their coverage limits - explain business assertions and execution credentials - link the full operations example
bitflicker64
left a comment
bitflicker64
left a comment
There was a problem hiding this comment.
Blocking: yes. Summary: Score 7/10. The EN and CN Helm pages match the chart merged to apache/hugegraph master through #3338, and the route-map build failure from the earlier review is fixed at this head. One blocking problem: the "Helm test coverage" subsection on both operations pages documents server.testGremlin, the per-Pod INVALID index check and a #business-query-assertions anchor. All three exist only in the still-open apache/hugegraph#3349, so on current master the documented command fails schema validation and the link anchor does not resolve. Evidence: rendered master 4b77b7bc with helm template hugegraph helm/hugegraph -n hugegraph --set-file server.testGremlin=a.groovy, which fails with at '/server': additional properties 'testGremlin' not allowed; the same command on the #3349 head 392faa94 renders. Headings in master helm/hugegraph/docs/operations.md have no "Business query assertions" section, and master templates/tests/test-connection.yaml runs only the Gremlin binding check, with no index status check. Also checked against master: default render (3 PD/3 Store/3 Server/1 Hubble, 10Gi/50Gi/1Gi claims, NodePort Server/Hubble, ClusterIP PD client, ports, Secret names and keys, startup probe threshold 91x5s = 300+150), values-strict.yaml (ClusterIP plus 4 NetworkPolicies), values-cluster.yaml (required anti-affinity, Store OnDelete), Service field passthrough, credential patterns, the NetworkPolicy example, and the other four operations.md anchors. EN and CN agree. Latest-head checks pass. The missing data/docs_nav.json entries were already raised in the existing inline thread and are not repeated here.
- 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
Merge order: merge apache/hugegraph#3349 first, then this documentation PR. The new Helm test assertions require that chart change.
Purpose
Add bilingual Helm installation and operations pages for the chart's easy defaults. Installation, browser/API access and common internal-cluster settings come first; credentials, storage, upgrade and recovery details are kept on a separate operations page.
Paired chart changes: apache/hugegraph#3338. Merge the chart and website updates together.
Validation
Internal links, source tests, the strict Hugo build and search-ranking checks pass. Browser tests consume intercepted static artifacts without a local web server. No HugeGraph service was started.
Organization review copy: hugegraph#50.
The Helm test coverage and business-assertion examples are also paired with apache/hugegraph#3349; coordinate that source change before merging these instructions.