Repository navigation
feat(dist): Make conf/logs/plugins/pid paths overridable and fix log4j2 config resolution #3253
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
362e27e
526bf2e
e272e27
6ecc85e
6052186
860ec0f
4d633ec
3e78d09
53cba6c
1217922
1d42786
fd066d0
7791441
36dbdf6
91f5ef8
f627f3e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -54,6 +54,56 @@ bootstrap before Server accepts Gremlin requests. This does not initialize the p | |
| for every future Store target. Unit checks that obtain a stub verify lazy pool | ||
| construction; a successful RPC and its readback are separate runtime checks. | ||
|
|
||
| ### Launcher path overrides | ||
|
|
||
| `bin/start-hugegraph.sh` accepts four path overrides. The override flags also work in | ||
| `bin/init-store.sh` (`-c`/`-o`), `bin/stop-hugegraph.sh` (`-i`) and the monitor | ||
| cron job installed by `-m true`, so stop/restart/monitor stay consistent with | ||
| the paths `bin/start-hugegraph.sh` used. | ||
|
|
||
| | Flag | Meaning | Default (when omitted) | | ||
| |---|---|---| | ||
| | `-c <dir>` | Conf directory | `$TOP/conf` | | ||
| | `-l <dir>` | Logs directory | `$TOP/logs` | | ||
| | `-i <file>` | PID file | `$BIN/pid` | | ||
| | `-o <dir>` | Plugins directory | `$TOP/plugins` | | ||
|
|
||
| `$TOP` is the distribution's install root (the parent of `bin/`); `$BIN` is | ||
| `$TOP/bin`. | ||
|
|
||
| Relative values are resolved to absolute paths before use: `-l` and `-o` name | ||
| directories the launcher writes into, so a relative or missing directory is | ||
| created; `-c` is only ever read, so a relative value is resolved without | ||
| creating anything, and a missing `-c` directory is a startup error. `-i`'s | ||
| parent directory is created by `start-hugegraph.sh`, | ||
| matching `-l`/`-o`; `stop-hugegraph.sh` and the monitor cron job resolve the | ||
| same `-i` path read-only, without creating it, so a missing PID file or | ||
| parent at stop time is a lookup error rather than being created. | ||
| A value for `-c` must still be an existing path once resolved — the launcher | ||
| does not create the external conf dir for you unless it already exists. | ||
|
|
||
| Avoid `:`, `;`, `%`, and embedded CR/LF characters in any of these four paths: | ||
| `-o` is joined into a `:`-separated CLASSPATH (and `;`-separated on Cygwin), so | ||
| a `:`/`;` in that path corrupts the classpath; `%` is reserved by cron and is | ||
| rejected whenever `-m true` persists these paths into a crontab line; CR/LF is | ||
| always rejected. The launcher validates each path both before and after | ||
| resolving a relative value to an absolute one, since resolution against the | ||
| working directory can itself introduce a problem character that was not in | ||
| the original value. | ||
|
|
||
| When `-c` points at an external conf directory, keep `graphs` in | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Important: |
||
| `rest-server.properties`, `ssl.keystore_file` (when `restserver.url` is | ||
| `https`), and `tokens` under `gremlin-server.yaml`'s `config:` block (written | ||
| by `enable-auth.sh`) as absolute paths, or under that `-c` directory. All | ||
| three are otherwise resolved by the JVM against the working directory | ||
| (`$TOP`). | ||
|
|
||
| The Cypher endpoint's `conf/remote-objects.yaml` (the Gremlin host/port it | ||
| connects to) is resolved from the `-c` conf dir when set, instead of always | ||
| reading the packaged copy relative to `$TOP`; otherwise a second instance | ||
| started with its own `-c`/Gremlin port would still have its Cypher queries | ||
| routed to the first instance's Gremlin server. | ||
|
|
||
| ### Launcher GC options | ||
|
|
||
| Use `bin/start-hugegraph.sh -g g1` (or `-g G1`) to select G1 explicitly. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Important:
test-check-jacoco-report.shasserts the exact set of--require-test-reportfiles for thestorejob, which still lists 8, so this ninth entry fails its aggregation contract and theRun JaCoCo report validator testsstep ofpd_store / storeexits 1 at this head. AddTEST-org.apache.hugegraph.store.node.listener.PdConfigureListenerYamlTest.xmlto that expected set.