-
Notifications
You must be signed in to change notification settings - Fork 711
support cmek for alibaba cloud #22947
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
base: release-8.5
Are you sure you want to change the base?
Changes from all commits
9838e39
fdd5c15
df26b42
03a47b9
f070954
094e0a7
df11b1b
d07be47
204e98e
8cfd75d
72c7f8e
e34be36
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,153 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| title: Dual-layer Data Encryption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| summary: Learn how to enable Dual-layer Data Encryption on {{{ .premium }}} TiDB. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| aliases: ['/tidbcloud/premium/tidb-cloud-encrypt-cmek'] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Dual-layer data encryption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Overview | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| {{{ .premium }}} enables data encryption at rest by default on TiDB service instance storage and snapshot volumes. This provides basic encryption capabilities to enhance data security. Building on this, {{{ .premium }}} allows you to combine TiDB service's storage engine encryption with your cloud provider KMS, adding another layer of data encryption (Dual-layer Data Encryption). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Encryption mechanism | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| To provide the highest level of data security, {{{ .premium }}} TiDB adopts a two-tier architecture for data-at-rest encryption. Your data is safeguarded by both Storage-layer and Database-layer protections. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Storage-layer Data Encryption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - This is the underlying data encryption directly implemented by cloud service providers on their storage infrastructure. For example, on AWS, this includes EBS volume encryption and S3 bucket encryption. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - This layer of encryption is enabled by default for all {{{ .premium }}} instances and cannot be disabled. It serves as the foundational security baseline for your data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Database-layer Encryption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Building on top of the storage-layer encryption, TiDB Cloud allows you to add an extra layer of data encryption at the database level (labeled as **Dual-layer Data Encryption** in the console). Once enabled, static data encryption specifically covers TiKV's stored data and BR's backup data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - The TiDB database system ensures that data remains encrypted at rest within the system, thereby effectively reducing the risk of data leakage during subsequent data transfers. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Unlike default storage encryption, this feature can be managed by users, allowing you to choose either a Customer-Managed Encryption Key (CMEK) or a Service-Managed Encryption Key based on your security compliance and operational requirements. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Backup and restore description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| When Dual-layer Data Encryption is enabled, the backup data for your {{{ .premium }}} TiDB instance is also encrypted. Any new instance restored from this backup will natively inherit the encryption attributes and KMS master key of the original instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Since accessing the backup data relies on the originally configured KMS master key, please ensure the following: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Maintain key availability**: Even if you delete the original Premium TiDB instance, the associated KMS master key must remain active to successfully recover the backup data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Ensure correct authorization**: During a restore operation, you must configure the exact same KMS master key associated with the backup and ensure it has the proper permissions for data access. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Key Management Mechanism | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Premium's Dual-layer Data Encryption uses your cloud provider KMS to manage master keys for data-at-rest encryption. Depending on your compliance and maintenance requirements, you can choose between two key management options: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Check failure on line 36 in tidb-cloud/premium/tidb-cloud-encrypt-cmek-premium.md
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 1. **Customer-Managed Encryption Key (CMEK)**: You provide and manage your own cloud provider KMS master key. This option offers maximum control over your encryption, making it ideal for organizations prioritizing strict security. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Important:** You are fully responsible for maintaining the key's security and availability. If the configured CMEK is deleted, your Premium TiDB instance will malfunction, and the encrypted data will become permanently unrecoverable. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2. **Service-Managed Encryption Key**:TiDB Cloud Premium automatically provisions and maintains the KMS master key for you, offering a balance of security and convenience with zero maintenance overhead. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Check failure on line 41 in tidb-cloud/premium/tidb-cloud-encrypt-cmek-premium.md
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Key Characteristics: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - It is a symmetric encryption key. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - It is automatically generated when you create your first encrypted Premium TiDB instance in a specific region. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - TiDB Cloud creates one key per organization per region, which is shared across all your Premium instances within that region. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - The key is automatically removed only after all data encrypted by it within your organization has been completely deleted | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+36
to
+46
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improve formatting and grammar:
Suggested change
References
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Limitations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Currently, this feature only supports AWS KMS and Alibaba Cloud KMS. Support for Azure Key Vault will be available soon. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Data encryption applies to TiKV, CDC, and BR components. Support for TiFlash data encryption is coming soon. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Once Dual-layer Data Encryption is enabled, the encryption properties of the {{{ .premium }}} instance cannot be modified. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Custom encryption algorithms are not supported. Additionally, you can only rotate the KMS master key; rotation of other keys is not supported. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Your cloud provider KMS key must reside in the same region as your TiDB instance. Consequently, cross-region restore operations are not supported for CMEK-encrypted backups. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Enable and Manage Encryption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use sentence case for headings as per the repository style guide.
Suggested change
References
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Enable encryption during instance creation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| You can enable Dual-layer Data Encryption when creating a new {{{ .premium }}} instance. Depending on your security compliance and maintenance requirements, you can choose between two key management options: **Customer-Managed Encryption Key (CMEK)** or **Service-Managed Encryption Key**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Option 1: Customer-Managed Encryption Key (CMEK) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| To use your own encryption key, follow these steps: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Step 1. Create a symmetric encryption key in your Cloud Provider KMS (Preparation)** | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Before proceeding, you must create a symmetric encryption key in your cloud provider KMS. Ensure the key resides in the **same region** as your planned TiDB service. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - For AWS, see [Create a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-symmetric-cmk.html). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - For Alibaba Cloud, see [Understanding KMS keys](https://www.alibabacloud.com/help/en/kms/key-management-service/user-guide/overview-of-key-management). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Step 2. Configure CMEK in TiDB Cloud** | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 1. On the **My TiDB** page, click **Create Resource**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2. Select the {{{ .premium }}} plan and complete the basic instance configuration. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3. In **Dual-Layer Data Encryption** section, click **Enable**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 4. Select **Customer-Managed Encryption Key (CMEK)** and click **Add KMS Key ARN**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 5. Copy the displayed JSON policy statement. This policy statement defines the required key access permissions for TiDB Cloud. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 6. In your cloud provider KMS Console, append this policy statement to your key policy. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - For AWS, refer to [Key policies in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - For Alibaba Cloud, refer to [Manage Keys](https://www.alibabacloud.com/help/en/kms/key-management-service/user-guide/manage-keys-2). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 7. Return to the TiDB Cloud console, scroll to the bottom of the key creation page, and enter the **KMS Key ARN** obtained from your cloud provider KMS. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 8. Click **Test and Add KMS Key ARN** to verify the key access configuration. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 9. Once the verification passes, click **Create** to finish creating your {{{ .premium }}} instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+62
to
+84
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improve step formatting and heading style:
#### Option 1: Customer-managed encryption key (CMEK)
To use your own encryption key, follow these steps:
1. Create a symmetric encryption key in your cloud provider's KMS.
The key must reside in the **same region** as your planned TiDB service.
- For AWS, see [Create a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-symmetric-cmk.html).
- For Alibaba Cloud, see [Understanding KMS keys](https://www.alibabacloud.com/help/en/kms/key-management-service/user-guide/overview-of-key-management).
2. Configure CMEK in TiDB Cloud:
1. On the **My TiDB** page, click **Create Resource**.
2. Select the {{{ .premium }}} plan and complete the basic instance configuration.
3. In the **Dual-Layer Data Encryption** section, click **Enable**.
4. Select **Customer-Managed Encryption Key (CMEK)** and click **Add KMS Key ARN**.
5. Copy the displayed JSON policy statement. This policy statement defines the required key access permissions for TiDB Cloud.
6. In your cloud provider's KMS console, append this policy statement to your key policy.
- For AWS, refer to [Key policies in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html).
- For Alibaba Cloud, refer to [Manage Keys](https://www.alibabacloud.com/help/en/kms/key-management-service/user-guide/manage-keys-2).
7. Return to the TiDB Cloud console, scroll to the bottom of the key creation page, and enter the **KMS Key ARN** obtained from your cloud provider's KMS.
8. Click **Test and Add KMS Key ARN** to verify the key access configuration.
9. Once the verification passes, click **Create** to finish creating your {{{ .premium }}} instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Option 2: Service-Managed Encryption Key | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use sentence case for headings as per the repository style guide.
Suggested change
References
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| To let TiDB Cloud automatically manage the encryption key for you, follow these steps: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 1. On the **My TiDB** page, click **Create Resource**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2. Select the {{{ .premium }}} plan and complete the basic instance configuration. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3. In **Dual-Layer Data Encryption** section, click **Enable**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 4. Select **Service-Managed Encryption Key**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 5. Click **Create** to finish creating your {{{ .premium }}} instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Enable Encryption for an existing instance | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use sentence case for headings as per the repository style guide.
Suggested change
References
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| If you did not enable encryption during cluster creation, you can still enable it later. Depending on your requirements, you can choose between a Customer-Managed Encryption Key (CMEK) or a Service-Managed Encryption Key. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| > **Note:** | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| > | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| > Enable Encryption on an existing instance requires some time to complete the activation process. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+100
to
+102
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use the gerund form "Enabling encryption" and lowercase "encryption" for better readability.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Option 1: Customer-Managed Encryption Key (CMEK) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Before proceeding, ensure you have created a symmetric encryption key in your cloud provider KMS. Then, follow these steps: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 1. On the **Security** page of your {{{ .premium }}} instance, click **Enable** in the Dual-layer Data Encryption section. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2. Select **Customer-Managed Encryption Key (CMEK)** and click **Add KMS Key ARN**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3. Copy the displayed JSON policy statement. This policy statement defines the required key access permissions for TiDB Cloud. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 4. In your cloud provider KMS console, append this policy statement to your key policy.. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - For AWS, refer to [Key policies in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - For Alibaba Cloud, refer to [Manage Keys](https://www.alibabacloud.com/help/en/kms/key-management-service/user-guide/manage-keys-2). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 5. Return to the TiDB Cloud console, scroll to the bottom of the page, and enter the **KMS Key ARN** obtained from your cloud provider KMS. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 6. Click **Test and Add KMS Key ARN** to verify the key access configuration. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 7. Click **Enable** to enable the Dual-layer Data Encryption feature. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+104
to
+116
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improve formatting and heading style:
Suggested change
References
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Option 2: Service-Managed Encryption Key | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| To let TiDB Cloud automatically manage the encryption key for you, follow these steps: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 1. On the Security page of your {{{ .premium }}} instance, click **Enable** in the Dual-layer Data Encryption section. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2. Select **Service-Managed Encryption Key**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3. Click **Enable**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+118
to
+123
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improve formatting and heading style:
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### View encryption status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Once encryption is enabled, you can verify its status and configuration details in the following two places: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Check the **Encryption** property on the **Overview** page of the instance to see the active key management method (either **Enabled with Customer-Managed Encryption Key (CMEK)** or **Enabled with Service-Managed Encryption Key**). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Navigate to the Security page to view the detailed configuration properties of your Dual-layer Data Encryption. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+125
to
+129
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improve formatting:
Suggested change
References
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Restore from an encrypted backup | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Backups generated from an encrypted {{{ .premium }}} instance are also encrypted. When restoring such a backup to a new instance, the restored instance must maintain consistent encryption properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Customer-Managed Encryption Key (CMEK) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| If the backup is encrypted using a CMEK, you must verify that the new instance can correctly access the KMS master key during the restore process: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 1. The key ARN will remain unchanged. Click **Check** to proceed with the key access verification. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2. The system will check if the authorized TiDB Cloud account in the key policy matches the one associated with the original backup. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3. If the TiDB Cloud account in the key policy is the same as the TiDB Cloud account associated with the original backup TiDB instance, no further authorization is required | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 4. If the TiDB Cloud account in the key policy is different from the TiDB Cloud account associated with the original backup TiDB instance, you must copy the provided key policy and update it in your cloud provider KMS. This re-authorizes the key and ensures the new instance can access it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+135
to
+142
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improve formatting and heading style:
Suggested change
References
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Service-Managed Encryption Key | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use sentence case for headings as per the repository style guide.
Suggested change
References
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| If the backup is encrypted using a Service-Managed Encryption Key, the restored instance will automatically inherit the same key type. During the restore process, you will see that encryption is enabled by default and the key type is set to **Service-Managed Encryption Key**. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Rotate Customer-Managed Encryption Key (CMEK) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use sentence case for headings as per the repository style guide.
Suggested change
References
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| You can configure automatic CMEK rotation in your cloud provider KMS. No configuration updates are required in TiDB Cloud. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - For AWS, see [automatic CMEK rotation](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - For Alibaba Cloud, see [Key rotation](https://www.alibabacloud.com/help/en/kms/key-management-service/user-guide/configure-key-rotation). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use sentence case for headings as per the repository style guide.
References
## Configure the cluster). (link)