You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hugegraph.apache.org by "imbajin (via GitHub)" <gi...@apache.org> on 2026/10/11 23:03:40 UTC
[PR] docs: align startup lifecycle guidance [hugegraph-doc]
imbajin opened a new pull request, #517:
URL: https://github.com/apache/hugegraph-doc/pull/517
The website still describes Server exit monitoring with `tail --pid`, maps crashes to 1 and signals to 0, and rejects explicit Store G1. Align the English and Chinese guides with the foreground launcher, preserved exit statuses, interruptible deadlines, bounded optional jemalloc download, and current Java/Maven requirements.
Paired code PRs: [ASF #3310](https://github.com/apache/hugegraph/pull/3310) and [ASF #3311](https://github.com/apache/hugegraph/pull/3311). The G1 contract is already merged in [ASF #3305](https://github.com/apache/hugegraph/pull/3305). Coordinate this documentation merge with both pending code PRs.
Validation: unchanged link validator and diff checks passed; a fresh latest site built with cached Hugo 0.165 Extended, Python 3.13 and WebP tools. Generated English and Chinese pages were checked against the changed facts. Independent documentation review and re-review passed.
Source org PR: [#42](https://github.com/hugegraph/hugegraph-doc/pull/42). This uses the same source branch and commit after the current-head org site checks pass.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] docs: align distributed startup requirements [hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #517:
URL: https://github.com/apache/hugegraph-doc/pull/517#discussion_r4286185240
##########
content/en/docs/quickstart/hugegraph/hugegraph-server.md:
##########
@@ -123,6 +123,59 @@ The standalone `docker-compose.yml` example uses `hugegraph/hugegraph:1.7.0`; it
See [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md) for the full setup guide.
+#### Server service identity with PD
+
+For a PD-backed Server, the Helm chart exposes `server.serviceId` and `server.graphSpace`.
+Both default to `DEFAULT`, which preserves the existing `server.service_id` and `server.graphspace`
+values in `conf/rest-server.properties`. A non-default chart value injects `HG_SERVER_SERVICE_ID`
+or `HG_SERVER_GRAPHSPACE` into the Server container. Use a Helm chart and Server image from the same
+version supporting service identity.
Review Comment:
Updated the service identity section in both EN and CN to clearly state that `server.serviceId`, `server.graphSpace`, and `server.testGraphAlias` require Helm chart and Server image support introduced in apache/hugegraph#3322, and that no released chart or image currently supports these settings.
##########
content/en/docs/guides/hugegraph-docker-cluster.md:
##########
@@ -221,12 +221,28 @@ Unlike PD and Store, Server has no mandatory entrypoint variables: only set valu
| `HG_SERVER_PD_REST_ENDPOINT` | Derived from `pd.peers` by replacing `:8686` with `:8620` | PD REST address polled by `wait-storage.sh` |
| `PD_AUTH_USER` | `store` | Basic username for PD REST calls from `wait-storage.sh` |
| `PD_AUTH_PASSWORD` | Empty | PD REST Basic password; must match `HG_PD_AUTH_SECRET_KEY` when PD REST authentication is enabled |
-| `WAIT_PARTITION_TIMEOUT_S` | `120` | Partition allocation wait time in `wait-partition.sh` |
+| `WAIT_PARTITION_TIMEOUT_S` | `120` | Partition polling timeout; also bounds the final diagnostic in builds with the fix described below |
+
+Images containing the authentication property fixes preserve spaces, backslashes and Unicode in explicit
Review Comment:
Explicitly named the exact boundaries across docker-cluster, Store, and PD pages in both languages (apache/hugegraph#3327, #3316, #3305, and #3310).
##########
content/en/docs/guides/hugegraph-docker-cluster.md:
##########
@@ -221,12 +221,28 @@ Unlike PD and Store, Server has no mandatory entrypoint variables: only set valu
| `HG_SERVER_PD_REST_ENDPOINT` | Derived from `pd.peers` by replacing `:8686` with `:8620` | PD REST address polled by `wait-storage.sh` |
| `PD_AUTH_USER` | `store` | Basic username for PD REST calls from `wait-storage.sh` |
| `PD_AUTH_PASSWORD` | Empty | PD REST Basic password; must match `HG_PD_AUTH_SECRET_KEY` when PD REST authentication is enabled |
-| `WAIT_PARTITION_TIMEOUT_S` | `120` | Partition allocation wait time in `wait-partition.sh` |
+| `WAIT_PARTITION_TIMEOUT_S` | `120` | Partition polling timeout; also bounds the final diagnostic in builds with the fix described below |
+
+Images containing the authentication property fixes preserve spaces, backslashes and Unicode in explicit
+signing keys. Use the same key on every Server replica. When upgrading from an image that misread such a key, explicitly supply the intended
+`HG_SERVER_AUTH_TOKEN_SECRET` again; retaining the old configuration also retains its misread key. If the active key changes, sign in again to
+obtain new tokens. The 1.7.0 image limitation above still applies.
+
+Older images could initialize a Unicode administrator password incorrectly when the initializer inherited the C locale. Upgrading or setting
+`PASSWORD` again does not repair an existing account's stored password. A working administrator must change it through the
+[user API](/docs/clients/restful-api/auth/). This fix provides no automatic recovery when no administrator identity is usable; preserve the
+existing data and arrange account recovery before upgrading.
> **Deprecated aliases**: `BACKEND` → `HG_SERVER_BACKEND`, `PD_PEERS` → `HG_SERVER_PD_PEERS`.
`wait-storage.sh` waits up to 300 seconds for an `Up` Store. This duration is hardcoded and cannot be changed through environment variables.
+In repaired Server builds, HStore startup gives partition polling
+and the final `/v1/partitions` diagnostic separate `WAIT_PARTITION_TIMEOUT_S` budgets. Earlier builds bound polling only; the final diagnostic
+request has no timeout. With the default value, a stalled final response times out after 120 seconds; setting the value to `0` disables
+GNU timeout's limit. JVM exit observation may wait until that diagnostic completes or reaches its timeout; signal-triggered shutdown remains
Review Comment:
Documented in both EN and CN that the entrypoint waits for `wait-partition.sh` before waiting for the Java launcher: if Java exits while partition polling is running, the poll can consume its full timeout before the exit is observed; if polling succeeds, the diagnostic step can consume a second full timeout.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] docs: align distributed startup requirements [hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin merged PR #517:
URL: https://github.com/apache/hugegraph-doc/pull/517
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] docs: align distributed startup requirements [hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #517:
URL: https://github.com/apache/hugegraph-doc/pull/517#discussion_r4256295709
##########
content/en/docs/quickstart/hugegraph/hugegraph-hstore.md:
##########
@@ -291,7 +292,7 @@ The script accepts four flags:
| Flag | Values | Default | Description |
|------|--------|---------|-------------|
| `-d` | `true`, `false` | `true` | Daemon mode. See below. |
-| `-g` | `ZGC`, `zgc` | not set | Garbage collector. Omit the flag for G1, which is the default. Any value other than `ZGC` or `zgc` aborts the start, including `g1`, even though the script's own usage line suggests it. |
+| `-g` | `g1`, `G1`, `zgc`, `ZGC` | not set | Unset preserves caller/JVM GC; supplied values select G1 or ZGC (Java 17+). |
Review Comment:
Fixed in the current published head. The EN/ZH Store and PD pages now distinguish current master from the 1.7.0 package: explicit `zgc`/`ZGC` only on 1.7.0, with `-g g1`/`-g G1` rejected; each 1.7.0 launcher declares Java 11 while the current master launcher requires Java 17. The Store's 5s connection/30s total jemalloc budget is scoped to repaired master builds, and the 1.7.0 helper's absence of those deadlines is stated. The unchanged release archive example uses a separate bounded curl download.
I read the PD/Store startup scripts and Store helper directly from the existing verified official 1.7.0 archive; their bytes match the official tag. Repository link checks, the strict Hugo build, bilingual rendered-page readbacks and an independent review passed. This is source/documentation verification; no launcher or JDK compatibility runtime test is claimed. Organization and ASF expose the same reviewed documentation source.
##########
content/en/docs/quickstart/hugegraph/hugegraph-server.md:
##########
@@ -123,6 +123,48 @@ The standalone `docker-compose.yml` example uses `hugegraph/hugegraph:1.7.0`; it
See [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md) for the full setup guide.
+#### Server service identity with PD
+
+For a PD-backed Server, the Helm chart exposes `server.serviceId` and `server.graphSpace`.
+Both default to `DEFAULT`, which preserves the existing `server.service_id` and `server.graphspace`
+values in `conf/rest-server.properties`. A non-default chart value injects `HG_SERVER_SERVICE_ID`
+or `HG_SERVER_GRAPHSPACE` into the Server container. Use a Helm chart and Server image from the same
+version, both including the service identity support in [Server PR #3322](https://github.com/apache/hugegraph/pull/3322).
+Copying these values into an older chart or image does not add that support; do not use this example
+with 1.7.0 or any chart/image version without these changes.
+Non-empty service IDs supplied through `HG_SERVER_SERVICE_ID`, `SERVICE_ID`, or `server.serviceId`
+must use printable ASCII; spaces and backslashes are supported, while deployment checks reject
+non-ASCII and control characters. This entrypoint restriction does not change Core Service naming
+or existing manually supplied properties. Helm preserves dollar signs in `server.serviceId` literally,
+including `$(POD_IP)`; this field does not expand Kubernetes environment references.
+Set the identity through these chart values; Server `extraEnv` reserves both the new and legacy identity variable names.
+`HG_SERVER_GRAPHSPACE`, the effective `GRAPH_SPACE` fallback,
+and `server.graphSpace` accept `DEFAULT` or an existing space name of up to 48 lowercase letters, digits,
+and underscores, starting with a letter:
+
+```bash
+helm upgrade --install hg ./helm/hugegraph \
+ --set-string server.serviceId=analytics \
Review Comment:
The current head now labels these deployment settings as proposed and unreleased, links the actual paired Server #3322 proposal instead of a master README that lacks the feature, and requires matching PR chart/image builds. It also states the coordinated merge and merged-code recheck requirement. The default hook alias and the need to create the target graph separately from its graph space are explicit; a successful DEFAULT binding check does not establish non-default discovery.
The matching Server follow-up is now publicly available on org #297 / ASF #3322, but #3322 remains OPEN, not merged. ASF Doc #517 has been converted to draft and the draft state was read back. I am leaving this thread open until Server #3322 merges and this guidance is rechecked against the merged code, as requested. Full non-default PD discovery, authentication and isolation acceptance also remain open. Both language pages passed the strict Hugo/link/render checks and independent documentation review.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] docs: align distributed startup requirements [hugegraph-doc]
Posted by "bitflicker64 (via GitHub)" <gi...@apache.org>.
bitflicker64 commented on code in PR #517:
URL: https://github.com/apache/hugegraph-doc/pull/517#discussion_r4275523781
##########
content/en/docs/quickstart/hugegraph/hugegraph-server.md:
##########
@@ -123,6 +123,59 @@ The standalone `docker-compose.yml` example uses `hugegraph/hugegraph:1.7.0`; it
See [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md) for the full setup guide.
+#### Server service identity with PD
+
+For a PD-backed Server, the Helm chart exposes `server.serviceId` and `server.graphSpace`.
+Both default to `DEFAULT`, which preserves the existing `server.service_id` and `server.graphspace`
+values in `conf/rest-server.properties`. A non-default chart value injects `HG_SERVER_SERVICE_ID`
+or `HG_SERVER_GRAPHSPACE` into the Server container. Use a Helm chart and Server image from the same
+version supporting service identity.
Review Comment:
Important: The open thread on line 148 asked for this section to wait for apache/hugegraph#3322, which is still open. This head did not do that: it removed the #3322 link, and line 132 now asks for a chart and image "from the same version supporting service identity". No published chart or image has that support, so the page now presents these settings as available and gives no way to find a build that has them.
Evidence beyond that thread: `server.testGraphAlias` (lines 157 and 170, added since that review) is also #3322-only (`values.yaml` line 341 at 411835f4); on master 4b77b7bcb the hook hard-codes `DEFAULT-hugegraph` (`helm/hugegraph/templates/tests/test-connection.yaml` line 81), and the master chart rejects all three keys:
```
$ helm template hg ./helm/hugegraph --set-string server.serviceId=analytics \
--set-string server.graphSpace=team_a --set-string server.testGraphAlias=team_a-demo
- at '/server': additional properties 'graphSpace', 'serviceId', 'testGraphAlias' not allowed
```
Line 163 now ends with "See the Helm chart documentation for details" with no link; the master chart README has no such section. CN lines 131, 150, 156 and 161 match.
Requested change: keep this section (EN 126-177, CN 126-166) out of this PR until #3322 merges, then re-check it against the merged chart and link the README section. If it must land first, state that no released chart or image supports these settings yet.
##########
content/en/docs/guides/hugegraph-docker-cluster.md:
##########
@@ -221,12 +221,28 @@ Unlike PD and Store, Server has no mandatory entrypoint variables: only set valu
| `HG_SERVER_PD_REST_ENDPOINT` | Derived from `pd.peers` by replacing `:8686` with `:8620` | PD REST address polled by `wait-storage.sh` |
| `PD_AUTH_USER` | `store` | Basic username for PD REST calls from `wait-storage.sh` |
| `PD_AUTH_PASSWORD` | Empty | PD REST Basic password; must match `HG_PD_AUTH_SECRET_KEY` when PD REST authentication is enabled |
-| `WAIT_PARTITION_TIMEOUT_S` | `120` | Partition allocation wait time in `wait-partition.sh` |
+| `WAIT_PARTITION_TIMEOUT_S` | `120` | Partition polling timeout; also bounds the final diagnostic in builds with the fix described below |
+
+Images containing the authentication property fixes preserve spaces, backslashes and Unicode in explicit
Review Comment:
Minor: This head replaced the links to merged apache/hugegraph#3327 and #3316 with "images containing the authentication property fixes" (here) and "repaired Server builds" (line 240); line 224 points at line 240, so it lost its boundary too. Line 170 scopes these tables to current master, but an image built from master before #3316 (merge 6aa362a3, 2026-10-12) or #3327 (merge 7a84cde0, 2026-10-13) lacks this behaviour, and the reader can no longer tell which builds have it. The same happened to the #3305 and #3310 links on the Store page (lines 301 and 314) and the PD page (line 322).
Requested change: name the boundary, for example "master builds that include apache/hugegraph#3327", or the first release that ships the fix once known. CN docker-cluster lines 226 and 237, Store lines 300 and 313, and PD line 320 need the same change.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] docs: align distributed startup requirements [hugegraph-doc]
Posted by "bitflicker64 (via GitHub)" <gi...@apache.org>.
bitflicker64 commented on code in PR #517:
URL: https://github.com/apache/hugegraph-doc/pull/517#discussion_r4255561022
##########
content/en/docs/quickstart/hugegraph/hugegraph-server.md:
##########
@@ -123,6 +123,48 @@ The standalone `docker-compose.yml` example uses `hugegraph/hugegraph:1.7.0`; it
See [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md) for the full setup guide.
+#### Server service identity with PD
+
+For a PD-backed Server, the Helm chart exposes `server.serviceId` and `server.graphSpace`.
+Both default to `DEFAULT`, which preserves the existing `server.service_id` and `server.graphspace`
+values in `conf/rest-server.properties`. A non-default chart value injects `HG_SERVER_SERVICE_ID`
+or `HG_SERVER_GRAPHSPACE` into the Server container. Use a Helm chart and Server image from the same
+version, both including the service identity support in [Server PR #3322](https://github.com/apache/hugegraph/pull/3322).
+Copying these values into an older chart or image does not add that support; do not use this example
+with 1.7.0 or any chart/image version without these changes.
+Non-empty service IDs supplied through `HG_SERVER_SERVICE_ID`, `SERVICE_ID`, or `server.serviceId`
+must use printable ASCII; spaces and backslashes are supported, while deployment checks reject
+non-ASCII and control characters. This entrypoint restriction does not change Core Service naming
+or existing manually supplied properties. Helm preserves dollar signs in `server.serviceId` literally,
+including `$(POD_IP)`; this field does not expand Kubernetes environment references.
+Set the identity through these chart values; Server `extraEnv` reserves both the new and legacy identity variable names.
+`HG_SERVER_GRAPHSPACE`, the effective `GRAPH_SPACE` fallback,
+and `server.graphSpace` accept `DEFAULT` or an existing space name of up to 48 lowercase letters, digits,
+and underscores, starting with a letter:
+
+```bash
+helm upgrade --install hg ./helm/hugegraph \
+ --set-string server.serviceId=analytics \
Review Comment:
Important: this section documents `server.serviceId`, `server.graphSpace`, `HG_SERVER_SERVICE_ID` and `HG_SERVER_GRAPHSPACE`, which exist only in apache/hugegraph#3322. That PR is still open (head bf33ef6e, review required), so no apache/hugegraph chart or image accepts these settings today.
Evidence: on apache/hugegraph master 62faab73d, `git grep -E "HG_SERVER_SERVICE_ID|HG_SERVER_GRAPHSPACE|serviceId|graphSpace"` over `helm/` and `hugegraph-server/hugegraph-dist/docker/` returns nothing, and the master chart rejects the command shown here:
```
$ helm template hg ./helm/hugegraph --set-string server.serviceId=analytics --set-string server.graphSpace=team_a
Error: values don't meet the specifications of the schema(s) in the following chart(s):
hugegraph:
- at '/server': additional properties 'graphSpace', 'serviceId' not allowed
```
Lines 131-134 do say to use a chart and image that include #3322, but no such build exists yet, the "Helm chart guide" link on line 159 points at a master README with no service identity section, and the rules written here match #3322 at bf33ef6e, which can still change in review.
Requested change: merge this section only after #3322 is merged, then re-check it against the merged code. If the rest of this PR should go in first, move the section (lines 126-166 here, lines 126-156 of the Chinese page) to a follow-up PR.
##########
content/en/docs/quickstart/hugegraph/hugegraph-hstore.md:
##########
@@ -291,7 +292,7 @@ The script accepts four flags:
| Flag | Values | Default | Description |
|------|--------|---------|-------------|
| `-d` | `true`, `false` | `true` | Daemon mode. See below. |
-| `-g` | `ZGC`, `zgc` | not set | Garbage collector. Omit the flag for G1, which is the default. Any value other than `ZGC` or `zgc` aborts the start, including `g1`, even though the script's own usage line suggests it. |
+| `-g` | `g1`, `G1`, `zgc`, `ZGC` | not set | Unset preserves caller/JVM GC; supplied values select G1 or ZGC (Java 17+). |
Review Comment:
Important: the `-g` row now describes the master launcher only, but section 3.1 of this page installs the 1.7.0 tarball, where `-g g1` aborts the start. The replaced text was correct for that release.
Evidence: at tag `1.7.0`, `start-hugegraph-store.sh` has `case "$GC_OPTION"` with only `""` and `zgc|ZGC` branches; any other value logs "Unrecognized gc option ..." and runs `exit 1`. `start-hugegraph-pd.sh` at `1.7.0` is the same. The `g1|G1` branch exists only on master (62faab73d, from apache/hugegraph#3305). A reader who follows 3.1 and runs `./bin/start-hugegraph-store.sh -g g1` gets a Store that exits 1, with the reason only in `logs/hugegraph-store-server.log`.
Same row on the PD page (`hugegraph-pd.md` line 316) and on the Chinese pages (`hugegraph-hstore.md` line 294, `hugegraph-pd.md` line 314).
Two smaller cases of the same gap, neither of which breaks a 1.7.0 start:
- the launcher sentence on line 26 here and line 29 of `hugegraph-pd.md` gives a minimum of 17 with no version; at `1.7.0` it is `EXPECT_JDK_VERSION=11`;
- line 308 here: the 5 second and 30 second limits come from apache/hugegraph#3310; `util.sh` at `1.7.0` runs `curl -L -o $filepath $url` with no timeout.
Requested change: scope the `-g` rows to master builds and keep the 1.7.0 behaviour beside them, for example "master: `g1`, `G1`, `zgc`, `ZGC`; 1.7.0: `zgc`, `ZGC` only, any other value including `g1` aborts". Add "master" to the launcher JDK sentence and the jemalloc paragraph.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] docs: align distributed startup requirements [hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #517:
URL: https://github.com/apache/hugegraph-doc/pull/517#discussion_r4263545513
##########
content/en/docs/quickstart/hugegraph/hugegraph-server.md:
##########
@@ -123,6 +123,48 @@ The standalone `docker-compose.yml` example uses `hugegraph/hugegraph:1.7.0`; it
See [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md) for the full setup guide.
+#### Server service identity with PD
+
+For a PD-backed Server, the Helm chart exposes `server.serviceId` and `server.graphSpace`.
+Both default to `DEFAULT`, which preserves the existing `server.service_id` and `server.graphspace`
+values in `conf/rest-server.properties`. A non-default chart value injects `HG_SERVER_SERVICE_ID`
+or `HG_SERVER_GRAPHSPACE` into the Server container. Use a Helm chart and Server image from the same
+version, both including the service identity support in [Server PR #3322](https://github.com/apache/hugegraph/pull/3322).
+Copying these values into an older chart or image does not add that support; do not use this example
+with 1.7.0 or any chart/image version without these changes.
+Non-empty service IDs supplied through `HG_SERVER_SERVICE_ID`, `SERVICE_ID`, or `server.serviceId`
+must use printable ASCII; spaces and backslashes are supported, while deployment checks reject
+non-ASCII and control characters. This entrypoint restriction does not change Core Service naming
+or existing manually supplied properties. Helm preserves dollar signs in `server.serviceId` literally,
+including `$(POD_IP)`; this field does not expand Kubernetes environment references.
+Set the identity through these chart values; Server `extraEnv` reserves both the new and legacy identity variable names.
+`HG_SERVER_GRAPHSPACE`, the effective `GRAPH_SPACE` fallback,
+and `server.graphSpace` accept `DEFAULT` or an existing space name of up to 48 lowercase letters, digits,
+and underscores, starting with a letter:
+
+```bash
+helm upgrade --install hg ./helm/hugegraph \
+ --set-string server.serviceId=analytics \
Review Comment:
Addressed in 957409ff8: cleaned all unreleased PR references to #3322 and other PRs from documentation prose across Chinese and English guides, stating the service identity capability generically.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] docs: align distributed startup requirements [hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #517:
URL: https://github.com/apache/hugegraph-doc/pull/517#discussion_r4276294459
##########
content/en/docs/guides/hugegraph-docker-cluster.md:
##########
@@ -221,12 +221,28 @@ Unlike PD and Store, Server has no mandatory entrypoint variables: only set valu
| `HG_SERVER_PD_REST_ENDPOINT` | Derived from `pd.peers` by replacing `:8686` with `:8620` | PD REST address polled by `wait-storage.sh` |
| `PD_AUTH_USER` | `store` | Basic username for PD REST calls from `wait-storage.sh` |
| `PD_AUTH_PASSWORD` | Empty | PD REST Basic password; must match `HG_PD_AUTH_SECRET_KEY` when PD REST authentication is enabled |
-| `WAIT_PARTITION_TIMEOUT_S` | `120` | Partition allocation wait time in `wait-partition.sh` |
+| `WAIT_PARTITION_TIMEOUT_S` | `120` | Partition polling timeout; also bounds the final diagnostic in builds with the fix described below |
+
+Images containing the authentication property fixes preserve spaces, backslashes and Unicode in explicit
+signing keys. Use the same key on every Server replica. When upgrading from an image that misread such a key, explicitly supply the intended
+`HG_SERVER_AUTH_TOKEN_SECRET` again; retaining the old configuration also retains its misread key. If the active key changes, sign in again to
+obtain new tokens. The 1.7.0 image limitation above still applies.
+
+Older images could initialize a Unicode administrator password incorrectly when the initializer inherited the C locale. Upgrading or setting
+`PASSWORD` again does not repair an existing account's stored password. A working administrator must change it through the
+[user API](/docs/clients/restful-api/auth/). This fix provides no automatic recovery when no administrator identity is usable; preserve the
+existing data and arrange account recovery before upgrading.
> **Deprecated aliases**: `BACKEND` → `HG_SERVER_BACKEND`, `PD_PEERS` → `HG_SERVER_PD_PEERS`.
`wait-storage.sh` waits up to 300 seconds for an `Up` Store. This duration is hardcoded and cannot be changed through environment variables.
+In repaired Server builds, HStore startup gives partition polling
+and the final `/v1/partitions` diagnostic separate `WAIT_PARTITION_TIMEOUT_S` budgets. Earlier builds bound polling only; the final diagnostic
+request has no timeout. With the default value, a stalled final response times out after 120 seconds; setting the value to `0` disables
+GNU timeout's limit. JVM exit observation may wait until that diagnostic completes or reaches its timeout; signal-triggered shutdown remains
Review Comment:
⚠️ Important. Blocking: no. Summary: This mentions only the final diagnostic, but the entrypoint waits for `wait-partition.sh` before waiting for the Java launcher. If Java exits while partition polling is still waiting, that poll can consume its timeout first; if polling succeeds, the diagnostic can then use a second full timeout. Please document both possible delays. Evidence: master `docker-entrypoint.sh:341-347` waits for the partition process before the launcher; `wait-partition.sh:37-49,55-59` applies separate polling and diagnostic timeouts.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org