Skip to content

REL-1368082: Add configure-retention CLI command user guide for Environment Watch - #77

Open
amithshet wants to merge 2 commits into
mainfrom
REL-1368082-cli-configure-retention-doc
Open

REL-1368082: Add configure-retention CLI command user guide for Environment Watch#77
amithshet wants to merge 2 commits into
mainfrom
REL-1368082-cli-configure-retention-doc

Conversation

@amithshet

Copy link
Copy Markdown
Collaborator

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\

    • Overview and prerequisites
    • Options table (--logs-days, --metrics-days, --traces-days, --quiet, --dryrun)
    • Usage with verified terminal output: interactive, interactive with pre-filled default, quiet/unattended, dry run (quiet + interactive)
    • Verify section — Kibana Dev Tools \GET /_ilm/policy/infrawatch--policy\
  • Modified: \�lastic-stack-setup/elastic-stack-setup-02-environment-watch/elastic-stack-setup-02-environment-watch.md\

    • Added ## Managing ILM Retention\ cross-reference section before Next Steps

Jira

REL-1368082

@anujavinash
anujavinash self-requested a review August 31, 2026 07:30
@vamsiatluri555

Copy link
Copy Markdown

@amithshet
What happens if the user doesn't change anything? If someone runs the command and just skips past all the prompts without entering any new values, does the tool still show the summary screen and ask "Apply changes? yes/no". even though nothing would actually change?
Also, The guide only documents the happy path (successful update) and one user-initiated cancellation ("Operation cancelled."). It does not cover what the CLI outputs when something goes wrong at runtime such as elasticsearch cluster is unreachable or times out during the update or in similar scenarios?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants