REL-1368082: Add configure-retention CLI command user guide for Environment Watch - #77
Open
amithshet wants to merge 4 commits into
Open
REL-1368082: Add configure-retention CLI command user guide for Environment Watch#77amithshet wants to merge 4 commits into
amithshet wants to merge 4 commits into
Conversation
amithshet
requested review from
Rahiman-Nadaf,
anujavinash and
satishdayala-relativity
August 28, 2026 10:49
Rahiman-Nadaf
approved these changes
Aug 31, 2026
anujavinash
approved these changes
Aug 31, 2026
anujavinash
self-requested a review
August 31, 2026 07:30
anujavinash
approved these changes
Aug 31, 2026
|
@amithshet |
Covers the review questions on PR #77 and aligns terminal output with the CLI behaviour captured on the test VM: - Document what happens when all prompts are skipped: no summary block and no confirmation gate, just "Operation cancelled." - Add Secret Store credential handling for both modes - interactive prompts for cluster URL, username and password; quiet mode exits with an error - Clarify that a first run reports each signal as "not set" rather than failing the current-state fetch - Correct the confirmation prompts to "[y/n] (n)" to match the CLI and the rotate-api-key guide - Replace the vague Elasticsearch prerequisite with a concrete endpoint check - Remove the troubleshooting section and unverified failure scenarios Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…y page Per review feedback on PR #77, consolidates the automated (CLI) and manual retention configuration guidance onto a single page instead of two: - Fold the configure-retention CLI content into ew-extensibility-configuration-03-retention-policy.md as a new "Configure Elasticsearch ILM Retention using the Relativity Server CLI" section, replacing the old manual "Configuration Steps" (Kibana Dev Tools component-template/index-template edits and destructive data stream deletion) - Delete the now-redundant standalone elastic-stack-configure-retention-environment-watch.md - Repoint the "Managing ILM Retention" link in elastic-stack-setup-02-environment-watch.md to the merged section - Fix a stale link display name in the post-install verification guide Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
amithshet
requested review from
satishdayala-relativity
and removed request for
satishdayala-relativity
September 11, 2026 08:59
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
4 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.
Summary
Adds a user guide for the \configure-retention\ Relativity Server CLI command, following the same structure and conventions as the
otate-api-key\ guide (PR #69).
The \configure-retention\ command was implemented in relativityone/server-relativity-environmentwatch#570 and shipped in version 102.1.26.
Terminal output examples have been verified against actual CLI output from a test VM.
Files changed
New: \�lastic-stack-setup/elastic-stack-setup-02-environment-watch/elastic-stack-configure-retention-environment-watch.md\
Modified: \�lastic-stack-setup/elastic-stack-setup-02-environment-watch/elastic-stack-setup-02-environment-watch.md\
Jira
REL-1368082