improvement: add doc additions for single credential rotations

This commit is contained in:
Scott Wilson
2025-04-15 15:07:39 -07:00
parent 03ad6f822a
commit 5eb9a1a667
2 changed files with 29 additions and 2 deletions
@@ -47,6 +47,11 @@ Each set of credentials transitions through three distinct states:
- **Active**: The primary credentials that will be used for new connections - **Active**: The primary credentials that will be used for new connections
- **Inactive**: These credentials are still valid but are no longer issued for new connections - **Inactive**: These credentials are still valid but are no longer issued for new connections
<Note>
Some rotation providers utilize a single credential set due to technical constraints. As a result, inactive credentials for these providers will immediately become invalid once rotated.
To avoid service interruptions, Infisical recommends manually rotating these credentials to prevent downtime.
</Note>
- **Revoked**: Permanently invalidated and deleted from the system - **Revoked**: Permanently invalidated and deleted from the system
### Rotation Cycle Example (30-Day Interval) ### Rotation Cycle Example (30-Day Interval)
@@ -95,3 +100,16 @@ Using a __30-Day__ rotation interval as an example, here's how the process unfol
- [PostgreSQL Credentials](./postgres) - [PostgreSQL Credentials](./postgres)
- [Microsoft SQL Server Credentials](./mssql) - [Microsoft SQL Server Credentials](./mssql)
## FAQ
<AccordionGroup>
<Accordion title="Why do certain rotations only use a single credential set?">
Some credential providers have limitations that affect rotation patterns:
- The third-party provider's API only supports managing one active credential set at a time
- The specific use-case (such as personal login accounts) is inherently limited to a single active credential
In either scenario, when service continuity is critical, Infisical recommends disabling auto-rotation and performing manual credential rotation during scheduled maintenance windows.
</Accordion>
</AccordionGroup>
@@ -126,11 +126,20 @@ export const SecretRotationV2ConfigurationFields = ({ isUpdate, environments }:
}} }}
/> />
{!IS_ROTATION_DUAL_CREDENTIALS[type] && isAutoRotationEnabled && ( {!IS_ROTATION_DUAL_CREDENTIALS[type] && isAutoRotationEnabled && (
<div className="rounded border border-yellow bg-yellow/10 p-2 px-3 text-sm text-yellow"> <div className="rounded border border-yellow bg-yellow/10 p-2 px-3 text-xs text-yellow">
<FontAwesomeIcon icon={faWarning} className="mr-1" /> Due to{" "} <FontAwesomeIcon icon={faWarning} className="mr-1" /> Due to{" "}
{SECRET_ROTATION_MAP[type].name} Rotations rotating a single credential set, auto-rotation {SECRET_ROTATION_MAP[type].name} Rotations rotating a single credential set, auto-rotation
may result in service interruptions. If you need to ensure service continuity, we may result in service interruptions. If you need to ensure service continuity, we
recommend disabling this option. recommend disabling this option. <br />
<a
href="https://infisical.com/docs/documentation/platform/secret-rotation/overview#how-rotation-works"
target="_blank"
rel="noopener noreferrer"
className="underline decoration-yellow underline-offset-2 hover:text-mineshaft-200"
>
Read more
</a>
.
</div> </div>
)} )}
</> </>