RDSC-5587 Update CLI public docs and changelog#3614
Open
stoyanr wants to merge 1 commit into
Open
Conversation
andy-stark-redis
approved these changes
Jul 10, 2026
andy-stark-redis
left a comment
Contributor
There was a problem hiding this comment.
LGTM - great update :-)
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
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.
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-diCLI (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-dicontexts withset-context/use-context), command groupings, and new pages forlist/get/describe,delete, secrets CRUD, DLQ commands (list-dlqs,list-dlq-records;get-rejectedas alias), jobs/metrics, andcompletion. Removed reference pages includeadd-context,install,upgrade,monitor,trace, and the old standalonestatus/get-rejecteddocs.Deploy and operations guides now center on the CLI: unified
set-secretfor all install types (replacingrdi-secret.sh), secret management commands,deployflags (--dry-run, validation,--start), lifecycle (describe, start/stop/reset/delete), and--wait/--timeoutbehavior for batched secret updates. K8skubectlsecret docs add required operator discovery labels and recommend the CLI over rawkubectl.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 infofor API checks, quick-start context flow via--api-url, DLQ/observability links todescribe, and upgrade recovery text clarifyingupgrade.shvs deprecatedredis-di upgrade.Reviewed by Cursor Bugbot for commit d61862b. Bugbot is set up for automated code reviews on this repo. Configure here.