forked from cockroachdb/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOC-3386] Add docs for rotating a CMEK key (cockroachdb#14453)
* [DOC-3386] Add docs for rotating a CMEK key Co-authored-by: Ryan Kuo <[email protected]> Co-authored-by: Abhinav Garg <[email protected]> Co-authored-by: Michael Trestman <[email protected]>
- Loading branch information
1 parent
654f00b
commit 56485d1
Showing
9 changed files
with
265 additions
and
86 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
You can rotate a CMEK key for a {{ site.data.products.dedicated }} cluster either by creating a new version of the existing CMEK key or by creating a new CMEK key. At a high level: | ||
|
||
**To begin using a new version of an existing CMEK key**: | ||
|
||
1. In your KMS platform, you can either configure automatic rotation for the CMEK key, or you can perform a manual rotation. | ||
1. {{ site.data.products.db }} does not automatically re-encrypt the store key using the new CMEK key version. For each region you want to update, you must also perform a rotation using the {{ site.data.products.db }} API without modifying the CMEK key URI. {{ site.data.products.db }} re-encrypts the store key using the new CMEK key version. | ||
|
||
**To begin using an entirely new CMEK key**: | ||
|
||
1. Within your KMS platform, you create a new CMEK key. | ||
1. Next, you perform a rotation using the {{ site.data.products.db }} API and provide the new CMEK key URI. |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -47,26 +47,26 @@ After Enterprise Authentication is enabled, your Cockroach Labs team or the supp | |
|
||
## {{ site.data.products.db }} SSO Frequently Asked Questions (FAQ) | ||
|
||
### Will it work if I try to sign in with SSO without explicitly setting it up for my account, if I already use an email from an SSO Provider (e.g., [email protected])? | ||
### Will it work if I try to sign in with SSO without explicitly setting it up for my account, if I already use an email from an SSO Provider such as Gmail? | ||
|
||
No, that won't work until you set up SSO for your account with that specific identity provider. Using an email associated with an SSO provider (Google, GitHub, or Microsoft) does not automatically enable SSO. | ||
Yes, as long as the email address associated with your SSO provider is exactly the same as the one associated with your existing {{ site.data.products.db }} account. After successfully signing in, you will be prompted to approve the updated authentication method for your account. | ||
|
||
To change your SSO method to use that provider, visit **My Account** in the [{{ site.data.products.db }} Console](https://cockroachlabs.cloud). | ||
To view your current authentication method, visit **My Account** in the [{{ site.data.products.db }} Console](https://cockroachlabs.cloud). | ||
|
||
### Once I change my active login method to a new SSO provider, can I still sign in using my email/password combination or my GitHub identity? | ||
|
||
No. Only one authentication method can be active for each {{ site.data.products.db }} Console user at a time. Visit **My Account** in the [{{ site.data.products.db }} Console](https://cockroachlabs.cloud) to configure which authentication method is active. | ||
No. Only one authentication method can be active for each {{ site.data.products.db }} Console user. Visit **My Account** in the [{{ site.data.products.db }} Console](https://cockroachlabs.cloud) to view or update your active authentication method. | ||
|
||
### Does this change how administrators invite users? | ||
|
||
At the moment, no. The [workflow for inviting team members](console-access-management.html#invite-team-members-to-cockroachdb-cloud) to {{ site.data.products.db }} remains the same. | ||
The [workflow for inviting team members](console-access-management.html#invite-team-members-to-cockroachdb-cloud) to {{ site.data.products.db }} remains the same. If Enterprise Authentication is enabled for your {{ site.data.products.db }} organization, then you don't need to invite SSO users. | ||
|
||
### As an admin, how do I deprovision a user's access to {{ site.data.products.db }} Console if they leave the relevant project? | ||
|
||
If a user is using SSO, deleting the user's identity at the level of the SSO provider (e.g., deleting their Google account), will remove their access to the {{ site.data.products.db }} organization. | ||
If a user is using SSO, deleting the user's identity at the level of the SSO provider (for example, by deleting a user's GCP account) also removes their access to the {{ site.data.products.db }} organization. | ||
|
||
To remove a user's access to {{ site.data.products.db }} without deleting their SSO identity, you can [remove their {{ site.data.products.db }} user identity from your org](console-access-management.html#delete-a-team-member) in the console. | ||
To remove a user's access to {{ site.data.products.db }} without deleting their SSO identity, you can [remove their {{ site.data.products.db }} user identity from your {{ site.data.products.db}} organization](console-access-management.html#delete-a-team-member). | ||
|
||
### Can admins require a particular login method for their {{ site.data.products.db }} organization? | ||
|
||
Currently, no. | ||
Yes, as long as Enterprise Authentication is enabled for your {{ site.data.products.db }} organization. |
This file contains 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
This file contains 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
Oops, something went wrong.