-
Notifications
You must be signed in to change notification settings - Fork 120
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* add translation * Apply suggestions from code review Co-authored-by: xixirangrang <[email protected]> --------- Co-authored-by: Ran <[email protected]> Co-authored-by: Ran <[email protected]> Co-authored-by: xixirangrang <[email protected]>
- Loading branch information
4 people
authored
Jan 17, 2024
1 parent
66b1ee4
commit 98b68cc
Showing
13 changed files
with
199 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| title: Deploy TiProxy Load Balancer for an Existing TiDB Cluster | ||
| summary: Learn how to deploy TiProxy for an existing TiDB cluster on Kubernetes. | ||
| --- | ||
|
|
||
| # Deploy TiProxy Load Balancer for an Existing TiDB Cluster | ||
|
|
||
| This topic describes how to deploy or remove the TiDB load balancer [TiProxy](https://docs.pingcap.com/tidb/v7.6/tiproxy-overview) for an existing TiDB cluster on Kubernetes. TiProxy is placed between the client and TiDB server to provide load balancing, connection persistence, and service discovery for TiDB. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If you have not deployed a TiDB cluster, you can add TiProxy configurations when [configuring a TiDB cluster](configure-a-tidb-cluster.md) and then [deploy a TiDB cluster](deploy-on-general-kubernetes.md). In that case, you do not need to refer to this topic. | ||
| ## Deploy TiProxy | ||
|
|
||
| If you need to deploy TiProxy for an existing TiDB cluster, follow these steps: | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If your server does not have access to the internet, refer to [Deploy a TiDB Cluster](deploy-on-general-kubernetes.md#deploy-the-tidb-cluster) to download the `pingcap/tiproxy` Docker image to a machine with access to the internet and then upload the Docker image to your server. Then, use `docker load` to install the Docker image on your server. | ||
| 1. Edit the TidbCluster Custom Resource (CR): | ||
|
|
||
| ``` shell | ||
| kubectl edit tc ${cluster_name} -n ${namespace} | ||
| ``` | ||
|
|
||
| 2. Add the TiProxy configuration as shown in the following example: | ||
|
|
||
| ```yaml | ||
| spec: | ||
| tiproxy: | ||
| baseImage: pingcap/tiproxy | ||
| replicas: 3 | ||
| ``` | ||
|
|
||
| 3. Configure the related parameters in `spec.tiproxy.config` of the TidbCluster CR. For example: | ||
|
|
||
| ```yaml | ||
| spec: | ||
| tiproxy: | ||
| config: | ||
| config: | | ||
| [log] | ||
| level = "info" | ||
| ``` | ||
|
|
||
| For more information about TiProxy configuration, see [TiProxy Configuration](https://docs.pingcap.com/tidb/v7.6/tiproxy/tiproxy-configuration). | ||
|
|
||
| After TiProxy is started, you can find the corresponding `tiproxy-sql` load balancer service by running the following command. | ||
|
|
||
| ``` shell | ||
| kubectl get svc -n ${namespace} | ||
| ``` | ||
|
|
||
| ## Remove TiProxy | ||
|
|
||
| If your TiDB cluster no longer needs TiProxy, follow these steps to remove it. | ||
|
|
||
| 1. Modify `spec.tiproxy.replicas` to `0` to remove the TiProxy Pod by running the following command. | ||
|
|
||
| ```shell | ||
| kubectl patch tidbcluster ${cluster_name} -n ${namespace} --type merge -p '{"spec":{"tiproxy":{"replicas": 0}}}' | ||
| ``` | ||
|
|
||
| 2. Check the status of the TiProxy Pod. | ||
|
|
||
| ```shell | ||
| kubectl get pod -n ${namespace} -l app.kubernetes.io/component=tiproxy,app.kubernetes.io/instance=${cluster_name} | ||
| ``` | ||
|
|
||
| If the output is empty, the TiProxy Pod has been successfully removed. | ||
|
|
||
| 3. Delete the TiProxy StatefulSet. | ||
|
|
||
| 1. Modify the TidbCluster CR and delete the `spec.tiproxy` field by running the following command: | ||
|
|
||
| ```shell | ||
| kubectl patch tidbcluster ${cluster_name} -n ${namespace} --type json -p '[{"op":"remove", "path":"/spec/tiproxy"}]' | ||
| ``` | ||
|
|
||
| 2. Delete the TiProxy StatefulSet by running the following command: | ||
|
|
||
| ```shell | ||
| kubectl delete statefulsets -n ${namespace} -l app.kubernetes.io/component=tiproxy,app.kubernetes.io/instance=${cluster_name} | ||
| ``` | ||
|
|
||
| 3. Check whether the TiProxy StatefulSet has been successfully deleted by running the following command: | ||
|
|
||
| ```shell | ||
| kubectl get sts -n ${namespace} -l app.kubernetes.io/component=tiproxy,app.kubernetes.io/instance=${cluster_name} | ||
| ``` | ||
|
|
||
| If the output is empty, the TiProxy StatefulSet has been successfully deleted. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.