Skip to content

[WIP] cloud: update steps according to the new nav pane #21130

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

Open
wants to merge 14 commits into
base: release-8.1
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions tidb-cloud/backup-and-restore-serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ This document describes how to back up and restore your TiDB Cloud Serverless cl
>
> To learn how to back up and restore TiDB Cloud Dedicated cluster data, see [Back Up and Restore TiDB Cloud Dedicated Data](/tidb-cloud/backup-and-restore.md).

## View the Backup page

1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target cluster to go to its overview page.

> **Tip:**
>
> You can use the drop-down box in the upper-left corner to switch between organizations, projects, and clusters.

2. In the left navigation pane, click **Data** > **Backup**.

## Automatic backups

TiDB Cloud Serverless automatically backs up your cluster data, allowing you to restore data from a backup snapshot to minimize data loss in the event of a disaster.
Expand Down Expand Up @@ -39,7 +49,7 @@ Automatic backup settings vary between free clusters and scalable clusters, as s

To set the backup time for a scalable cluster, perform the following steps:

1. Navigate to the **Backup** page of a TiDB Cloud Serverless cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Click **Backup Setting**. This will open the **Backup Setting** window, where you can configure the automatic backup settings according to your requirements.

Expand Down Expand Up @@ -93,7 +103,7 @@ If the data is corrupted after a canceled restore and cannot be recovered, conta

To restore your TiDB Cloud Serverless cluster, follow these steps:

1. Navigate to the **Backup** page of a cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Click **Restore**. The setting window displays.

Expand Down
48 changes: 29 additions & 19 deletions tidb-cloud/backup-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ This document describes how to back up and restore your TiDB Cloud Dedicated clu

## Backup

### View the Backup page

1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target cluster to go to its overview page.

> **Tip:**
>
> You can use the drop-down box in the upper-left corner to switch between organizations, projects, and clusters.

2. In the left navigation pane, click **Data** > **Backup**.

### Turn on auto backup

