[RORDEV-1317] ror-tools patching confirmation docs #251
Conversation
WalkthroughThe changes modify the Docker command in the ReadonlyREST patch process by adding an explicit flag to signal acceptance of ES patching. Documentation is also enhanced to include clearer instructions on the confirmation process and alternative silent mode operation. No public API declarations have been altered. Changes
Sequence Diagram(s)sequenceDiagram
participant D as Docker Container
participant PS as Patching Script
participant U as User
D->>PS: Execute patch command with flag (--I_UNDERSTAND_AND_ACCEPT_ES_PATCHING yes)
alt Flag Present
PS-->>D: Apply patch non-interactively
else No Flag
PS->>U: Prompt for confirmation
U-->>PS: User confirms patching
PS-->>D: Apply patch interactively
end
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
mgoworko
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
eck.md (1)
172-173: Explicit Acceptance Flag in Docker Patch CommandThe Docker command now includes the flag
--I_UNDERSTAND_AND_ACCEPT_ES_PATCHING yes
to explicitly signal acceptance of the Elasticsearch patching. Please verify that the spacing (a space versus an “=” separator) is consistent with similar instructions elsewhere (for example, in the silent mode section ofelasticsearch.md).elasticsearch.md (2)
140-141: Clarify Interactive Patching InstructionsThe new note for interactive patching clarifies that users will be prompted for confirmation and that root privileges are required on Elasticsearch 8.3.x or newer. However, the sentence
“Please see the silent mode is there is a need to bypass this step.”
would be clearer if rephrased. For example:
“Please see the silent mode section if you wish to bypass the confirmation prompt.”
291-299: Consistent Silent Mode Patching InstructionsThe added silent mode block explains how to run the patch command non‐interactively using
--I_UNDERSTAND_AND_ACCEPT_ES_PATCHING=yes. A couple of points to consider:• The instructions repeat the root privilege reminder; consider consolidating this information for brevity.
• The flag’s syntax differs from the Docker command ineck.md(which uses a space rather than “=”)—please ensure the flag is used consistently across the documentation.
* commit new action strings * [RORDEV-1317] ror-tools patching confirmation docs (#251) Docs * RORDEV-1262 improvements * RORDEV-1262 improvements * RORDEV-1262 Add documentation for extending Kibana API with x-ror-tenancy-id header (#253) * RORDEV-1262 Add documentation for extending Kibana API with x-ror-tenancy-id header * RORDEV-1262 Add info about id * RORDEV-1262 add info about default value * update description * update based on coderabbit suggestions * update message * change endpoint to /tenants * RORDEV-1444 user info source methods description (#252) * RORDEV-1446-Add-support-for-the-passing-any-SAML/OIDC-config-parameters-via-kibana.yml (#256) * RORDEV-1446-Add-support-for-the-passing-any-SAML/OIDC-config-parameters-via-kibana.yml * RORDEV-1446 review comment * commit new action strings * commit new action strings * commit new action strings * commit new action strings * RORDEV-1262 adjust endpoint * RORDEV-1262 cr comments resolving * RORDEV-1262 improvements * RORDEV-1262 improvements * update description * update based on coderabbit suggestions * update message * change endpoint to /tenants * RORDEV-1262 adjust endpoint * RORDEV-1262 cr comments resolving * RORDEV-1262 change example * RORDEV-1262 change all tenants to user's tenants * RORDEV-1262 change methods --------- Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: mgoworko <37329559+mgoworko@users.noreply.github.com>
Summary by CodeRabbit