-1. Open the **Import** page for your target cluster.
+1. Open the **Import & Export** page for your target cluster, log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project.
- 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project.
+ > **Tip:**
+ >
+ > If you have multiple projects, you can click in the lower-left corner and switch to another project.
- > **Tip:**
- >
- > If you have multiple projects, you can click in the lower-left corner and switch to another project.
+2. Click the name of your target cluster to go to its overview page, and then click **Import & Export** in the left navigation pane.
- 2. Click the name of your target cluster to go to its overview page, and then click **Import** in the left navigation pane.
+3. On the **Import & Export** page, click **Export** to view the export task list.
-2. Cancel the export task. On the **Import** page:
+4. Choose the export task you want to cancel, and then click **Action** button.
- - Click **Export** to view the export task list.
- - Choose the export task you want to cancel, and then click **Action** button.
- - Choose **Cancel** in the drop-down list, note that you can only cancel the export task that is in the **Running** status.
+5. Choose **Cancel** in the drop-down list. Note that you can only cancel the export task that is in the **Running** status.
diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/serverless-external-storage.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/serverless-external-storage.md
index 8439161f..6c96c123 100644
--- a/markdown-pages/en/tidbcloud/master/tidb-cloud/serverless-external-storage.md
+++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/serverless-external-storage.md
@@ -1,15 +1,17 @@
---
-title: Configure TiDB Cloud Serverless external storage access
+title: Configure TiDB Serverless External Storage Access
summary: Learn how to configure Amazon Simple Storage Service (Amazon S3) access, Google Cloud Storage (GCS) access and Azure Blob Storage access.
---
-# Configure TiDB Cloud Serverless external storage access
+# Configure External Storage Access for TiDB Serverless
-If you want import data from or export data to external storage in TiDB Cloud Serverless, you need to configure cross-account access. This document describes how to configure access to external storage, such as Amazon Simple Storage Service (Amazon S3), Google Cloud Storage (GCS) and Azure Blob Storage for TiDB Cloud Serverless.
+If you want import data from or export data to external storage in TiDB Serverless, you need to configure cross-account access. This document describes how to configure access to an external storage, including Amazon Simple Storage Service (Amazon S3), Google Cloud Storage (GCS) and Azure Blob Storage for TiDB Serverless.
+
+If you need to configure these external storages for TiDB Dedicated, see [Configure Amazon S3 Access and GCS Access for TiDB Dedicated](/tidb-cloud/config-s3-and-gcs-access.md).
## Configure Amazon S3 access
-To allow TiDB Cloud Serverless to access your Amazon S3 bucket, you need to configure the bucket access for TiDB Cloud Serverless. You can use either of the following methods to configure the bucket access:
+To allow TiDB Serverless to access your Amazon S3 bucket, you need to configure the bucket access for TiDB Serverless. You can use either of the following methods to configure the bucket access:
- Use an AWS access key: use the access key of an IAM user to access your Amazon S3 bucket.
- Use a Role ARN: use a Role ARN to access your Amazon S3 bucket.
@@ -17,7 +19,139 @@ To allow TiDB Cloud Serverless to access your Amazon S3 bucket, you need to conf
+It is recommended that you use AWS CloudFormation to create a role ARN.
+
+Take the following steps to create one:
+
+1. Open the **Import & Export** page for your target cluster.
+
+ 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project.
+
+ 2. Click the name of your target cluster to go to its overview page, and then click **Import & Export** in the left navigation pane.
+
+2. Open the `Add New ARN` pop-up window.
+
+ 1. Click **Import from S3** or **Export to Amazon S3** according to your needs.
+
+ 2. Fill in the `Folder URI` or `File URI` according to the instructions.
+
+ 3. Choose **AWS Role ARN** and click **Click here to create new one with AWS CloudFormation** to open the `Add New ARN` pop-up window.
+
+3. Create a role ARN with AWS CloudFormation Template.
+
+ 1. Click **AWS Console with CloudFormation Template** in the `Add New ARN` pop-up window.
+
+ 2. Log in to the AWS and you will be redirected to the AWS CloudFormation Template page.
+
+ 3. Fill in the `Role Name`.
+
+ 4. Acknowledge to create a new role and click **Create stack** to create the role ARN.
+
+ 5. After the CloudFormation stack is executed, you can find the Role ARN value in the `outputs` tab.
+
+ 
+
+
+
+
+
+If you have any trouble creating a role ARN with AWS CloudFormation, you can create one manually.
+
+Take the following steps to create one:
+
+1. In the `Add New ARN` pop-up window described in the previous section, click **Having trouble? Create Role ARN manually. You will get the `TiDB Cloud Account ID` and `TiDB Cloud External ID`.
+
+2. In the AWS Management Console, create a managed policy for your Amazon S3 bucket.
+
+ 1. Sign in to the AWS Management Console and open the Amazon S3 console at [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/).
+ 2. In the **Buckets** list, choose the name of your bucket with the source data, and then click **Copy ARN** to get your S3 bucket ARN (for example, `arn:aws:s3:::tidb-cloud-source-data`). Take a note of the bucket ARN for later use.
+
+ 
+
+ 3. Open the IAM console at [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/), click **Policies** in the navigation pane on the left, and then click **Create Policy**.
+
+ 
+
+ 4. On the **Create policy** page, click the **JSON** tab.
+ 5. Copy the following access policy template and paste it to the policy text field.
+
+ ```json
+ {
+ "Version": "2012-10-17",
+ "Statement": [
+ {
+ "Sid": "VisualEditor0",
+ "Effect": "Allow",
+ "Action": [
+ "s3:GetObject",
+ "s3:GetObjectVersion",
+ "s3:PutObject"
+ ],
+ "Resource": "//*"
+ },
+ {
+ "Sid": "VisualEditor1",
+ "Effect": "Allow",
+ "Action": [
+ "s3:ListBucket",
+ "s3:GetBucketLocation"
+ ],
+ "Resource": ""
+ }
+ ]
+ }
+ ```
+
+ In the policy text field, update the following configurations to your own values.
+
+ - `"Resource": "//*"`
+
+ For example, if your source data is stored in the root directory of the `tidb-cloud-source-data` bucket, use `"Resource": "arn:aws:s3:::tidb-cloud-source-data/*"`. If your source data is stored in the `mydata` directory of the bucket, use `"Resource": "arn:aws:s3:::tidb-cloud-source-data/mydata/*"`. Make sure that `/*` is added to the end of the directory so TiDB Cloud can access all files in this directory.
+
+ - `"Resource": ""`
+
+ For example, `"Resource": "arn:aws:s3:::tidb-cloud-source-data"`.
+
+ - If you have enabled AWS Key Management Service key (SSE-KMS) with customer-managed key encryption, make sure the following configuration is included in the policy. `"arn:aws:kms:ap-northeast-1:105880447796:key/c3046e91-fdfc-4f3a-acff-00597dd3801f"` is a sample KMS key of the bucket.
+
+ ```
+ {
+ "Sid": "AllowKMSkey",
+ "Effect": "Allow",
+ "Action": [
+ "kms:Decrypt"
+ ],
+ "Resource": "arn:aws:kms:ap-northeast-1:105880447796:key/c3046e91-fdfc-4f3a-acff-00597dd3801f"
+ }
+ ```
+
+ If the objects in your bucket have been copied from another encrypted bucket, the KMS key value needs to include the keys of both buckets. For example, `"Resource": ["arn:aws:kms:ap-northeast-1:105880447796:key/c3046e91-fdfc-4f3a-acff-00597dd3801f","arn:aws:kms:ap-northeast-1:495580073302:key/0d7926a7-6ecc-4bf7-a9c1-a38f0faec0cd"]`.
+
+ 6. Click **Next: Tags**, add a tag of the policy (optional), and then click **Next:Review**.
+
+ 7. Set a policy name, and then click **Create policy**.
+
+3. In the AWS Management Console, create an access role for TiDB Cloud and get the role ARN.
+
+ 1. In the IAM console at [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/), click **Roles** in the navigation pane on the left, and then click **Create role**.
+
+ 
+
+ 2. To create a role, fill in the following information:
+
+ - Under **Trusted entity type**, select **AWS account**.
+ - Under **An AWS account**, select **Another AWS account**, and then paste the TiDB Cloud account ID to the **Account ID** field.
+ - Under **Options**, click **Require external ID (Best practice when a third party will assume this role)**, and then paste the TiDB Cloud External ID to the **External ID** field. If the role is created without "Require external ID", once the configuration is done for one TiDB cluster in a project, all TiDB clusters in that project can use the same Role ARN to access your Amazon S3 bucket. If the role is created with the account ID and external ID, only the corresponding TiDB cluster can access the bucket.
+
+ 3. Click **Next** to open the policy list, choose the policy you just created, and then click **Next**.
+ 4. Under **Role details**, set a name for the role, and then click **Create role** in the lower-right corner. After the role is created, the list of roles is displayed.
+ 5. In the list of roles, click the name of the role that you just created to go to its summary page, and then you can get the role ARN.
+
+ 
+
+
+
It is recommended that you use an IAM user (instead of the AWS account root user) to create an access key.
@@ -39,15 +173,15 @@ Take the following steps to configure an access key:
## Configure GCS access
-To allow TiDB Cloud Serverless to access your GCS bucket, you need to configure the GCS access for the bucket. You can use service account key to configure the bucket access:
+To allow TiDB Serverless to access your GCS bucket, you need to configure the GCS access for the bucket. You can use service account key to configure the bucket access:
Take the following steps to configure a service account key:
1. Create a service account with needed permission in the Google Cloud [service account page](https://console.cloud.google.com/iam-admin/serviceaccounts). For more information, see [Creating a service account](https://cloud.google.com/iam/docs/creating-managing-service-accounts).
1. Enter a service account name.
- 2. Optional: Enter a description of the service account.
+ 2. Enter a description of the service account (Optional).
3. Click **CREATE AND CONTINUE** to create the service account and continue the next step.
- 4. In the `Grant this service account access to project`, choose the [IAM roles](https://cloud.google.com/iam/docs/understanding-roles) with needed permission. For example, TiDB Cloud Serverless export needs a role with `storage.objects.create` permission.
+ 4. In the `Grant this service account access to project`, choose the [IAM roles](https://cloud.google.com/iam/docs/understanding-roles) with needed permission. For example, TiDB Serverless export needs a role with `storage.objects.create` permission.
5. Click **Continue** to the next step.
6. Optional: In the `Grant users access to this service account`, choose members that need to [attach the service account to other resources](https://cloud.google.com/iam/docs/attach-service-accounts).
7. Click **Done** to finish creating the service account.
@@ -62,27 +196,28 @@ Take the following steps to configure a service account key:
4. Open the downloaded JSON file and encode the content with base64. For example, you can use the following command to encode the content in the macOS terminal:
-```bash
-base64 -i gcp-xxx.json
-```
+ ```bash
+ base64 -i gcp-xxx.json
+ ```
## Configure Azure Blob access
-To allow TiDB Cloud Serverless to access your Azure Blob container, you need to configure the Azure Blob access for the container. You can use service SAS token to configure the container access:
+To allow TiDB Serverless to access your Azure Blob container, you need to configure the Azure Blob access for the container. You can use service SAS token to configure the container access:
Take the following steps to configure a service SAS token:
-1. Click your storage account where the container belong to in the [Azure storage account](https://portal.azure.com/#browse/Microsoft.Storage%2FStorageAccounts) page.
+1. Click your storage account where the container belongs to in the [Azure storage account](https://portal.azure.com/#browse/Microsoft.Storage%2FStorageAccounts) page.
+
2. In your `storage account` page, click the **Security+network** and then click the **Shared access signature**.
-3. In the `Shared access signature` page, create a service SAS token with needed permission. For more information, see [Create a service SAS token](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview).
- 1. Choose the `Blob` service under the `Allowed services` section.
- 2. Choose the `Container` and `Object` under the `Allowed Resource types` section.
- 3. Choose the permission under the `Allowed permissions` section as you needed. For example: TiDB Cloud Serverless exports needs `Read` and `Write` permission.
- 4. Adjust the `Start and expiry date/time` as you needed.
- 5. You can keep other settings as default.
+3. In the `Shared access signature` page, create a service SAS token with needed permissions as follows. For more information, see [Create a service SAS token](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview).
+ 1. Choose the `Blob` service under the `Allowed services` section.
+ 2. Choose the `Container` and `Object` under the `Allowed Resource types` section.
+ 3. Choose the permission under the `Allowed permissions` section as you needed. For example: TiDB Serverless exports needs `Read` and `Write` permission.
+ 4. Adjust the `Start and expiry date/time` as you needed.
+ 5. You can keep other settings as default.
