-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs: clarify single-instance vs dual-phase rotation per provider #5354
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: clarify single-instance vs dual-phase rotation per provider #5354
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Greptile OverviewGreptile SummaryThis PR improves secret rotation documentation by clearly distinguishing between single-instance and dual-phase rotation strategies across all 16 supported providers. Key Changes:
The documentation is now clear about which providers support zero-downtime rotation and which require maintenance windows. This helps users make informed decisions about auto-rotation configuration. Confidence Score: 5/5
Important Files Changed
|
1460b95 to
bf00cdc
Compare
- Add rotation behavior section to overview with provider comparison table - Add dual-phase callout to 12 provider docs (PostgreSQL, MySQL, MSSQL, etc.) - Update single-instance provider docs with warning callouts (Auth0, LDAP, Unix/Linux, Windows) - Add FAQ explaining rotation type differences Resolves SECRETS-99 Co-authored-by: Cursor <cursoragent@cursor.com>
bf00cdc to
37b2f39
Compare
Co-authored-by: Victor Hugo dos Santos <115753265+victorvhs017@users.noreply.github.com>
Co-authored-by: Victor Hugo dos Santos <115753265+victorvhs017@users.noreply.github.com>
Context
Secret rotation documentation does not clearly indicate when a rotation is single-instance vs dual-phase per provider. Users need to understand this per provider to reason about behavior (e.g., overlap period, zero-downtime guarantees).
Changes:
<Info>callout to 12 dual-phase provider docs indicating zero-downtime rotation<Warning>callout explaining potential service interruptionsResolves SECRETS-99
Screenshots
N/A - Documentation only changes
Steps to verify the change
<Info>callout<Warning>calloutType
Checklist
type(scope): short description