HDDS-15358. Update environment variable docs to match shell script behavior#447
Merged
Conversation
jojochuang
reviewed
May 24, 2026
Comment on lines
52
to
55
| :::note HttpFS Gateway Configuration | ||
| The HttpFS Gateway does not use an `OZONE_HTTPFS_OPTS` variable. Its specific JVM properties must be added to the global `OZONE_OPTS` variable. | ||
| The HttpFS Gateway supports a dedicated `OZONE_HTTPFS_OPTS` variable, just like the other daemons. Any JVM properties set in `OZONE_HTTPFS_OPTS` are folded into `OZONE_OPTS` when the gateway starts, so you no longer need to add them to the global `OZONE_OPTS` variable. | ||
| ::: | ||
|
|
Contributor
There was a problem hiding this comment.
let's remove this section.
jojochuang
reviewed
May 24, 2026
Contributor
jojochuang
left a comment
jojochuang
left a comment
There was a problem hiding this comment.
this is good. we can merge after removing the httpfs gw configuration section.
jojochuang
approved these changes
May 26, 2026
Contributor
|
Merged. Thanks @chihsuan |
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
2 participants
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.
What changes were proposed in this pull request?
This is the website companion to HDDS-14443 (apache/ozone#10352), which fixed the in-distribution docs (
ozone-env.sh) and theozonelauncher script in the apache/ozone repo. The website hosts a separate, hand-maintained copy of the same environment variable information that still carried the old inconsistencies. This PR updatesdocs/.../02-environment-variables.mdso it matches the actual behavior of the shell scripts, brought to full parity with the variables defined in apache/ozone#10352.Role-Specific Environment Variables table (added the missing rows):
OZONE_HTTPFS_OPTS,OZONE_CSI_OPTS(daemon JVM opts)OZONE_SH_OPTS,OZONE_FS_OPTS,OZONE_ADMIN_OPTS,OZONE_DEBUG_OPTS,OZONE_FREON_OPTS,OZONE_VAPOR_OPTS(client/tool JVM opts)OZONE_DAEMON_JSVC_EXTRA_OPTS(extra arguments passed tojsvcwhen launching secure/privileged daemons)Common Environment Variables table (added for parity):
OZONE_LOGLEVEL(defaultINFO)OZONE_SECURE_LOG_DIR(default$OZONE_LOG_DIR)OZONE_WORKER_NAMESHttpFS Gateway admonition: the
:::notepreviously stated that HttpFS has no dedicated opts variable and that its JVM properties must be added to the globalOZONE_OPTS. That is no longer true. The note now states thatOZONE_HTTPFS_OPTSis supported and behaves like the other daemons (the genericozone_subcommand_optshandler foldsOZONE_<SUBCMD>_OPTSintoOZONE_OPTS).No reference to the non-functional
OZONE_SECURE_LOGvariable exists on this page (the scripts readOZONE_SECURE_LOG_DIR), so no change was needed there. The frozen released snapshot underversioned_docs/version-2.1.0/was intentionally not modified.What is the link to the Apache Jira?
https://issues.apache.org/jira/browse/HDDS-15358
Follow-up to HDDS-14443 (apache/ozone#10352).
How was this patch tested?
pnpm buildcompleted successfully (Server, Client, and Service Worker all compiled without errors)./docs/next/administrator-guide/configuration/basic/environment-variables.