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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
