--- title: "TiDB Cloud Dedicated Workshop" version: "v2" status: "PLACEHOLDER" description: "WIP" --- # TiDB Cloud Dedicated Workshop ## Overview This workshop contains a collection of hands-on labs and tasks to help you gain an understanding of TiDB Cloud Dedicated features. ### Tasks + Creating `TiDB Cloud Dedicated` Cluster and Pausing and Resuming your cluster + Connecting to `TiDB Cloud Dedicated` Cluster + Backing up `TiDB Cloud Dedicated` Cluster + Scaling `TiDB Cloud Dedicated` Cluster + Importing Data into `TiDB Cloud Dedicated` Cluster ### Duration + This lab should take you approximately 120 minutes to complete. > [!TIP] > Once the lab environment is deployed, click **Next** on the bottom bar to begin **Module 1**. ## Module 1: Join the `PE Lab Dedicated Pool` organization ### Step 1. Check your mailbox + In your email inbox, find the invitation email sent by TiDB Cloud. Click `Accept` in the email to join the `PE Lab Dedicated Pool` organization. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_Accept_the_Invitation01.png) ### Step 2. Join the workshop TiDB Cloud organization + After clicking "Accept," you'll be directed to the next page where you should log in to your TiDB Cloud account. If you don't already have a TiDB Cloud account, you can click "Sign Up" to create one. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_Accept_the_Invitation02.png) + After logging into your TiDB Cloud account, please confirm your organization and project + Your organization name should be `PE Lab Dedicated Pool`. + Your project should be `project-0xx` (`xx` are two-digit random number). ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_Confirm_Organization_and_Project01.png) + If your organization and project are different from the description above or follow this [link](https://tidbcloud.com/console/clusters?orgId=1372813089209246378) to access the organization and project. + Click `Organizations` name in the lower-left corner, switch to the `PE Lab Dedicated Pool` organization. + Click `Projects` name in the lower-left corner, switch to the `project-0xx` project. ## Module 2: Creating `TiDB Cloud Dedicated` Cluster and Pausing and Resuming your cluster ### Step 1. On the `Clusters` page, click `Create Cluster`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreateTier_aa_002_20230110.png) ### Step 2. On the `Create Cluster` page, select `Dedicated` and then choose a cloud provider and a region. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreateDedicatedTierSetup01_aa_003_20230110.png) ### Step 3. Configure the cluster size for TiDB, TiKV, and TiFlash (optional) respectively. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreateDedicatedTierSetup02_aa_003_20230110.png) ### Step 4. Update the default cluster name and port number if necessary. + If this is the first cluster of your current project and CIDR has not been configured for this project, you need to set the project CIDR. If you do not see the Project CIDR field, it means that CIDR has already been configured for this project. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreateDedicatedTierSetup03_aa_003_20230110.png) ### Step 7. Wait for your TiDB Cloud cluster to be created. ### Step 8. Click drop-down menu in the upper-right corner, and then click `Pause`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_PauseCluster01_aa_002_20230110.png) ### Step 9. Pause the cluster. + In the `Pause your cluster` window, you can view the changes in cost and cluster functionality when a cluster is paused, and then click `Pause`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_PauseCluster02_aa_002_20230110.png) ### Step 10. The cluster state changes from `AVAILABLE` to `PAUSED`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_PauseCluster03_aa_002_20230110.png) ### Step 11. Click drop-down menu in the upper-right corner, and then click `Resume`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ResumeCluster01_aa_002_20230110.png) ### Step 12. In the `Resume your cluster` window, click `Resume`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ResumeCluster02_aa_002_20230110.png) ### Step 13. Wait for your TiDB Cloud cluster to be resumed. ## Module 3: Connecting to `TiDB Cloud Dedicated` Cluster by Standard Connection ### Step 1. Go to overview page. + On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. Go to security settings. + On the `Overview` page, Click drop-down menu in the upper-right corner, and then click `Security Settings`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SecuritySettings01_aa_002_20230113.png) ### Step 3. In `Security Settings` window, set your `Root Password`, then click `Apply`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SecuritySettings02_aa_002_20230113.png) ### Step 4. Back to the `Overview` page, click `Connect` in the upper-right corner. ### Step 5. In the Connect setting window, click one of the buttons to add some rules, then set the `IP Address` and `Description(Optional)`, and then click `Update Filter` to confirm the changes. If the `traffic filter` is already set, you can edit it or skip this step. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectToDedicatedTier02_aa_002_20230111.png) ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectToDedicatedTier03_aa_002_20230111.png) ### Step 6. Click `Download TiDB cluster CA` for TLS connection to TiDB clusters. The TiDB cluster CA supports TLS 1.2 version by default. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectToDedicatedTier04_aa_002_20230111.png) ### Step 7. Choose a connection method, and then connect to your cluster with the connection string. Note that you need to use the path of the downloaded CA file as the argument of the `--ssl-ca` option in the connection string. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectToDedicatedTier05_aa_002_20230111.png) ## Module 4: Connecting to `TiDB Cloud Dedicated` Cluster by VPC Peering ### Step 1. Get the `VPC ID`、`VPC CIDR` from the VPC dashboard. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetVPC_aa_001_20230111.png) ### Step 2. In the lower-left of the web console, click your project name (`default project` in our case), then switch to your target project, and click `Project Settings`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ProjectSettings_aa_002_20231107.png) ### Step 3. On the `Project Settings` page of your project, click `Network Access` in the left navigation pane, and then click the `Project CIDR` tab，then click `Add`. ### Step 4. Choose AWS as the Cloud provider, and then provide the information of your existing AWS VPC. (TiDB Cloud only supports VPC peering in the same region for the same project) ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetVPCPeering01_aa_002_20230111.png) ### Step 5. Click `Done`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetVPCPeering02_aa_002_20230111.png) ### Step 6. On the `AWS VPC Peerings` section, verify the `AWS VPC Peerings` state is `system checking`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetVPCPeering03_aa_002_20230111.png) ### Step 7. On your AWS console, open the `Peering Connections` page, you will find a peering connection is in the `Pending acceptance` status. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetVPCPeering04_aa_001_20230111.png) ### Step 8. Make sure that the requester owner is TiDB Cloud and click `Accept request`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetVPCPeering05_aa_001_20230111.png) ### Step 9. Open the `Route tables` page and add the `Destination` and `Target`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetVPCPeering06_aa_001_20230111.png) ### Step 10. Make sure you have enabled private DNS hosted zone support for your VPC. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetVPCPeering07_aa_001_20230111.png) ### Step 11. On the TiDB Cloud console, on the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 12. On the `Overview` page, click `Connect` in the upper-right corner. ### Step 13. In the Connect setting window, select the `VPC Peering`. You could see the `Status` of the VPC peering is `active`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectByVPC01_aa_002_20230112.png) ### Step 14. Use a SQL client to connect to TiDB. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectByVPC02_aa_002_20230112.png) ## Module 5: Connecting to `TiDB Cloud Dedicated` Cluster by Private Endpoint ### Step 1. In the lower-left of the web console, click your project name (`default project` in our case), then switch to your target project, and click `Project Settings`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ProjectSettings_aa_002_20231107.png) ### Step 2. On the `Project Settings` page of your project, click `Network Access` in the left navigation pane, and then click the `Private Endpoint` tab, then click `Add`. ### Step 3. On the `Select Cluster` section, Click the drop-down list and choose an available TiDB cluster, and then click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePrivateEndpoint01_aa_002_20230301.png) ### Step 4. On the `Select Region` section, the service endpoint region is selected by default. Have a quick check and click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePrivateEndpoint02_aa_002_20230301.png) ### Step 5. On the `Interface Endpoint` section, TiDB Cloud begins creating an endpoint service, which takes 3 to 4 minutes. When the endpoint service is created, take a note of your endpoint service name from the command in the lower area of the console, and then click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePrivateEndpoint03_aa_002_20230301.png) ### Step 6. On your AWS console, open the `VPC dashboard`, then go to the `Endpoints` page. ### Step 7. On the `Endpoints` page, click `Create Endpoint`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePrivateEndpoint04_aa_001_20230301.png) ### Step 8. On the `Create endpoint` page, select `Other endpoint services`, enter the endpoint service name on `Service settings` section, and then click `Verify service` to verify your endpoint service name, ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePrivateEndpoint05_aa_001_20230301.png) ### Step 9. On the `VPC` section, select your VPC in the drop-down list, and select the availability zones where your TiDB cluster is located on the `Subnets` session. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePrivateEndpoint06_aa_001_20230301.png) ### Step 10. On the `Security groups` section, select your security group properly, then click `Create endpoint`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePrivateEndpoint07_aa_001_20230301.png) ### Step 11. Get the `VPC endpoint ID` of your Endpoints. Then go back to the TiDB Cloud console, fill in the box with your `VPC endpoint ID` on the `Accept Endpoint Connection` section, and then click `Next`. ### Step 12. On your AWS console, right-click your endpoint ID and select `Modify private DNS name`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePrivateEndpoint09_aa_001_20230301.png) ### Step 13. On the `Modify private DNS name` page, select the `Enable for this endpoint` check box, then click `Save changes`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePrivateEndpoint10_aa_001_20230301.png) ### Step 14. On TiDB Cloud console console, click `Create` on `Enable Your Endpoint Private DNS` section. ### Step 15. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 16. On the `Overview` page, click `Connect` in the upper-right corner. ### Step 17. In the connect setting window, select the `Private Endpoint`. The private endpoint you just created is displayed under `Step 1: Create Private Endpoint`. ### Step 18. Use a SQL client to connect to TiDB. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectByEndpoint_aa_002_20230112.png) ## Module 6: Connecting to `TiDB Cloud Dedicated` Cluster by SQL Shell ### Step 1. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. On the `Overview` page, click `Connect` in the upper-right corner. ### Step 3. In the Connect setting window, select the `Web SQL Shell`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectByWebSQLShell01_aa_002_20230112.png) ### Step 4. Click `Open SQL Shell`, enter the password of the cluster, and hit `Enter`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectByWebSQLShell02_aa_002_20230112.png) ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConnectByWebSQLShell03_aa_001_20230112.png) ## Module 7: Automatic Backing up `TiDB Cloud Dedicated` Cluster ### Step 1. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. Click the `Backup` in the left navigation pane. ### Step 3. On the `Backup` page, click `Backup Settings`. ### Step 4. Configure the automatic backup, and then click `Confirm`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_BackupSettings_aa_002_20230119.png) ## Module 8: Manual Backing up `TiDB Cloud Dedicated` Cluster ### Step 1. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. Click the `Backup` in the left navigation pane. ### Step 3. On the `Backup` page, click `Manual Backup`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ManualBackup01_aa_002_20230119.png) ### Step 4. Enter the `Name`, and then click `Confirm`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ManualBackup_aa_002_20230119.png) ## Module 9: Restoring a Deleted `TiDB Cloud Dedicated` Cluster ### Step 1. In the lower-left of the web console, click your project name (`default project` in our case), then switch to your target project, and click `Project Settings`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ProjectSettings_aa_002_20231107.png) ### Step 2. On the `Project Settings` page of your project, click `Recycle Bin` in the left navigation pan. ### Step 3. Select a backup of your cluster, click `Backups`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SelectBackup_aa_002_20230119.png) ### Step 4. On the next screen click `Restore`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_RestoreBackup_aa_002_20230119.png) ### Step 5. In the `Restore` window, edit your cluster configuration, and then click the `Confirm`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConfigureBackup_aa_002_20230119.png) ### Step 6. Wait for your TiDB Cloud cluster to be restored. (approximately 10 to 30 minutes) ## Module 10: Restore Data to a New `TiDB Cloud Dedicated` Cluster ### Step 1. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. Click the `Backup` in the left navigation pane. ### Step 3. On the `Backup` page, click `Restore`. ### Step 4. In `Restore Mode` section, choose to restore data of any point in time or a selected backup to a new cluster. In `Restore to Region` section, choose a region. In `Restore to New Cluster` section, enter a name and port number for your cluster. Then click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConfigureBackupNewCluster01_aa_002_20230119.png) ### Step 5. In the `Cluster Size` section, you can increase the node size, node quantity, and node storage for the cluster. Then click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConfigureBackupNewCluster02_aa_002_20230119.png) ### Step 6. Go through the detailed configuration of your cluster, and then click `Restore`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConfigureBackupNewCluster03_aa_002_20230119.png) ### Step 7. Wait for your TiDB Cloud cluster to be restored. (approximately 10 to 30 minutes) ## Module 11: Deleting `TiDB Cloud Dedicated` Cluster Backup ### Step 1. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. Click the `Backup` in the left navigation pane. ### Step 3. On the `Backup` page, click `Delete` to delete the backup. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_DeleteClusterBackup_aa_002_20230119.png) ### Step 4. In the `Delete Backup` window, click `I understand the consequence, delete this backup`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConfirmDeleteBackup_aa_002_20230119.png) ## Module 12: Delete backup from `Recycle Bin` ### Step 1. In the lower-left of the web console, click your project name (`default project` in our case), then switch to your target project, and click `Project Settings`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ProjectSettings_aa_002_20231107.png) ### Step 2. On the `Project Settings` page of your project, click `Recycle Bin` in the left navigation pan. ### Step 3. Select a backup of your cluster, click `Backups`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SelectBackup_aa_002_20230119.png) ### Step 4. Click `Delete` to delete the backup. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_DeleteClusterBackup_aa_002_20230119.png) ### Step 5. In the `Delete Backup` window, click `I understand the consequence, delete this backup`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ConfirmDeleteBackup_aa_002_20230119.png) ## Module 13: Scale out `TiDB Cloud Dedicated` cluster ### Step 1. Click drop-down menu in the upper-right corner, and then select `Modify`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoModify_aa_002_20230119.png) ### Step 2. In the `Modify Cluster` window, you can increase the Node quantity of TiDB, TiKV, and TiFlash. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ScaleOutCloudCluster01_aa_002_20230119.png) ### Step 3. Review the cluster size in the right pane, and then click `Confirm`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ScaleOutCloudCluster02_aa_002_20230119.png) ### Step 4. Wait for your TiDB Cloud cluster to scale out. ## Module 14: Scale in `TiDB Cloud Dedicated` cluster ### Step 1. Click drop-down menu in the upper-right corner, and then select `Modify`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoModify_aa_002_20230119.png) ### Step 2. In the `Modify Cluster` window, you can decrease the Node quantity of TiDB, TiKV,nd TiFlash. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ScaleOutCloudCluster01_aa_002_20230119.png) ### Step 3. Review the cluster size in the right pane, and then click `Confirm`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ScaleInCloudCluster02_aa_004_20230119.png) ### Step 4. Wait for your TiDB Cloud cluster to scale in. ## Module 15: Scale up `TiDB Cloud Dedicated` cluster ### Step 1. Click drop-down menu in the upper-right corner, and then select `Modify`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoModify_aa_002_20230119.png) ### Step 2. In the `Modify Cluster` window, you can increase the `Node Storage` of TiKV and TiFlash. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ScaleUpCloudCluster01_aa_002_20230119.png) ### Step 3. Review the cluster size in the right pane, and then click `Confirm`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ScaleUpCloudCluster02_aa_002_20230119.png) ### Step 4. Wait for your TiDB Cloud cluster to scale up. ## Module 16: Change Node Size of `TiDB Cloud Dedicated` cluster ### Step 1. Click drop-down menu in the upper-right corner, and then select `Modify`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoModify_aa_002_20230119.png) ### Step 2. In the `Modify Cluster` window, you can increase or decrease the size (including vCPUs and memory) of TiDB, TiKV, or TiFlash, and then click `Review`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ChangeNodeCloudCluster01_aa_002_20230613.png) ### Step 3. On the next page, review your modify then click `Confirm and Deploy`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ChangeNodeCloudCluster02_aa_002_20230613.png) ### Step 4. Wait for your TiDB Cloud cluster to change node size. ## Module 17: Preparing Example Data ### Step 1. Clone example data repo to local. ``` $ git clone https://github.com/pingcap/tidb-course-201-lab ``` ### Step 2. Change the working directory. ``` $ cd tidb-course-201-lab/scripts/misc ``` ### Step 3. Verify the all data directories (`universe-csv/`, `universe-dumpling/`, `universe-parquet/`) in the misc directory. ``` universe-csv universe-dumpling universe-parquet ``` + Example CSV data files: ``` universe-schema-create.sql universe.moons-schema.sql universe.moons.csv universe.planets-schema.sql universe.planets.0000001.csv universe.planets.csv universe.planet_categories-schema.sql universe.planet_categories.csv universe.stars-schema.sql universe.stars.csv ``` + Example TiDB Dumpling data files: ``` metadata universe-schema-create.sql universe.moons-schema.sql universe.moons.0000000010000.sql universe.planets-schema.sql universe.planets.0000000010000.sql universe.planet_categories-schema.sql universe.planet_categories.0000000010000.sql universe.stars-schema.sql universe.stars.0000000010000.sql ``` + Example Parquet data files: ``` universe-schema-create.sql universe.moons-schema.sql universe.moons.parquet universe.planets-schema.sql universe.planets.0000001.parquet universe.planets.parquet universe.planet_categories-schema.sql universe.planet_categories.parquet universe.stars-schema.sql universe.stars.parquet ``` ### Step 4. [Open the Amazon S3 console](https://console.aws.amazon.com/s3/), in the `Buckets` section, you can choose or create a bucket to store example data. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ch09-1-05.png) ### Step 5. Click `Upload` to upload all data directories (`universe-csv/`, `universe-dumpling/`, `universe-parquet/`) to the bucket. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ch09-1-06.png) ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ch09-1-07.png) ## Module 18: Importing Local CSV Data into `TiDB Cloud Dedicated` cluster ### Step 1. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. On the `Overview` page, click `Import` in the left navigation pane. ### Step 3. On the `Import` page, you can directly drag and drop your `universe.moons.csv` file to the upload area, or click the upload area to select and upload the `universe.moons.csv` file. Note that you can upload only one CSV file of less than 50 MiB for one task. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportLocalCSVFile01_aa_002_20230223.png) ### Step 4. In the Target area, select the target database and the target table, or enter a name directly to create a new database or a new table, and then click `Preview`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportLocalCSVFile02_aa_002_20230223.png) ### Step 5. On the next page, check the table and edit the CSV configuration if needed, then click `Start Import`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportLocalCSVFile03_aa_002_20230223.png) ### Step 6. Wait for the data to be imported. After the import task is completed, you can click `Explore your data by Chat2Query` to query your imported data. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportLocalCSVFile04_aa_002_20230223.png) ## Module 19: Importing CSV Data from Amazon S3 Bucket into `TiDB Cloud Dedicated` cluster ### Step 1. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. Click the `Import` in the left navigation pane. ### Step 3. On the `Import` page, click `Import Data`. ### Step 4. Choose the `AWS Role ARN`, and click `Guide for getting the required Role-ARN` to get the `TiDB Cloud account ID` and `TiDB Cloud External ID` of your cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetTiDBCloudID_aa_002_20231108.png) ### Step 5. Open the [Amazon S3 console](https://console.aws.amazon.com/s3/) and then click `Buckets`. ### Step 6. Click `Copy ARN` to get your S3 bucket ARN. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetBucketARN_aa_002_20231108.png) ### Step 7. Open the [IAM console](https://console.aws.amazon.com/iam/) and then click `Policies`. ### Step 8. Click `Create Policy`. ### Step 9. On the `Create policy` page, you can choose to click the `Visual editor` tab or click the `JSON` tab. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePolicy01_aa_002_20231108.png) + If you choose the `JSON` tab to create an access policy, you can refer to the following template. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_PolicyJSON_aa_002_20231108.png) ``` { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectVersion" ], "Resource": "/universe-csv/*" }, { "Sid": "VisualEditor1", "Effect": "Allow", "Action": [ "s3:ListBucket", "s3:GetBucketLocation" ], "Resource": "" } ] } ``` ### Step 10. On the next page set the policy `Name` and `Description`, and then click `Create policy`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePolicy02_aa_002_20231108.png) ### Step 11. Open the [IAM console](https://console.aws.amazon.com/iam/), and then click `Roles`. ### Step 12. Click `Create role`. ### Step 13. In the `Trusted entity type` section, choose `AWS account`. Next, in the `An AWS account` section, choose `Another AWS account`, then input the `TiDB Cloud account ID` in `Account ID`. In the `Options` section, click `Require external ID (Best practice when a third party will assume this role)` and then input the `TiDB Cloud External ID` in `External ID`. Click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetSelectTrustedEntity_aa_002_20231108.png) ### Step 14. Choose the policy for the role, and then click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ChoosePolicy_aa_002_20231108.png) ### Step 15. In the `Role details` section, set the `Role name` and `Description`, and then click `Create role`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetRoleDetails_aa_002_20231108.png) ### Step 16. On the `Roles` page, click the name of the role that you just created. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetRolesARN01_aa_002_20231108.png) ### Step 17. Note the value for `ARN`. Write this down, you will need it later. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetRolesARN02_aa_002_20231108.png) ### Step 18. Go back to the [TiDB Cloud Console](https://tidbcloud.com/console/clusters), click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 19. Click the `Import` in the left navigation pane. ### Step 20. On the `Import` page, click `Import Data`. ### Step 21. In the `Source` session, select `CSV` in the `Data format` section and fill in the `Bucket URI` of your example CSV data. In the `Bucket Access` session, choose `AWS Role ARN`, then enter the `Role ARN` you just got. Click `Start Import`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportCSVData_aa_003_20230202.png) ### Step 22. Wait for your data import to finish. After the import task is completed, you can click `Explore your data by Chat2Query` to query your imported data. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportCSVFileChat2Query_aa_002_20231108.png) ## Module 20: Importing SQL File from Amazon S3 Bucket into `TiDB Cloud Dedicated` cluster ### Step 1. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. Click the `Import` in the left navigation pane. ### Step 3. On the `Import` page, click `Import Data`. ### Step 4. Choose the `AWS Role ARN`, and click `Guide for getting the required Role-ARN` to get the `TiDB Cloud account ID` and `TiDB Cloud External ID` of your cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetTiDBCloudID_aa_002_20231108.png) ### Step 5. Open the [Amazon S3 console](https://console.aws.amazon.com/s3/) and then click `Buckets`. ### Step 6. Click `Copy ARN` to get your S3 bucket ARN. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetBucketARN_aa_002_20231108.png) ### Step 7. Open the [IAM console](https://console.aws.amazon.com/iam/) and then click `Policies`. ### Step 8. Click `Create Policy`. ### Step 9. On the `Create policy` page, you can choose to click the `Visual editor` tab or click the `JSON` tab. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePolicy01_aa_002_20231108.png) + If you choose the `JSON` tab to create an access policy, you can refer to the following template. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_PolicyJSON_aa_002_20231108.png) ``` { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectVersion" ], "Resource": "/universe-dumpling/*" }, { "Sid": "VisualEditor1", "Effect": "Allow", "Action": [ "s3:ListBucket", "s3:GetBucketLocation" ], "Resource": "" } ] } ``` ### Step 10. On the next page set the policy `Name` and `Description`, and then click `Create policy`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePolicy02_aa_002_20231108.png) ### Step 11. Open the [IAM console](https://console.aws.amazon.com/iam/), and then click `Roles`. ### Step 12. Click `Create role`. ### Step 13. In the `Trusted entity type` section, choose `AWS account`. Next, in the `An AWS account` section, choose `Another AWS account`, then input the `TiDB Cloud account ID` in `Account ID`. In the `Options` section, click `Require external ID (Best practice when a third party will assume this role)` and then input the `TiDB Cloud External ID` in `External ID`. Click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetSelectTrustedEntity_aa_002_20231108.png) ### Step 14. Choose the policy for the role, and then click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ChoosePolicy_aa_002_20231108.png) ### Step 15. In the `Role details` section, set the `Role name` and `Description`, and then click `Create role`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetRoleDetails_aa_002_20231108.png) ### Step 16. On the `Roles` page, click the name of the role that you just created. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetRolesARN01_aa_002_20231108.png) ### Step 17. Note the value for `ARN`. Write this down, you will need it later. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetRolesARN02_aa_002_20231108.png) ### Step 18. Go back to the [TiDB Cloud Console](https://tidbcloud.com/console/clusters), click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 19. Click the `Import` in the left navigation pane. ### Step 20. On the `Import` page, click `Import Data`. ### Step 21. In the `Source` session, select `SQL File` in the `Data format` section and fill in the `Bucket URI` of your example CSV data. In the `Bucket Access` session, choose `AWS Role ARN`, then enter the `Role ARN` you just got. Click `Start Import`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportSQLData_aa_003_20230202.png) ### Step 22. Wait for your data import to finish. After the import task is completed, you can click `Explore your data by Chat2Query` to query your imported data. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportSQLFileChat2Query_aa_002_20231108.png) ## Module 21: Importing Parquet Data from Amazon S3 Bucket into `TiDB Cloud Dedicated` cluster ### Step 1. On the `Clusters` page, click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 2. Click the `Import` in the left navigation pane. ### Step 3. On the `Import` page, click `Import Data`. ### Step 4. Choose the `AWS Role ARN`, and click `Guide for getting the required Role-ARN` to get the `TiDB Cloud account ID` and `TiDB Cloud External ID` of your cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetTiDBCloudID_aa_002_20231108.png) ### Step 5. Open the [Amazon S3 console](https://console.aws.amazon.com/s3/) and then click `Buckets`. ### Step 6. Click `Copy ARN` to get your S3 bucket ARN. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetBucketARN_aa_002_20231108.png) ### Step 7. Open the [IAM console](https://console.aws.amazon.com/iam/) and then click `Policies`. ### Step 8. Click `Create Policy`. ### Step 9. On the `Create policy` page, you can choose to click the `Visual editor` tab or click the `JSON` tab. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePolicy01_aa_002_20231108.png) + If you choose the `JSON` tab to create an access policy, you can refer to the following template. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_PolicyJSON_aa_002_20231108.png) ``` { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectVersion" ], "Resource": "/universe-parquet/*" }, { "Sid": "VisualEditor1", "Effect": "Allow", "Action": [ "s3:ListBucket", "s3:GetBucketLocation" ], "Resource": "" } ] } ``` ### Step 10. On the next page set the policy `Name` and `Description`, and then click `Create policy`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_CreatePolicy02_aa_002_20231108.png) ### Step 11. Open the [IAM console](https://console.aws.amazon.com/iam/), and then click `Roles`. ### Step 12. Click `Create role`. ### Step 13. In the `Trusted entity type` section, choose `AWS account`. Next, in the `An AWS account` section, choose `Another AWS account`, then input the `TiDB Cloud account ID` in `Account ID`. In the `Options` section, click `Require external ID (Best practice when a third party will assume this role)` and then input the `TiDB Cloud External ID` in `External ID`. Click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetSelectTrustedEntity_aa_002_20231108.png) ### Step 14. Choose the policy for the role, and then click `Next`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ChoosePolicy_aa_002_20231108.png) ### Step 15. In the `Role details` section, set the `Role name` and `Description`, and then click `Create role`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_SetRoleDetails_aa_002_20231108.png) ### Step 16. On the `Roles` page, click the name of the role that you just created. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetRolesARN01_aa_002_20231108.png) ### Step 17. Note the value for `ARN`. Write this down, you will need it later. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GetRolesARN02_aa_002_20231108.png) ### Step 18. Go back to the [TiDB Cloud Console](https://tidbcloud.com/console/clusters), click the name of the cluster to enter the `Overview` page of the cluster. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_GoDedicatedTierOverview_aa_002_20230111.png) ### Step 19. Click the `Import` in the left navigation pane. ### Step 20. On the `Import` page, click `Import Data`. ### Step 21. In the `Source` session, select `Parquet` in the `Data format` section and fill in the `Bucket URI` of your example CSV data. In the `Bucket Access` session, choose `AWS Role ARN`, then enter the `Role ARN` you just got. Click `Start Import`. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportParquetData_aa_003_20230202.png) ### Step 23. Wait for your data import to finish. After the import task is completed, you can click `Explore your data by Chat2Query` to query your imported data. ![80%](https://lab-static.pingcap.com/quick-demo/demo_501_ImportParquetFileChat2Query_aa_002_20230223.png) ## Conclusion TiDB Cloud Dedicated is a fully managed deployment option for TiDB, designed for production environments. It offers isolated resources to enhance performance, security, and control. Key features include: + Flexible Connection Types: Supports Public, Private Endpoint, and VPC Peering connections, with TLS recommended on port 4000 for secure connections. A CA Certificate and IP Access List configuration are required for secure connections. + Advanced Features: Includes Changefeeds, Data Migration, Point-in-Time Recovery (PITR), cross-zone high availability, horizontal scaling, and Hybrid Transactional and Analytical Processing (HTAP) capabilities. + Cloud Hosting: Hosted on cloud providers like AWS and Google Cloud, with support for external storage access for data import and migration from Amazon S3 and Google Cloud Storage (GCS). + Customization and Control: Offers more control and customization over configurations compared to the Serverless tier, making it suitable for users needing features unavailable in the Serverless tier. + Scalability: For data imports exceeding 500 GiB, it is recommended to have at least 16 cores for TiDB nodes and enable global sort, with an import limit of 40 TiB per task. + Management: Managed and configured through the TiDB Cloud Console. For more detailed information, you can refer to the official documentation [What is TiDB Cloud](https://docs.pingcap.com/tidbcloud/tidb-cloud-intro#what-is-tidb-cloud).