Skip to content

Commit

Permalink
master: replace files in the cloud folder with the latest ones (#15907)…
Browse files Browse the repository at this point in the history
… (#15921)
  • Loading branch information
ti-chi-bot authored Jan 2, 2024
1 parent 4ba5f55 commit 9f92766
Show file tree
Hide file tree
Showing 95 changed files with 3,087 additions and 898 deletions.
Binary file added media/tidb-cloud/data-service/GPTs1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/data-service/GPTs2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified media/tidb-cloud/dm-billing-cross-az-fees.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified media/tidb-cloud/dm-billing-cross-region-and-az-fees.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified media/tidb-cloud/dm-billing-cross-region-fees.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.5.0_oltp_insert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.5.0_oltp_point_select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.5.0_oltp_read_write.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.5.0_oltp_update_index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.5.0_oltp_update_non_index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.5.0_tpcc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified media/tidb-cloud/vercel/integration-link-cluster-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/vercel/preview-envs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions tidb-cloud/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ hide_commit: true

[From Apache Parquet Files](https://docs.pingcap.com/tidbcloud/import-csv-files)

[With MySQL CLI](https://docs.pingcap.com/tidbcloud/import-with-mysql-cli)

</LearningPath>

<LearningPath label="Monitor" icon="cloud6">
Expand Down
12 changes: 7 additions & 5 deletions tidb-cloud/api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,22 @@ summary: Learn about what is TiDB Cloud API, its features, and how to use API to

> **Note:**
>
> [TiDB Cloud API](https://docs.pingcap.com/tidbcloud/api/v1beta) is in beta.
> TiDB Cloud API is in beta.
The TiDB Cloud API is a [REST interface](https://en.wikipedia.org/wiki/Representational_state_transfer) that provides you with programmatic access to manage administrative objects within TiDB Cloud. Through this API, you can automatically and efficiently manage resources such as Projects, Clusters, Backups, Restores, and Imports.
The TiDB Cloud API is a [REST interface](https://en.wikipedia.org/wiki/Representational_state_transfer) that provides you with programmatic access to manage administrative objects within TiDB Cloud. Through this API, you can automatically and efficiently manage resources such as Projects, Clusters, Backups, Restores, Imports, and Billings.

The API has the following features:

- **JSON entities.** All entities are expressed in JSON.
- **HTTPS-only.** You can only access the API via HTTPS, ensuring all the data sent over the network is encrypted with TLS.
- **Key-based access and digest authentication.** Before you access TiDB Cloud API, you must generate an API key. All requests are authenticated through [HTTP Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication), ensuring the API key is never sent over the network.
- **Key-based access and digest authentication.** Before you access TiDB Cloud API, you must generate an API key, refer to [API Key Management](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication/API-key-management). All requests are authenticated through [HTTP Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication), ensuring the API key is never sent over the network.

To start using TiDB Cloud API, refer to the following resources in [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta):
To start using TiDB Cloud API, refer to the following resources in TiDB Cloud API Documentation:

- [Get Started](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Get-Started)
- [Authentication](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication)
- [Rate Limiting](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Rate-Limiting)
- [API Full References](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Project)
- API Full References
- [v1beta1](https://docs.pingcap.com/tidbcloud/api/v1beta1)
- [v1beta](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Project)
- [Changelog](https://docs.pingcap.com/tidbcloud/api/v1beta#section/API-Changelog)
202 changes: 139 additions & 63 deletions tidb-cloud/backup-and-restore.md

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions tidb-cloud/branch-github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,11 +148,20 @@ Here are the main steps to create the workflow:
echo "The user is ${{ steps.wait-for-branch.outputs.user }}"
echo "The password is ${{ steps.wait-for-branch.outputs.password }}"
```

- `token`: GitHub will automatically create a [GITHUB_TOKEN](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) secret. You can use it directly.
- `public-key` and `private-key`: The TiDB Cloud [API key](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication/API-Key-Management).

3. Modify your test code.

Modify your test code to accept the connection information from GitHub Actions. For example, you can accept the connection information through the environment, as demonstrated in the [live demo](https://github.com/shiyuhang0/tidbcloud-branch-gorm-example).

## What's next

Learn how to use the branching GitHub integration with the following examples:

- [branching-gorm-example](https://github.com/tidbcloud/branching-gorm-example)
- [branching-django-example](https://github.com/tidbcloud/branching-django-example)
- [branching-rails-example](https://github.com/tidbcloud/branching-rails-example)

You can also build your branching CI/CD workflow without the branching GitHub integration. For example, you can use [`setup-tidbcloud-cli`](https://github.com/tidbcloud/setup-tidbcloud-cli) and GitHub Actions to customize your CI/CD workflows.
12 changes: 8 additions & 4 deletions tidb-cloud/branch-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,16 @@ To connect to a branch, perform the following steps:
2. Click **Branches** in the left navigation pane.
3. In the row of your target branch to be connected, click **...** in the **Action** column.
4. Click **Connect** in the drop-down list. The dialog for the connection information is displayed.
5. Click **Create password** or **Reset password** to create or reset the root password.
5. Click **Generate Password** or **Reset Password** to create or reset the root password.
6. Connect to the branch using the connection information.

> **Note:**
>
> Currently, branches do not support [private endpoints](/tidb-cloud/set-up-private-endpoint-connections-serverless.md).
Alternatively, you can get the connection string from the cluster overview page:

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project, and then click the name of your target TiDB Serverless cluster to go to its overview page.
2. Click **Connect** in the upper-right corner.
3. Select the branch you want to connect to in the `Branch` drop-down list.
4. Click **Generate Password** or **Reset Password** to create or reset the root password.
5. Connect to the branch using the connection information.

## Delete a branch

Expand Down
12 changes: 7 additions & 5 deletions tidb-cloud/changefeed-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data servic

> **Note:**
>
> - To use the changefeed feature, make sure that your TiDB Dedicated cluster version is v6.4.0 or later.
> - Currently, TiDB Cloud only allows up to 5 changefeeds per cluster.
> - Currently, TiDB Cloud only allows up to 100 changefeeds per cluster.
> - Currently, TiDB Cloud only allows up to 100 table filter rules per changefeed.
> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-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.
Expand All @@ -21,7 +21,7 @@ On the changefeed page, you can create a changefeed, view a list of existing cha

To create a changefeed, refer to the tutorials:

- [Sink to Apache Kafka](/tidb-cloud/changefeed-sink-to-apache-kafka.md) (Beta)
- [Sink to Apache Kafka](/tidb-cloud/changefeed-sink-to-apache-kafka.md)
- [Sink to MySQL](/tidb-cloud/changefeed-sink-to-mysql.md)
- [Sink to TiDB Cloud](/tidb-cloud/changefeed-sink-to-tidb-cloud.md)
- [Sink to cloud storage](/tidb-cloud/changefeed-sink-to-cloud-storage.md)
Expand Down Expand Up @@ -65,8 +65,10 @@ It takes about 10 minutes to complete the scaling process (during which the chan

TiDB Cloud populates the changefeed configuration by default. You can modify the following configurations:

- MySQL sink: **MySQL Connection** and **Table Filter**.
- Kafka sink: all configurations.
- Apache Kafka sink: all configurations.
- MySQL sink: **MySQL Connection**, **Table Filter**, and **Event Filter**.
- TiDB Cloud sink: **TiDB Cloud Connection**, **Table Filter**, and **Event Filter**.
- Cloud storage sink: **Storage Endpoint**, **Table Filter**, and **Event Filter**.

4. After editing the configuration, click **...** > **Resume** to resume the corresponding changefeed.

Expand Down
117 changes: 0 additions & 117 deletions tidb-cloud/changefeed-replication.md

This file was deleted.

Loading

0 comments on commit 9f92766

Please sign in to comment.