Skip to content

Conversation

@jojochuang
Copy link
Contributor

This commit adds a new section to the SCM user documentation explaining what Safe Mode is, how it works, and the conditions for exiting it. It also includes the default values for the relevant configuration properties.

What changes were proposed in this pull request?

HDDS-13379: Document SCM Safe Mode and its configuration properties.

Please describe your PR in detail:

  • Generate explanations for "Safe Mode"
  • Generated-by: Google Gemini 2.5 Pro/Flash, + Gemini Cli. Prompt:

Is there any user doc that details what safe mode is and what conditions must be satisfied to get over the safe mode?
Good. Looks like existing user doc does not explain it. Add this description to the "Storage Container Manager" user doc.
Add the default value for the configuration properties mentioned.
Looks good. Commit the current update.

Tokens used:

│  Input Tokens         9,494,237  │
│  Output Tokens            4,728  │
│  Thoughts Tokens          2,767  │
│  ──────────────────────────────  │
│  Total Tokens         9,501,732  │
│                                  │
│  Total duration (API)    6m 13s  │

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-13379

How was this patch tested?

Draft prepared by Gemini; Reviewed and cross referenced the source code manually.

This commit adds a new section to the SCM user documentation explaining
what Safe Mode is, how it works, and the conditions for exiting it.
It also includes the default values for the relevant configuration properties.

Change-Id: I77efd23a1d31bd14ecabbaa7347f6676267aeeb0
@jojochuang jojochuang added documentation Improvements or additions to documentation AI-gen labels Jul 3, 2025
@adoroszlai adoroszlai removed their request for review July 4, 2025 05:10
@ivandika3 ivandika3 changed the title HDDS-13379: Document SCM Safe Mode and its configuration properties. HDDS-13379. Document SCM Safe Mode and its configuration properties. Jul 4, 2025
Copy link
Contributor

@chungen0126 chungen0126 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 LGTM

@jojochuang jojochuang merged commit 2ae8d6d into apache:master Jul 10, 2025
14 of 15 checks passed
@jojochuang
Copy link
Contributor Author

Merged. Thanks @chungen0126

jojochuang added a commit to jojochuang/ozone that referenced this pull request Jul 31, 2025
…pache#8737)

Generated-by: Google Gemini 2.5 Pro/Flash, + Gemini Cli
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI-gen documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants