Skip to content

Commit 82b70b3

Browse files
lilin90lilin90
authored
*: add custom Japanese localization for cloud docs (#21612)
1 parent e4cba71 commit 82b70b3

15 files changed

+285
-5
lines changed

‎tidb-cloud/architecture-concepts.md‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,37 @@ summary: Learn about architecture concepts for TiDB Cloud.
55

66
# Architecture
77

8-
TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings the flexibility and power of [TiDB](https://docs.pingcap.com/tidb/stable/overview), an open-source HTAP (Hybrid Transactional and Analytical Processing) database, to AWS, Azure, Google Cloud, and Alibaba Cloud.
8+
<CustomContent language="en,zh">
9+
10+
TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings the flexibility and power of [TiDB](https://docs.pingcap.com/tidb/stable/overview), an open-source HTAP (Hybrid Transactional and Analytical Processing) database, to Amazon Web Services (AWS), Google Cloud, Microsoft Azure, and Alibaba Cloud.
11+
12+
</CustomContent>
13+
14+
<CustomContent language="ja">
15+
16+
TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings the flexibility and power of [TiDB](https://docs.pingcap.com/tidb/stable/overview), an open-source HTAP (Hybrid Transactional and Analytical Processing) database, to Amazon Web Services (AWS), Google Cloud, and Microsoft Azure.
17+
18+
</CustomContent>
919

1020
TiDB is MySQL-compatible, making it easy to migrate and work with existing applications, while offering seamless scalability to handle everything from small workloads to massive, high-performance clusters. It supports both transactional (OLTP) and analytical (OLAP) workloads in one system, simplifying operations and enabling real-time insights.
1121

1222
TiDB Cloud makes it easy to scale your database, handle complex management tasks, and stay focused on developing reliable, high-performing applications.
1323

24+
<CustomContent language="en,zh">
25+
1426
- For AWS, TiDB Cloud provides **{{{ .starter }}}** for auto-scaling, cost-efficient workloads, and **{{{ .dedicated }}}** for enterprise-grade applications with dedicated resources and advanced capabilities.
1527
- For Google Cloud and Azure, TiDB Cloud provides **{{{ .dedicated }}}** for enterprise-grade applications with dedicated resources and advanced capabilities.
1628
- For Alibaba Cloud, TiDB Cloud provides **{{{ .starter }}}** for auto-scaling, cost-efficient workloads and **{{{ .essential }}}** for production-ready workloads with provisioned capacity.
1729

30+
</CustomContent>
31+
32+
<CustomContent language="ja">
33+
34+
- For AWS, TiDB Cloud provides **{{{ .starter }}}** for auto-scaling, cost-efficient workloads, and **{{{ .dedicated }}}** for enterprise-grade applications with dedicated resources and advanced capabilities.
35+
- For Google Cloud and Azure, TiDB Cloud provides **{{{ .dedicated }}}** for enterprise-grade applications with dedicated resources and advanced capabilities.
36+
37+
</CustomContent>
38+
1839
## {{{ .starter }}}
1940

2041
{{{ .starter }}} (formerly Serverless) is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database.

‎tidb-cloud/connect-via-standard-connection-serverless.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via public endpoi
2121

2222
3. In the dialog, keep the default setting of the connection type as `Public`, and select your preferred connection method and operating system to get the corresponding connection string.
2323

24+
<CustomContent language="en,zh">
25+
2426
> **Note:**
2527
>
2628
> - Keeping the connection type as `Public` means the connection is via standard TLS connection. For more information, see [TLS Connection to {{{ .starter }}} or Essential](/tidb-cloud/secure-connections-to-serverless-clusters.md).
@@ -29,6 +31,17 @@ To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via public endpoi
2931
> - [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md)
3032
> - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md)
3133
34+
</CustomContent>
35+
36+
<CustomContent language="ja">
37+
38+
> **Note:**
39+
>
40+
> - Keeping the connection type as `Public` means the connection is via standard TLS connection. For more information, see [TLS Connection to {{{ .starter }}} or Essential](/tidb-cloud/secure-connections-to-serverless-clusters.md).
41+
> - If you choose **Private Endpoint** in the **Connection Type** drop-down list, it means that the connection is via private endpoint. For more information, see [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md).
42+
43+
</CustomContent>
44+
3245
4. TiDB Cloud lets you create [branches](/tidb-cloud/branch-overview.md) for your {{{ .starter }}} or {{{ .essential }}} cluster. After a branch is created, you can choose to connect to the branch via the **Branch** drop-down list. `main` represents the cluster itself.
3346

3447
5. If you have not set a password yet, click **Generate Password** to generate a random password. The generated password will not show again, so save your password in a secure location.

‎tidb-cloud/create-tidb-cluster-serverless.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,25 @@ This document describes how to create a {{{ .starter }}} or {{{ .essential }}} c
1515

1616
If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/signup) to sign up for an account.
1717

18+
<CustomContent language="en,zh">
19+
1820
- You can either sign up with email and password so that you can manage your password using TiDB Cloud, or sign up with your Google, GitHub, or Microsoft account.
1921
- For AWS Marketplace users, you can also sign up through AWS Marketplace. To do that, search for `TiDB Cloud` in [AWS Marketplace](https://aws.amazon.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account.
2022
- For Azure Marketplace users, you can also sign up through Azure Marketplace. To do that, search for `TiDB Cloud` in [Azure Marketplace](https://azuremarketplace.microsoft.com), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account.
2123
- For Google Cloud Marketplace users, you can also sign up through Google Cloud Marketplace. To do that, search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account.
2224
- For Alibaba Cloud Marketplace users, you can also sign up through Alibaba Cloud Marketplace. To do that, search for `TiDB Cloud` in [Alibaba Cloud Marketplace](https://marketplace.alibabacloud.com/), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account.
2325

26+
</CustomContent>
27+
28+
<CustomContent language="ja">
29+
30+
- You can either sign up with email and password so that you can manage your password using TiDB Cloud, or sign up with your Google, GitHub, or Microsoft account.
31+
- For AWS Marketplace users, you can also sign up through AWS Marketplace. To do that, search for `TiDB Cloud` in [AWS Marketplace](https://aws.amazon.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account.
32+
- For Azure Marketplace users, you can also sign up through Azure Marketplace. To do that, search for `TiDB Cloud` in [Azure Marketplace](https://azuremarketplace.microsoft.com), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account.
33+
- For Google Cloud Marketplace users, you can also sign up through Google Cloud Marketplace. To do that, search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account.
34+
35+
</CustomContent>
36+
2437
## Steps
2538

2639
If you are in the `Organization Owner` or the `Project Owner` role, you can create a {{{ .starter }}} or {{{ .essential }}} cluster as follows:
@@ -31,9 +44,19 @@ If you are in the `Organization Owner` or the `Project Owner` role, you can crea
3144

3245
3. Select a cluster plan and the cloud provider.
3346

47+
<CustomContent language="en,zh">
48+
3449
- For AWS, you can start with a **Starter** cluster.
3550
- For Alibaba Cloud, you can start with a **Starter** cluster and later upgrade to an **Essential** cluster as your needs grow.
3651

52+
</CustomContent>
53+
54+
<CustomContent language="ja">
55+
56+
For AWS, you can start with a **Starter** cluster.
57+
58+
</CustomContent>
59+
3760
For more information, see [cluster plans](/tidb-cloud/select-cluster-tier.md).
3861

3962
4. Select a region where you want to host your cluster.

‎tidb-cloud/security-concepts.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,10 +164,22 @@ TiDB Cloud ensures secure cluster connectivity and data transmission through rob
164164

165165
### Private endpoints
166166

167+
<CustomContent language="en,zh">
168+
167169
- Enables secure connectivity for SQL clients within your Virtual Private Cloud (VPC) to TiDB Cloud Dedicated clusters.
168170

169171
- Supported by [AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md), [Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md), [Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md), and [Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md).
170172

173+
</CustomContent>
174+
175+
<CustomContent language="ja">
176+
177+
- Enables secure connectivity for SQL clients within your Virtual Private Cloud (VPC) to TiDB Cloud Dedicated clusters.
178+
179+
- Supported by [AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md), [Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md), and [Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md).
180+
181+
</CustomContent>
182+
171183
**Best practices:** Use private endpoints in production to minimize public exposure and review configurations regularly.
172184

173185
### TLS (Transport Layer Security)

‎tidb-cloud/serverless-high-availability.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ TiDB Cloud extends these capabilities with two types of high availability to mee
2525
2626
When you create a cluster with the default zonal high availability, all components, including Gateway, TiDB, TiKV, and TiFlash compute/write nodes, run in the same availability zone. The placement of these components in the data plane offer infrastructure redundancy with virtual machine pools, which minimizes failover time and network latency due to colocation.
2727

28+
<CustomContent language="en,zh">
29+
2830
- The following diagram shows the architecture of zonal high availability on AWS:
2931

3032
![zonal high availability on AWS](/media/tidb-cloud/zonal-high-avaliability-aws.png)
@@ -33,6 +35,16 @@ When you create a cluster with the default zonal high availability, all componen
3335

3436
![zonal high availability on Alibaba Cloud](/media/tidb-cloud/zonal-high-avaliability-alibaba-cloud.png)
3537

38+
</CustomContent>
39+
40+
<CustomContent language="ja">
41+
42+
The following diagram shows the architecture of zonal high availability on AWS:
43+
44+
![zonal high availability on AWS](/media/tidb-cloud/zonal-high-avaliability-aws.png)
45+
46+
</CustomContent>
47+
3648
In zonal high availability architecture:
3749

3850
- The Placement Driver (PD) is deployed across multiple availability zones, ensuring high availability by replicating data redundantly across zones.
@@ -43,12 +55,26 @@ In zonal high availability architecture:
4355

4456
TiDB Cloud ensures a transparent failover process for your applications. During a failover:
4557

58+
<CustomContent language="en,zh">
59+
4660
- A new replica is created to replace the failed one.
4761

4862
- Servers providing storage services recover local caches from persisted data on Amazon S3 or Alibaba Cloud OSS (depending on your cloud provider), restoring the system to a consistent state with the replicas.
4963

5064
In the storage layer, persisted data is regularly pushed to Amazon S3 or Alibaba Cloud OSS (depending on your cloud provider) for high durability. Moreover, immediate updates are not only replicated across multiple TiKV servers but also stored on the EBS of each server, which further replicates the data for additional durability. TiDB automatically resolves issues by backing off and retrying in milliseconds, ensuring the failover process remains seamless for client applications.
5165

66+
</CustomContent>
67+
68+
<CustomContent language="ja">
69+
70+
- A new replica is created to replace the failed one.
71+
72+
- Servers providing storage services recover local caches from persisted data on Amazon S3 (depending on your cloud provider), restoring the system to a consistent state with the replicas.
73+
74+
In the storage layer, persisted data is regularly pushed to Amazon S3 for high durability. Moreover, immediate updates are not only replicated across multiple TiKV servers but also stored on the EBS of each server, which further replicates the data for additional durability. TiDB automatically resolves issues by backing off and retrying in milliseconds, ensuring the failover process remains seamless for client applications.
75+
76+
</CustomContent>
77+
5278
The gateway and computing layers are stateless, so failover involves restarting them elsewhere immediately. Applications should implement retry logic for their connections. While the zonal setup provides high availability, it cannot handle an entire zone failure. If the zone becomes unavailable, downtime will occur until the zone and its dependent services are restored.
5379

5480
## Regional high availability architecture
@@ -60,6 +86,8 @@ When you create a cluster with regional high availability, critical OLTP (Online
6086
> - Regional high availability is currently in beta.
6187
> - You can enable regional high availability when you create a {{{ .essential }}} cluster.
6288
89+
<CustomContent language="en,zh">
90+
6391
The following diagram shows the architecture of regional high availability on Alibaba Cloud:
6492

6593
![regional high availability](/media/tidb-cloud/regional-high-avaliability-alibaba-cloud.png)
@@ -70,6 +98,8 @@ In regional high availability architecture:
7098
- Data is replicated across TiFlash write nodes within the primary availability zone.
7199
- TiDB servers and TiFlash compute nodes read from and write to these TiKV and TiFlash write nodes, which are safeguarded by storage-level replication.
72100

101+
</CustomContent>
102+
73103
### Failover process
74104

75105
In the rare event of a primary zone failure scenario, which could be caused by a natural disaster, configuration change, software issue, or hardware failure, critical OLTP workload components, including Gateway and TiDB, are automatically launched in the standby availability zone. Traffic is automatically redirected to the standby zone to ensure swift recovery and maintain business continuity.
@@ -94,10 +124,22 @@ TiDB Cloud provides robust automated backup mechanisms to ensure continuous data
94124

95125
These automated backups enable you to restore your database either from a full backup or from a specific point in time by combining full backups with continuous transaction logs. This flexibility ensures that you can recover your database to a precise point just before an incident occurs.
96126

127+
<CustomContent language="en,zh">
128+
97129
> **Note:**
98130
>
99131
> Automatic backups, including snapshot-based and continuous backups for Point-in-Time Recovery (PITR), are performed on Amazon S3 or Alibaba Cloud OSS (depending on your cloud provider), which provides regional-level high durability.
100132
133+
</CustomContent>
134+
135+
<CustomContent language="ja">
136+
137+
> **Note:**
138+
>
139+
> Automatic backups, including snapshot-based and continuous backups for Point-in-Time Recovery (PITR), are performed on Amazon S3, which provides regional-level high durability.
140+
141+
</CustomContent>
142+
101143
## Impact on sessions during failures
102144

103145
During a failure, ongoing transactions on the failed server might be interrupted. Although failover is transparent to applications, you must implement logic to handle recoverable failures during active transactions. Different failure scenarios are handled as follows:

‎tidb-cloud/set-up-private-endpoint-connections-on-azure.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ summary: Learn how to connect to TiDB Cloud Dedicated Cluster via Azure Private
77

88
This document describes how to connect to your TiDB Cloud Dedicated cluster via [Azure Private Link](https://learn.microsoft.com/en-us/azure/private-link/private-link-overview).
99

10+
<CustomContent language="en,zh">
11+
1012
> **Tip:**
1113
>
1214
> - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md).
@@ -15,6 +17,18 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via
1517
> - [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md)
1618
> - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md)
1719
20+
</CustomContent>
21+
22+
<CustomContent language="ja">
23+
24+
> **Tip:**
25+
>
26+
> - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md).
27+
> - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Google Cloud, see [Connect to a TiDB Cloud Dedicated Cluster via Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md)
28+
> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, see [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md).
29+
30+
</CustomContent>
31+
1832
TiDB Cloud supports highly secure and one-way access to the TiDB Cloud service hosted in an Azure virtual network via [Azure Private Link](https://learn.microsoft.com/en-us/azure/private-link/private-link-overview), as if the service were in your own virtual network. You can create a private endpoint in your virtual network, and then connect to the TiDB Cloud service via the endpoint with permission.
1933

2034
Powered by Azure Private Link, the endpoint connection is secure and private, and does not expose your data to the public internet. In addition, the endpoint connection supports CIDR overlap and is easier for network management.

‎tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ summary: Learn how to connect to your TiDB Cloud cluster via Google Cloud Privat
77

88
This document describes how to connect to your TiDB Cloud Dedicated cluster via [Private Service Connect](https://cloud.google.com/vpc/docs/private-service-connect). Google Cloud Private Service Connect is a private endpoint service provided by Google Cloud.
99

10+
<CustomContent language="en,zh">
11+
1012
> **Tip:**
1113
>
1214
> - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md).
@@ -15,6 +17,18 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via
1517
> - [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md)
1618
> - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md)
1719
20+
</CustomContent>
21+
22+
<CustomContent language="ja">
23+
24+
> **Tip:**
25+
>
26+
> - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md).
27+
> - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Azure, see [Connect to a TiDB Cloud Dedicated Cluster via Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md).
28+
> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, see [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md).
29+
30+
</CustomContent>
31+
1832
TiDB Cloud supports highly secure and one-way access to the TiDB Cloud service hosted in a Google Cloud VPC via [Private Service Connect](https://cloud.google.com/vpc/docs/private-service-connect). You can create an endpoint and use it to connect to the TiDB Cloud service .
1933

2034
Powered by Google Cloud Private Service Connect, the endpoint connection is secure and private, and does not expose your data to the public internet. In addition, the endpoint connection supports CIDR overlap and is easier for network management.

0 commit comments

Comments
 (0)