HDDS-15082. Add User facing Config Contract#10147
Open
henrybear327 wants to merge 2 commits intoapache:masterfrom
Open
HDDS-15082. Add User facing Config Contract#10147henrybear327 wants to merge 2 commits intoapache:masterfrom
henrybear327 wants to merge 2 commits intoapache:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an internal ozone local CLI surface and supporting configuration objects to define a user-facing configuration contract for spinning up a local single-node Ozone cluster.
Changes:
- Introduces
OzoneLocal(hidden) CLI withrunsubcommand and env/CLI-based config resolution intoLocalOzoneClusterConfig. - Adds
LocalOzoneClusterConfigandLocalOzoneRuntimeas the local runtime contract/config model. - Adds unit tests covering command metadata/help visibility and config parsing/precedence/validation.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/local/OzoneLocal.java | New internal CLI entry point and config resolution logic from flags/env vars. |
| hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/local/LocalOzoneClusterConfig.java | New config model + builder + FormatMode parsing for user-facing values. |
| hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/local/LocalOzoneRuntime.java | New runtime interface contract for local single-node runtimes. |
| hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/local/package-info.java | New package documentation for the local runtime support package. |
| hadoop-ozone/tools/src/test/java/org/apache/hadoop/ozone/local/TestOzoneLocal.java | Tests for CLI metadata, help behavior, and env/CLI precedence + validation errors. |
| hadoop-ozone/tools/src/test/java/org/apache/hadoop/ozone/local/TestLocalOzoneClusterConfig.java | Tests for builder defaults/overrides and FormatMode parsing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| : parsePort(environment.get(ENV_S3G_PORT), ENV_S3G_PORT, | ||
| LocalOzoneClusterConfig.DEFAULT_PORT); | ||
|
|
||
| boolean resolvedS3gEnabled = withoutS3g ? false |
Comment on lines
+194
to
+196
| boolean resolvedEphemeral = ephemeral || parseBoolean( | ||
| environment.get(ENV_EPHEMERAL), ENV_EPHEMERAL, | ||
| LocalOzoneClusterConfig.DEFAULT_EPHEMERAL); |
Comment on lines
+154
to
+158
| public static FormatMode fromString(String value) { | ||
| String normalized = value.trim().toUpperCase(Locale.ROOT) | ||
| .replace('-', '_'); | ||
| return valueOf(normalized); | ||
| } |
Comment on lines
+147
to
+151
| @Override | ||
| public Void call() { | ||
| resolveConfig(new OzoneConfiguration()); | ||
| return null; | ||
| } |
peterxcli
reviewed
Apr 27, 2026
Comment on lines
+87
to
+89
| @Option(names = "--format", | ||
| description = "Storage init mode: if-needed, always, never") | ||
| private String format; |
Member
There was a problem hiding this comment.
could we use enum? not sure if other similar cases do the same thing.
peterxcli
reviewed
Apr 27, 2026
Comment on lines
+300
to
+318
| private static boolean parseBoolean(String rawValue, String source, | ||
| boolean fallback) { | ||
| if (isBlank(rawValue)) { | ||
| return fallback; | ||
| } | ||
| String value = rawValue.trim(); | ||
| if ("true".equalsIgnoreCase(value) | ||
| || "yes".equalsIgnoreCase(value) | ||
| || "on".equalsIgnoreCase(value)) { | ||
| return true; | ||
| } | ||
| if ("false".equalsIgnoreCase(value) | ||
| || "no".equalsIgnoreCase(value) | ||
| || "off".equalsIgnoreCase(value)) { | ||
| return false; | ||
| } | ||
| throw new IllegalArgumentException("Unable to parse " + source | ||
| + " as a boolean. Use true/false, yes/no, or on/off."); | ||
| } |
Member
There was a problem hiding this comment.
please could you help me to look if there is any existing helper for this?
| return parseFormat(rawValue, source); | ||
| } | ||
|
|
||
| private static int parseInt(String rawValue, String source, int fallback) { |
| return parseDuration(rawValue, source, baseConfiguration); | ||
| } | ||
|
|
||
| private static Duration parseDuration(String rawValue, String source, |
Member
There was a problem hiding this comment.
7ce1aa3#r3148108852
ditto
can use ai to scan all of these parsers
Member
|
@henrybear327 please merge upstream master, thanks! |
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
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?
Introduce user-facing paremeters for local ozone cluster spin up.
What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-15082
How was this patch tested?
Unit tests.