doc(server): sync store with master - #479
Open
bitflicker64 wants to merge 1 commit into
Open
Conversation
Rewrote the HugeGraph-Store quickstart to match hugegraph master: the application.yml block now mirrors the shipped template, application-pd.yml and its rocksdb keys are documented, and a full configuration reference lists every key the node reads with its template value and code default. Also documented the -g/-j/-y start flags, the restart script, the PD to Store to Server startup order and the pd.initial-store-list requirement, the Store REST endpoints that actually exist in hg-store-node, the minimal docker-compose-hstore.yml topology, and the image defaults. Fixed the wrong Chinese tar directory name. The PD /v1/stores check now passes basic auth credentials, since PD's REST interceptor covers every path except /v1/health, /actuator/* and /v1/prom/targets/*.
bitflicker64
force-pushed
the
doc-sync/server-store
branch
from
September 5, 2026 19:04
2d0f5e5 to
2820730
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Syncs the HugeGraph-Store quickstart page with
apache/hugegraphmaster (commit36811483a). Bothcontent/enandcontent/cnare updated.application.ymlblock did not match the shipped template:pdserver.addresswas shown as127.0.0.1:8686and the wholemanagementblock was missingpdserver.address: localhost:8686plus themanagementsectionapplication-pd.ymland itsrocksdb.*keys were not documented at all, even thoughspring.profiles.include: pdpulls the file intotal_memory_size,write_buffer_size,min_write_buffer_number_to_merge,write_buffer_ratioapp.fake-pd,app.raft-path,app.placeholder-size,app.label.*,grpc.server.wait-time, tenraft.*keys,ave-logEntry-size-ratio,thread.pool.*,query.push-down.*,job.*,fake-pd.*,arthas.*)-dstart flag was documented-d,-g,-j,-y, including that-g g1actually aborts the start even though the script's usage line suggests it, plus the real default heap (-Xms512m,-Xmxbetween 512 MB and 2048 MB), the ulimit preflight and jemalloc preloadrestart-hugegraph-store.shwas not mentioned, and the stop script's behavior was not describedbin/pidfile and the 30 second shutdown waitpd.initial-store-listrequirement was missingpd.initial-store-listregisters asPendingand never reachesUp, and that Store retries registration when PD is unreachable/actuator/healthwas the only endpoint listed, and/v1/healthwas described only in the Docker sectionhg-store-node:/v1/health,/actuator/health,/actuator/prometheus,/,/-/state,/-/echo,/-/scan,/v1/partitions,/v1/partition/{id},/metrics/system,/metrics/drive,/metrics/raft, with a note on the maintenance endpointsdocker-compose-3pd-3store-3server.ymland called it a 3 node clusterdocker-compose-hstore.yml(1 PD + 1 Store + 1 Server + 1 Hubble) and corrected both topologies to include HubbleSPRING_APPLICATION_JSONmechanism,JAVA_OPTSdefault,STDOUT_MODE=true, theHEALTHCHECKparameters and the fact that only 8520 is declaredEXPOSEHG_PD_INITIAL_STORE_LIST: store0:8500,store1:8500,store2:8500hugegraph-structfirst step and thehg-store-distpackage command, plus what the assembled directory containsapache-hugegraph-hstore-incubating-1.7.0, which is not the directory the release producesapache-hugegraph-store-incubating-1.7.0, matching the en pagen/aand plain punctuationcurl http://localhost:8620/v1/storeswith no credentials, which PD rejects with{"status":-1,"error":"Unauthorized!"}-u store:admin, with a note that the user name must be one ofhg,store,hubble,vermeer, that the password is not validated yet, and that only/v1/health,/actuator/*and/v1/prom/targets/*skip the interceptor