Skip to content

docs: align distributed startup requirements - #517

Merged
imbajin merged 19 commits into
apache:masterfrom
hugegraph:fix/doc-startup-lifecycle
Oct 15, 2026
Merged

imbajin merged 19 commits into
apache:masterfrom
hugegraph:fix/doc-startup-lifecycle

Conversation

@imbajin

@imbajin imbajin commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

中文说明 (Chinese Summary)

背景与目标

原文档存在混杂 1.7.0 发行版说明与 master 最新启动脚本行为的问题。本 PR 系统梳理了 分布式组件启动要求、版本兼容边界与环境配置,同时补充了服务身份标识、图空间别名和认证密钥升级的最新指引。

主要改动

  1. 启动脚本与 JDK/GC 版本分界 (hugegraph-pd.md, hugegraph-hstore.md, hugegraph-server.md):
    • JDK 版本:明确 1.7.0 的 PD/Store 脚本针对 Java 11;master 修复后的脚本正式要求 Java 17。
    • GC 选项:明确 1.7.0 脚本不支持显式指定 -g g1;master 脚本已支持显式 G1 参数(#3305)。
    • 脚本能力增强:纳入前台启动、退出状态码保留以及 HStore jemalloc 连接超时的最新指引(#3310, #3311, #3316)。
  2. 服务身份与图空间别名 (hugegraph-docker-cluster.md, hugegraph-server.md):
    • 补充 server.serviceId / HG_SERVER_SERVICE_ID 的命名约束(支持可打印 ASCII,字面保留 $)。
    • 补充 server.testGraphAlias 说明:别名必须严格匹配本地图配置的大小写(配套 Server #3322)。
  3. 认证升级与密钥修复 (hugegraph-server.md):
    • 说明签名密钥配置修复后的处理步骤,以及旧版初始化管理员密码涉及的 Unicode 字符更新注意事项(配套 Server #3327)。

边界与注意事项

  • 部分服务身份与图空间特性为未正式发版功能,需配合对应代码 PR 或镜像使用。
  • 启动脚本检查通过不代表具备完整的全链路 JDK 兼容性,升级生产环境请参考对应版本发行说明。

English Description

Summary

Disentangle 1.7.0 package instructions from current-master launcher behaviors across PD, Store, and Server startup guides, while documenting service identity, graph-space bindings, and authentication upgrade fixes.

Key Changes

  1. Launcher & Runtime Boundaries (hugegraph-pd.md, hugegraph-hstore.md, hugegraph-server.md):
    • JDK requirements: clarify that 1.7.0 PD/Store scripts target Java 11, whereas repaired master scripts require Java 17.
    • GC selection: 1.7.0 launchers reject explicit -g g1/-g G1; master launchers officially support explicit G1 (#3305).
    • Launcher enhancements: document foreground mode, preserved exit statuses, and Store jemalloc timeout settings (#3310, #3311, #3316).
  2. Service Identity & GraphSpace Settings (hugegraph-docker-cluster.md, hugegraph-server.md):
    • Clarified server.serviceId rules (printable ASCII, literal handling of $ without env expansion).
    • Documented server.testGraphAlias case-sensitive matching for local bindings (paired with Server #3322).
  3. Authentication Upgrade Fixes (hugegraph-server.md):
    • Documented signing-key re-supply procedures and admin password update caveats (paired with Server #3327).

Scope & Boundaries

  • Service identity and dynamic graph-space alias settings are unreleased features requiring matching master / PR image builds.
  • Passing launcher script validations alone does not substitute for full end-to-end JDK 17 runtime testing.

Related Implementation PRs

Verification

  • Hugo 0.165 Extended bilingual build passed
  • Markdown links & anchors validated (dist/validate-links.sh)

Implementation Overview

Deployment and upgrade guide with corresponding fix version boundaries

- 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
- describe literal dollar signs in Helm service IDs
- document reserved legacy identity environment names
- keep English and Chinese deployment guidance aligned
- document spaces and Unicode with fixed images
- require intended key resupply after prior misreading
- explain token renewal when the active key changes
- retain replica consistency and 1.7 limitations
- describe the persisted Unicode password risk
- distinguish image upgrades from credential rotation
- retain signing-key and older-image boundaries

@bitflicker64 bitflicker64 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: yes. Summary: The Docker entrypoint, partition-diagnostic, jemalloc and JDK/Maven statements match apache/hugegraph master, and the English and Chinese pages agree. Two things need changes before merge: the Server service identity section documents apache/hugegraph#3322, which is still open, and the new -g rows on the Store and PD pages describe master only while those pages install the 1.7.0 tarball, where -g g1 aborts. Evidence: read the full diff at f569d15 (8 files, +148/-22) against base 2d0b830; compared it with apache/hugegraph master 62faab73d (docker-entrypoint.sh, wait-partition.sh, start-hugegraph.sh, Store and PD launchers, Store util.sh, root pom.xml, .github/workflows/.java-version) and with tag 1.7.0; #3305, #3310, #3311, #3316 and #3327 are merged, #3322 is open; helm template of the master chart with the documented values fails schema validation; the four site build checks on this head pass (publish is skipped).

Comment thread content/en/docs/quickstart/hugegraph/hugegraph-server.md
Comment thread content/en/docs/quickstart/hugegraph/hugegraph-hstore.md Outdated
@imbajin
imbajin marked this pull request as draft October 13, 2026 08:15
- qualify proposed Server deployment settings
- explain explicit existing-graph test aliases
- distinguish released and master launcher behavior
- bound archive download examples
- preserve complete service IDs in metadata reads
- match the case of existing Gremlin bindings
- retain paired unreleased build requirements
@imbajin
imbajin marked this pull request as ready for review October 13, 2026 16:34
MrJs133
MrJs133 previously approved these changes Oct 14, 2026

@bitflicker64 bitflicker64 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: yes. Summary: The launcher, JDK, GC, jemalloc, partition-diagnostic and entrypoint statements match apache/hugegraph master and tag 1.7.0, and the earlier -g thread is fixed. The Server service identity section still documents settings from apache/hugegraph#3322, which is open, and this head removed the only pointer that said so; a Minor note covers fix boundaries that lost their PR links. Evidence: read the full diff 2d0b830..957409f (8 files, +204/-30) and the delta f569d15..957409f; checked apache/hugegraph master 4b77b7bcb (start-hugegraph-pd.sh, start-hugegraph-store.sh, Store util.sh, wait-partition.sh, docker-entrypoint.sh, root pom.xml, helm/hugegraph) and tag 1.7.0; helm template of the master chart with the documented values fails schema validation; #3305, #3310, #3311, #3316 and #3327 are merged, #3322 is open; the site build checks on this head pass (publish is skipped).

Comment thread content/en/docs/quickstart/hugegraph/hugegraph-server.md Outdated
Comment thread content/en/docs/guides/hugegraph-docker-cluster.md Outdated

@imbajin imbajin left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: no. Summary: The startup note should also say that partition polling can delay observation of Java exit before the final diagnostic. Evidence: the master entrypoint waits for the partition process before the launcher, and wait-partition.sh gives polling and diagnosis separate timeouts.

Comment thread content/en/docs/guides/hugegraph-docker-cluster.md Outdated
MrJs133
MrJs133 previously approved these changes Oct 15, 2026
@imbajin
imbajin merged commit 2bf059c into apache:master Oct 15, 2026
@imbajin
imbajin deleted the fix/doc-startup-lifecycle branch October 16, 2026 16:48
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.

3 participants