Skip to content

docs: align distributed startup requirements - #517

Open
imbajin wants to merge 9 commits into
apache:masterfrom
hugegraph:fix/doc-startup-lifecycle
Open

imbajin wants to merge 9 commits into
apache:masterfrom
hugegraph:fix/doc-startup-lifecycle

Conversation

@imbajin

@imbajin imbajin commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

The website described Server exit monitoring with tail --pid, reduced crash/signal exit statuses, and rejected explicit Store G1. The English and Chinese guides now match the foreground launcher, preserved exit statuses, interruptible startup deadlines, optional jemalloc download timeout and separate polling/final-diagnostic budgets. Earlier builds without the final-diagnostic repair remain explicitly qualified.

Align HStore and PD build/runtime instructions with the current JDK 17 build and CI environment, Maven 3.6.3 minimum, and the launcher minimum-version check. Passing that launcher check alone does not establish support for a newer JDK.

The paired code repairs #3310, #3311, and #3316 are merged; explicit G1 support is in #3305.

Validation: link checks, diff checks, strict cached Hugo build, bilingual rendered-page checks and independent document reviews passed. New-head CI is pending. Source: the original org #42 branch, synchronized with current documentation master.

Service identity and graph-space deployment settings also pair with Server org #297; its upstream counterpart is ASF #3322. The new website guidance covers defaults, aliases, supported names and authentication scope. The chart and Server image must be matching versions that both include this support; copying new values into an older chart or image does not enable it. Coordinate code and documentation merges.

- describe bounded jemalloc downloads and fallback
- preserve Server exit statuses and shutdown deadlines
- align Store GC and Java/Maven prerequisites
- explain independent polling and diagnostic budgets
- describe disabled limits and delayed exit observation
- align Chinese and English deployment guidance
- scope the timeout guarantee to patched builds
- document unbounded requests in earlier builds
- align the Chinese and English deployment guides
- merge current documentation master
- document JDK 17 build and tested runtime
- align PD Maven requirements with the build
@imbajin imbajin changed the title docs: align startup lifecycle guidance docs: align distributed startup requirements Oct 12, 2026
- document Server environment and Helm identity inputs
- explain defaults, aliases and supported name formats
- clarify graphspace creation and authentication scope
- require Java 17 in the PD startup instructions
- list G1 and ZGC launcher selections
- preserve caller or JVM selection when GC is omitted
- apply graphspace naming rules to environment inputs
- clarify validation of the effective legacy fallback
- retain the existing DEFAULT and mounted config contract
- require matching chart and Server image versions
- identify the shared service identity capability
- exclude unsupported earlier deployment examples
- point both Server quickstarts to the ASF repair
- retain the matching chart and image requirement
- connect the website update with its upstream PR

This branch has not been deployed

No deployments
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