TiDB Cloud Dedicated supports both [snapshot backup](https://docs.pingcap.com/tidb/stable/br-snapshot-guide) and [log backup](https://docs.pingcap.com/tidb/stable/br-pitr-guide). Snapshot backup enables you to restore data to the backup point. By default, snapshot backups are taken automatically and stored according to your backup retention policy. You can disable auto backup at any time.
Expand All @@ -40,9 +50,9 @@ This feature supports restoring data of any point in time to a new cluster. You

It is strongly recommended to turn on this feature. The cost is the same as snapshot backup. For more information, refer to [Data Backup Cost](https://www.pingcap.com/tidb-dedicated-pricing-details#backup-storage-cost).

To turn on this feature, perform the following steps:
To turn on this feature for your TiDB Cloud Dedicated cluster, perform the following steps:

1. Navigate to the **Backup** page of a TiDB Cloud Dedicated cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Click **Backup Setting**.

Expand All @@ -60,9 +70,9 @@ To turn on this feature, perform the following steps:

TiDB Cloud Dedicated supports daily and weekly backup schedules. By default, the backup schedule is set to daily. You can choose a specific time of the day or week to start snapshot backup.

To configure the backup schedule, perform the following steps:
To configure the backup schedule for your TiDB Cloud Dedicated cluster, perform the following steps:

1. Navigate to the **Backup** page of a TiDB Cloud Dedicated cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Click **Backup Setting**.

Expand Down Expand Up @@ -103,9 +113,9 @@ TiDB Cloud Dedicated supports dual region backup by replicating backups from you

Dual region backup costs include both backup storage usage and cross-region data transfer fees. For more information, refer to [Data Backup Cost](https://www.pingcap.com/tidb-dedicated-pricing-details#backup-storage-cost).

To turn on dual region backup, perform the following steps:
To turn on dual region backup for your TiDB Cloud Dedicated cluster, perform the following steps:

1. Navigate to the **Backup** page of a TiDB Cloud Dedicated cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Click **Backup Setting**.

Expand All @@ -121,9 +131,9 @@ To turn on dual region backup, perform the following steps:
>
> Turning off auto backup will also turn off point-in-time restore by default.

To turn off auto backup, perform the following steps:
To turn off auto backup for your TiDB Cloud Dedicated cluster, perform the following steps:

1. Navigate to the **Backup** page of a TiDB Cloud Dedicated cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Click **Backup Setting**.

Expand All @@ -137,9 +147,9 @@ To turn off auto backup, perform the following steps:
>
> Disabling dual region backup does not immediately delete the backups in the secondary region. These backups will be cleaned up later according to the backup retention schedule. To remove them immediately, you can manually [delete the backups](#delete-backups).

To turn off dual region backup, perform the following steps:
To turn off dual region backup for your TiDB Cloud Dedicated cluster, perform the following steps:

1. Navigate to the **Backup** page of a TiDB Cloud Dedicated cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Click **Backup Setting**.

Expand All @@ -158,7 +168,7 @@ Manual backups are user-initiated backups that enable you to back up your data t

To apply a manual backup to your TiDB Cloud Dedicated cluster, perform the following steps:

1. Navigate to the **Backup** page of a cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. In the upper-right corner, click **...** > **Manual Backup**.

Expand All @@ -170,17 +180,17 @@ To apply a manual backup to your TiDB Cloud Dedicated cluster, perform the follo

#### Delete backup files

To delete an existing backup file, perform the following steps:
To delete an existing backup file for your TiDB Cloud Dedicated cluster, perform the following steps:

1. Navigate to the **Backup** page of a cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Locate the corresponding backup file you want to delete, and click **...** > **Delete** in the **Action** column.

#### Delete a running backup job

To delete a running backup job, it is similar as [**Delete backup files**](#delete-backup-files).
To delete a running backup job for your TiDB Cloud Dedicated cluster, it is similar as [**Delete backup files**](#delete-backup-files).

1. Navigate to the **Backup** page of a cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Locate the running backup job that is in the **Pending** or **Running** state, and click **...** > **Delete** in the **Action** column.

Expand All @@ -194,7 +204,7 @@ To delete a running backup job, it is similar as [**Delete backup files**](#dele

To restore your TiDB Cloud Dedicated cluster data from a backup to a new cluster, take the following steps:

1. Navigate to the **Backup** tab of a cluster.
1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster.

2. Click **Restore**. The setting window displays.

Expand Down Expand Up @@ -248,9 +258,9 @@ To restore your TiDB Cloud Dedicated cluster data from a backup to a new cluster

To restore a deleted cluster from recycle bin, take the following steps:

1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
3. On the **Project Settings** page of your project, click **Recycle Bin** in the left navigation pane, locate the cluster you want to restore, and then click **Backups** in the **Action** column.
1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the drop-down box in the upper-left corner.
2. In the left navigation pane, click **Project Settings** > **Recycle Bin**.
3. On the **Recycle Bin** page, locate the cluster you want to restore, and then click **Backups** in the **Action** column.
4. Locate your desired backup time, and then click **Restore** in the **Action** column.
5. In the **Restore** window, make the following changes if necessary:

Expand Down
17 changes: 8 additions & 9 deletions tidb-cloud/built-in-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,23 @@ TiDB Cloud collects and displays a full set of standard metrics of your cluster

## View the Metrics page

To view the metrics on the Metrics page, take the following steps:
To view the metrics on the **Metrics** page, take the following steps:

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project.
1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target cluster to go to its overview page.

> **Tip:**
>
> If you have multiple projects, you can click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner and switch to another project.
> You can use the drop-down box in the upper-left corner to switch between organizations, projects, and clusters.

2. Click the name of the target cluster. The cluster overview page is displayed.
3. Click **Metrics** in the left navigation pane.
2. In the left navigation pane, click **Monitoring** > **Metrics**.

## Metrics retention policy

For TiDB Cloud Dedicated clusters and TiDB Cloud Serverless clusters, the metrics data is kept for 7 days.

## Metrics for TiDB Cloud Dedicated clusters

The following sections illustrate the metrics on the Metrics page for TiDB Cloud Dedicated clusters.
The following sections illustrate the metrics on the **Metrics** page for TiDB Cloud Dedicated clusters.

### Overview

Expand Down Expand Up @@ -82,10 +81,10 @@ The following sections illustrate the metrics on the Metrics page for TiDB Cloud

## Metrics for TiDB Cloud Serverless clusters

The Metrics page provides two tabs for metrics of TiDB Cloud Serverless clusters:
The **Metrics** page provides two tabs for metrics of TiDB Cloud Serverless clusters:

- Cluster Status: displays the cluster-level main metrics.
- Database Status: displays the database-level main metrics.
- **Cluster Status**: displays the cluster-level main metrics.
- **Database Status**: displays the database-level main metrics.

### Cluster Status

Expand Down
22 changes: 16 additions & 6 deletions tidb-cloud/changefeed-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,17 @@ TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data servic
> - Currently, TiDB Cloud only allows up to 100 table filter rules per changefeed.
> - For [TiDB Cloud Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless), the changefeed feature is unavailable.

To access the changefeed feature, navigate to the cluster overview page of your TiDB cluster, and then click **Changefeed** in the left navigation pane. The changefeed page is displayed.
## View the Changefeed page

To access the changefeed feature, take the following steps:

1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project.

> **Tip:**
>
> You can use the drop-down box in the upper-left corner to switch between organizations, projects, and clusters.

2. Click the name of your target cluster to go to its overview page, and then click **Data** > **Changefeed** in the left navigation pane. The changefeed page is displayed.

On the changefeed page, you can create a changefeed, view a list of existing changefeeds, and operate the existing changefeeds (such as scaling, pausing, resuming, editing, and deleting a changefeed).

Expand All @@ -28,7 +38,7 @@ To create a changefeed, refer to the tutorials:

## Query Changefeed RCUs

1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Changefeed** in the left navigation pane.
1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
2. Locate the corresponding changefeed you want to query, and click **...** > **View** in the **Action** column.
3. You can see the current TiCDC Replication Capacity Units (RCUs) in the **Specification** area of the page.

Expand All @@ -41,7 +51,7 @@ You can change the TiCDC Replication Capacity Units (RCUs) of a changefeed by sc
> - To scale a changefeed for a cluster, make sure that all changefeeds for this cluster are created after March 28, 2023.
> - If a cluster has changefeeds created before March 28, 2023, neither the existing changefeeds nor newly created changefeeds for this cluster support scaling up or down.

1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Changefeed** in the left navigation pane.
1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
2. Locate the corresponding changefeed you want to scale, and click **...** > **Scale Up/Down** in the **Action** column.
3. Select a new specification.
4. Click **Submit**.
Expand All @@ -50,7 +60,7 @@ It takes about 10 minutes to complete the scaling process (during which the chan

## Pause or resume a changefeed

1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Changefeed** in the left navigation pane.
1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
2. Locate the corresponding changefeed you want to pause or resume, and click **...** > **Pause/Resume** in the **Action** column.

## Edit a changefeed
Expand All @@ -59,7 +69,7 @@ It takes about 10 minutes to complete the scaling process (during which the chan
>
> TiDB Cloud currently only allows editing changefeeds in the paused status.

1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Changefeed** in the left navigation pane.
1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
2. Locate the changefeed you want to pause, and click **...** > **Pause** in the **Action** column.
3. When the changefeed status changes to `Paused`, click **...** > **Edit** to edit the corresponding changefeed.

Expand All @@ -74,7 +84,7 @@ It takes about 10 minutes to complete the scaling process (during which the chan

## Delete a changefeed

1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Changefeed** in the left navigation pane.
1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
2. Locate the corresponding changefeed you want to delete, and click **...** > **Delete** in the **Action** column.

## Changefeed billing
Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/changefeed-sink-to-apache-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ To allow TiDB Cloud changefeeds to stream data to Apache Kafka and create Kafka

For example, if your Kafka cluster is in Confluent Cloud, you can see [Resources](https://docs.confluent.io/platform/current/kafka/authorization.html#resources) and [Adding ACLs](https://docs.confluent.io/platform/current/kafka/authorization.html#adding-acls) in Confluent documentation for more information.

## Step 1. Open the changefeed page for Apache Kafka
## Step 1. Open the Changefeed page for Apache Kafka

1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
2. Navigate to the cluster overview page of the target TiDB cluster, and then click **Changefeed** in the left navigation pane.
2. Navigate to the cluster overview page of the target TiDB cluster, and then click **Data** > **Changefeed** in the left navigation pane.
3. Click **Create Changefeed**, and select **Kafka** as **Destination**.

## Step 2. Configure the changefeed target
Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/changefeed-sink-to-apache-pulsar.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,10 @@ You might also need a default topic for non-row events (such as schema changes)

For more information, see [How to create a topic](https://pulsar.apache.org/docs/4.0.x/tutorials-topic/) in Apache Pulsar documentation.

## Step 1. Open the changefeed page for Apache Pulsar
## Step 1. Open the Changefeed page for Apache Pulsar

1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
2. Navigate to the cluster overview page of the TiDB cluster that will be the source of the changefeed events, and then click **Changefeed** in the left navigation pane.
2. Navigate to the cluster overview page of the TiDB cluster that will be the source of the changefeed events, and then click **Data** > **Changefeed** in the left navigation pane.
3. Click **Create Changefeed**.

## Step 2. Configure the changefeed destination
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/changefeed-sink-to-cloud-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This document describes how to create a changefeed to stream data from TiDB Clou

## Step 1. Configure destination

Navigate to the cluster overview page of the target TiDB cluster. Click **Changefeed** in the left navigation pane, click **Create Changefeed**, and select **Amazon S3** or **GCS** as the destination. The configuration process varies depend on the destination you choose.
Navigate to the cluster overview page of the target TiDB cluster. Click **Data** > **Changefeed** in the left navigation pane, click **Create Changefeed**, and select **Amazon S3** or **GCS** as the destination. The configuration process varies depend on the destination you choose.

<SimpleTab>
<div label="Amazon S3">
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/changefeed-sink-to-mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ If you do not load the existing data, you need to create corresponding target ta

After completing the prerequisites, you can sink your data to MySQL.

1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Changefeed** in the left navigation pane.
1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Data** > **Changefeed** in the left navigation pane.

2. Click **Create Changefeed**, and select **MySQL** as **Destination**.

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/changefeed-sink-to-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Before creating a changefeed, you need to export existing data from the source T

After completing the prerequisites, you can sink your data to the destination TiDB Cloud Serverless cluster.

1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Changefeed** in the left navigation pane.
1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Data** > **Changefeed** in the left navigation pane.

2. Click **Create Changefeed**, and select **TiDB Cloud** as the destination.

Expand Down
Loading
Loading