Skip to content

RDSC-5587 Update CLI public docs and changelog#3614

Open
stoyanr wants to merge 1 commit into
redis:mainfrom
stoyanr:RDSC-5587-update-cli-public-docs
Open

RDSC-5587 Update CLI public docs and changelog#3614
stoyanr wants to merge 1 commit into
redis:mainfrom
stoyanr:RDSC-5587-update-cli-public-docs

Conversation

@stoyanr

@stoyanr stoyanr commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

See https://redislabs.atlassian.net/browse/RDSC-5587, the RDI PR is https://github.com/RedisLabs/redis-data-integration/pull/2657.


Note

Low Risk
Documentation-only changes to RDI integration guides and CLI reference; no application code or runtime behavior is modified.

Overview
This PR realigns RDI public docs with the current redis-di CLI (API URL, contexts, and REST-backed commands) and drops legacy install/ops commands from the reference.

The CLI reference is rewritten: global options (--api-url, JWT vs Redis Cloud auth, ~/.redis-di contexts with set-context / use-context), command groupings, and new pages for list/get/describe, delete, secrets CRUD, DLQ commands (list-dlqs, list-dlq-records; get-rejected as alias), jobs/metrics, and completion. Removed reference pages include add-context, install, upgrade, monitor, trace, and the old standalone status / get-rejected docs.

Deploy and operations guides now center on the CLI: unified set-secret for all install types (replacing rdi-secret.sh), secret management commands, deploy flags (--dry-run, validation, --start), lifecycle (describe, start/stop/reset/delete), and --wait / --timeout behavior for batched secret updates. K8s kubectl secret docs add required operator discovery labels and recommend the CLI over raw kubectl.

Installation and troubleshooting updates add a separate CLI download section for Kubernetes, VM note that the CLI is bundled (optional off-box download), redis-di info for API checks, quick-start context flow via --api-url, DLQ/observability links to describe, and upgrade recovery text clarifying upgrade.sh vs deprecated redis-di upgrade.

Reviewed by Cursor Bugbot for commit d61862b. Bugbot is set up for automated code reviews on this repo. Configure here.

@CLAassistant

CLAassistant commented Jul 10, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@andy-stark-redis andy-stark-redis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM - great update :-)

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.

3 participants