doc(server): sync pd with master - #485
Open
bitflicker64 wants to merge 1 commit into
Open
Conversation
Rewrote the PD quickstart configuration, startup and verification sections against hugegraph master. Removed the non-existent store.initial-store-count key, added a full application.yml reference with the defaults from PDConfig, added single-node and three-node cluster examples, documented the -g/-j/-y start flags alongside -d, added the cluster startup order relative to Store and Server, and documented that PD REST requires HTTP Basic auth for every path except /v1/health, /actuator/* and /v1/prom/targets/*, so the verification curl commands now pass credentials. Also added the PD REST endpoint list, the port table, the Docker healthcheck and entrypoint behaviour, and the build output paths.
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-PD quickstart page (en and cn) with
apache/hugegraphmaster. Every change below traces to a file on master; no other page is touched.application.ymlsample putinitial-store-count: 1understore:. No such key exists; PD only bindspd.initial-store-count.management,loggingandlicenseblocks it was missing.curl http://localhost:8620/v1/storeswith no credentials. PD registers a REST interceptor on/**, so that request answers{"status":-1,"error":"Unauthorized!"}.hg,store,hubble,vermeer, password not validated yet), listed the exempt paths, and changed every example tocurl -u store:admin, the credentials the Server's own wait script uses./actuator/healthwas the only health check shown./v1/healthis the endpoint the image healthcheck and the release test script actually use, and it is the one that needs no credentials.GET /v1/healthfirst, kept/actuator/healthas the more readable alternative.application.ymlwas undocumented.raft.enable,raft.ip-whitelist.enabled,raft.snapshotInterval,raft.rpc-timeout,store.keepAlive-timeout,pd.cluster_id,discovery.heartbeat-try-count,auth.secret-keyand the thread-pool keys were absent.raft.peers-listrule, the all-on-one-host port layout, and the Docker bridge equivalent.-dwas documented forstart-hugegraph-pd.sh.-g,-jand-ywith their accepted values, theDAEMON/GC_OPTION/USER_OPTION/OPEN_TELEMETRY/JAVA_OPTIONS/STDOUT_MODEenvironment equivalents, the 512 MB to 32 GB heap sizing, the already-running guard, and whatstop-hugegraph-pd.shdoes withbin/pid. Noted that-g g1aborts the start, onlyzgc/ZGCor no flag are accepted.hg-pd-service, with the request bodies for the POST endpoints and a note on which paths skip authentication. Also added 7.3 for/v1/members,/v1/clusterand/.-d falseentrypoint, or what happens when a required variable is missing.SPRING_APPLICATION_JSONmechanism, the required-variable check,JAVA_OPTSpassthrough, and theHG_PD_*toapplication.ymlkey mapping in the variable table.-pl hugegraph-pd/hg-pd-dist -amcommand.deployPathto 1.7.0./v1/storesresponse that the en page has.Also removed the em dashes that were already in both files, so the pages use plain ASCII punctuation.