bitflicker64 opened a new pull request, #489: URL: https://github.com/apache/hugegraph-doc/pull/489
Syncs the `hugegraph-dist` surface (startup scripts, `conf/` templates, Docker images and compose topologies, IDEA run configs) with `apache/hugegraph` master at `36811483a`. Both `content/en/docs/` and `content/cn/docs/` are updated. | page | what was wrong | what changed | source (file:line on master) | |---|---|---|---| | quickstart/hugegraph/hugegraph-server.md | HStore setup told users to set `task.scheduler_type=distributed` (twice) | Removed the key from both snippets, added a note that the scheduler is picked from the backend and that the key is ignored with a warning | hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/StandardHugeGraph.java:230 | | quickstart/hugegraph/hugegraph-server.md | "Two compose files are available", `docker-compose.dev.yml` described as a single-node dev build | Table of all four files with their real services; `.dev.yml` documented as the source-build overlay for the minimal HStore topology | docker/README.md:13, docker/README.md:278, docker/docker-compose.dev.yml:18 | | quickstart/hugegraph/hugegraph-server.md | Compose auth described as "add `PASSWORD=xxx` to the compose file" | Compose reads `HUGEGRAPH_ADMIN_PASSWORD` and `HUGEGRAPH_AUTH_TOKEN_SECRET` (usually from `docker/.env`); `docker run` still uses `-e PASSWORD` | docker/docker-compose.yml:34, docker/README.md:24 | | quickstart/hugegraph/hugegraph-server.md | Preload script mounted at `/hugegraph/scripts/example.groovy` | Corrected to `/hugegraph-server/scripts/example.groovy` (image WORKDIR) | hugegraph-server/Dockerfile:47, hugegraph-server/hugegraph-dist/docker/README.md:53 | | quickstart/hugegraph/hugegraph-server.md | `curl http://localhost:8081/graphs` given as the readiness check | Corrected to `/graphspaces/DEFAULT/graphs`; there is no bare `/graphs` resource | hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/GraphsAPI.java:72 | | quickstart/hugegraph/hugegraph-server.md | Sample output read `Starting HugeGraphServer...` | Corrected to `Starting HugeGraphServer in daemon mode...` plus the `Started [pid N]` line | hugegraph-server/hugegraph-dist/src/assembly/static/bin/start-hugegraph.sh:103, bin/util.sh:381 | | quickstart/hugegraph/hugegraph-server.md | Only `-p true` was documented; no reference for the other startup flags | New 5.1.5 section with all eight `start-hugegraph.sh` options and their defaults, plus `stop-hugegraph.sh -m`; notes that `-g` accepts only ZGC | bin/start-hugegraph.sh:50, bin/hugegraph-server.sh:137, bin/stop-hugegraph.sh:20 | | quickstart/hugegraph/hugegraph-server.md | Java requirement stated as "11 or later" with no upper bound | Added that the default security check needs Java 11 to 23 (JDK 24 removed the Security Manager, use `-s false`), that the script rejects anything below 11, and that the build needs Maven 3.5.0+ | bin/hugegraph-server.sh:66, bin/hugegraph-server.sh:70, pom.xml:241 | | quickstart/hugegraph/hugegraph-server.md | Source build had no mention of the backend selection | Documented `-Drocksdb-only` and the default `rocksdb, hbase, hstore` backend set | hugegraph-server/hugegraph-dist/pom.xml:38, hugegraph-server/hugegraph-dist/pom.xml:294 | | quickstart/hugegraph/hugegraph-server.md | HStore section listed only two Server env vars; `init-store` step and `graph.load_from_local_config` were inconsistent between en and cn | Full Server env block from the HA compose file, the `hstore.properties.template` pointer, the `init_store.enabled` behaviour, and `graph.load_from_local_config=true` in the en page too | docker/docker-compose-3pd-3store-3server.yml:62, hugegraph-dist/src/main/java/org/apache/hugegraph/cmd/InitStore.java:86, ServerOptions.java:355 | | config/config-guide.md | `gremlin-server.yaml` snippet was missing `GlobalMasterInfo` and had `DateUtil` in the wrong position | Snippet now matches the shipped file line for line | hugegraph-server/hugegraph-dist/src/assembly/static/conf/gremlin-server.yaml:43 | | config/config-guide.md | `#gremlinserver.url=http://127.0.0.1:8182` did not match the template | Matches the template (`127.0.0.1:8182`), with a note that the scheme is prepended when missing | conf/rest-server.properties:6, ServerOptions.java:117 | | config/config-guide.md | `hugegraph.properties` snippet was missing `vertex.cache_type`, `edge.cache_type`, `vertex.default_label`, `serializer.buffer_max_capacity`, the HBase partition keys, the raft deprecation note and the whole memory block; carried a stale ikanalyzer download note | Snippet now matches `conf/graphs/hugegraph.properties` key by key | conf/graphs/hugegraph.properties:1 | | config/config-guide.md | Option list omitted the newly uncommented cache and task keys; RocksDB path defaults undocumented | Added `vertex.cache_type`/`edge.cache_type` (`l1`/`l2`, default `l2`), the task keys and analyzer list, and the `rocksdb-data/data` and `rocksdb-data/wal` defaults | CoreOptions.java:540, CoreOptions.java:603, hugegraph-rocksdb/.../RocksDBOptions.java:58 | | config/config-guide.md | "HugeGraphServer does not support distributed deployment"; GremlinServer default given as `localhost:8182` | Removed the stale claim, defaults corrected to `127.0.0.1:8182` | conf/gremlin-server.yaml:18, ServerOptions.java:117 | | config/config-guide.md | Multi-graph startup output showed a `/graphspaces/DEFAULT/graphs` probe URL | The script probes `$REST_SERVER_URL/graphs` and prints "in daemon mode" | bin/start-hugegraph.sh:113 | | guides/hugegraph-docker-cluster.md | "Three compose files"; `.dev.yml` described as a single-node dev build; no `.env` / auth section; HStore and Hubble topologies missing | Four-file table, image naming, a new Authentication Environment section, a Minimal HStore quickstart, and the dev overlay usage | docker/README.md:13, docker/README.md:24, docker/docker-compose-hstore.yml:1, docker/docker-compose.dev.yml:18 | | guides/hugegraph-docker-cluster.md | PD alias list omitted `PD_INITIAL_STORE_LIST` | Added, plus the mapping rule and the exit-code-2 behaviour for missing required vars | hugegraph-pd/hg-pd-dist/docker/docker-entrypoint.sh:47, :22 | | guides/hugegraph-docker-cluster.md | Server table listed 4 vars, two of them marked required | Full table of 16 Server vars with defaults and target keys, the accepted `HG_SERVER_INIT_STORE_ENABLED` spellings, the init marker, and a new Compose Variables table | hugegraph-server/hugegraph-dist/docker/docker-entrypoint.sh:90, bin/wait-storage.sh:38, bin/wait-partition.sh:22, docker/docker-compose.yml:29 | | guides/hugegraph-docker-cluster.md | Port table missed the Store raft ports and Hubble, and did not distinguish host from container ports | Added container ports, store raft ports, Hubble `8088`, and what each topology publishes | docker/docker-compose-3pd-3store-3server.yml:110, :162, :236 | | guides/hugegraph-docker-cluster.md | Health-check table used non-existent image names (`hugegraph/hugegraph-pd`, `hugegraph/hugegraph-store`, `hugegraph/hugegraph-hstore`) | Corrected to `hugegraph/pd`, `hugegraph/store`, `hugegraph/server`, plus a note that Compose defines its own checks | docker/README.md:263, docker/docker-compose-hstore.yml:30 | | guides/hugegraph-docker-cluster.md | "use `docker logs`" applied uniformly to all images | Noted that only the standalone image sets `STDOUT_MODE=true`, so HStore Server logs live in `logs/hugegraph-server.log`; added the `down` vs `down -v` data note | hugegraph-server/Dockerfile:45, hugegraph-server/Dockerfile-hstore:46, docker/README.md:256 | | clients/gremlin-console.md | `:> hugegraph.traversal().V()` and `graph = hugegraph;` cannot resolve, the Server binds graphs under a graphspace-qualified name | Documented the `DEFAULT-hugegraph` / `__g_DEFAULT-hugegraph` bindings and replaced the examples with the aliased driver flow | hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/auth/ContextGremlinServer.java:49, :134, HugeFactory.java:85, hugegraph-dist/src/assembly/travis/run-gremlin-console-smoke-test.sh:62 | | clients/gremlin-console.md | No mention of connecting to an auth-enabled Server, or of the sibling driver config files | Added the `username`/`password` keys and a pointer to `remote-objects.yaml` and `gremlin-driver-settings.yaml` | run-gremlin-console-smoke-test.sh:55, conf/remote-objects.yaml:17, conf/gremlin-driver-settings.yaml:17 | | contribution-guidelines/hugegraph-server-idea-setup.md | Copy command and Log4j2 path used `hugegraph-dist/...`, which does not exist at the repo root | Corrected to `hugegraph-server/hugegraph-dist/...` | hugegraph-server/hugegraph-dist/src/assembly/static/conf, hugegraph-server/hugegraph-dist/src/main/resources/log4j2.xml | | contribution-guidelines/hugegraph-server-idea-setup.md | `preload-topling.sh` and the ToplingDB env vars were presented as ordinary steps, but nothing ToplingDB-related exists in the repo | Marked as applying only to a build that includes ToplingDB | no `topling` match anywhere under `apache/hugegraph` master | | contribution-guidelines/hugegraph-server-idea-setup.md | Line-anchored links to `init-store.sh#L52` and `hugegraph-server.sh#L124` pointed at the wrong lines; the relationship to the shipped entry point was unexplained | Anchors moved to `#L49` and `#L132`, and added that the script actually launches `HugeGraphServerBootstrap` around `HugeGraphServer` | bin/init-store.sh:49, bin/hugegraph-server.sh:132, bin/hugegraph-server.sh:263 | -- 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]
