Skip to content

docs(raft): add -dr-token note to list-peers and remove-peer commands - #2997

Open
ShamanthGaddam wants to merge 4 commits into
hashicorp:mainfrom
ShamanthGaddam:VAULT-4408/add-dr-token-docs-for-raft-commands
Open

docs(raft): add -dr-token note to list-peers and remove-peer commands#2997
ShamanthGaddam wants to merge 4 commits into
hashicorp:mainfrom
ShamanthGaddam:VAULT-4408/add-dr-token-docs-for-raft-commands

Conversation

@ShamanthGaddam

Copy link
Copy Markdown

Summary

Add a reusable partial documenting the -dr-token flag for vault operator raft commands on DR secondary clusters, and include it in both the list-peers and remove-peer sections.

Changes

  • New file: content/vault/v1.20.x/content/partials/raft-dr-token.mdx
    A reusable <Note> callout explaining:

    • Use -dr-token <dr-operation-token> to run commands on a DR secondary cluster
    • DR secondaries mirror their primaries — changes should be made on the primary first
    • Links to the DR operation token documentation
  • Updated: content/vault/v1.20.x/content/docs/commands/operator/raft.mdx
    Added @include 'raft-dr-token.mdx' to both the list-peers and remove-peer sections

Related

Resolves VAULT-4408

Add a reusable partial (raft-dr-token.mdx) documenting the -dr-token
flag and include it in both the list-peers and remove-peer sections of
the operator raft command docs.

Resolves VAULT-4408
@ShamanthGaddam
ShamanthGaddam requested a review from a team as a code owner August 4, 2026 14:41
@github-actions github-actions Bot added the Vault Content update for Vault product docs label Aug 4, 2026
@hashicorp-cla-app

hashicorp-cla-app Bot commented Aug 4, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@hashicorp-cla-app

Copy link
Copy Markdown

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Fri Aug 7 03:41:41 UTC 2026
Unified Docs API ✅ Ready (Inspect) Visit Preview Fri Aug 7 03:37:15 UTC 2026

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Broken Link Checker

This PR contains broken links, but won't be blocked. Use this report to improve content quality:

Quick Actions

  • Internal links (HashiCorp sites): Please fix these - they impact user experience
  • External links: Consider if these are essential or can be updated/removed
  • Temporary issues: External sites may recover - check again before merging

Need Help?


Internal Links

Full Github Actions output

External Links

Summary

Status Count
🔍 Total 7
✅ Successful 1
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 6
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 0

Full Github Actions output

@ShamanthGaddam
ShamanthGaddam force-pushed the VAULT-4408/add-dr-token-docs-for-raft-commands branch from c88be31 to e916943 Compare August 6, 2026 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Vault Content update for Vault product docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant