在 GCP GKE 上部署 TiDB 集群
部署前,确认已安装以下软件:
- Google Cloud SDK
- >= 0.12
- kubectl >= 1.12
- >= 2.11.0 且 < 2.16.4
- jq
配置
为保证部署顺利,需要提前进行一些配置。在开始配置 Google Cloud SDK、API、Terraform 前,先下载以下资源:
安装 Google Cloud SDK 后,需要执行 进行。
配置 API
如果使用的 GCP 项目是新项目,需确保以下 API 已启用:
gcloud services enable cloudresourcemanager.googleapis.com \
cloudbilling.googleapis.com iam.googleapis.com \
compute.googleapis.com container.googleapis.com
配置 Terraform
要执行 Terraform 脚本,需要设置以下 3 个环境变量。你可以等 Terraform 提示再输入,也可以提前在 .tfvars
文件中定义变量。
GCP_CREDENTIALS_PATH
:GCP 证书文件路径。建议另建一个服务账号给 Terraform 使用,参考创建与管理服务账号文档。
./create-service-account.sh
会创建最低权限的服务账号。参考来创建服务账号密钥。下面脚本中的步骤详细说明了如何使用
deploy/gcp
目录中提供的脚本执行此操作。或者,如果自己创建服务账号和密钥,可以在创建时选择JSON
类型的密钥。下载的包含私钥的JSON
文件即所需的证书文件。
GCP_REGION
:创建资源所在的区域,例如:us-west1
。GCP_PROJECT
:GCP 项目的名称。
要使用以上 3 个环境变量来配置 Terraform,可执行以下步骤:
将
GCP_REGION
替换为你的 GCP Region。echo GCP_REGION=\"us-west1\" >> terraform.tfvars
将
GCP_PROJECT
替换为你的 GCP 项目名称,确保连接的是正确的 GCP 项目。echo "GCP_PROJECT=\"$(gcloud config get-value project)\"" >> terraform.tfvars
初始化 Terraform。
terraform init
为 Terraform 创建一个有限权限的服务账号,并设置证书路径。
./create-service-account.sh
Terraform 自动加载和填充匹配 terraform.tfvars
或 *.auto.tfvars
文件的变量。相关详细信息,请参阅 Terraform 文档。上述步骤会使用 GCP_REGION
和 GCP_PROJECT
填充 terraform.tfvars
文件,使用 GCP_CREDENTIALS_PATH
填充 credentials.auto.tfvars
文件。
部署 TiDB 集群
本小节介绍如何部署 TiDB 集群。
确定实例类型。
如果只是想试一下 TiDB,又不想花费太高成本,可以采用轻量级的配置:
cat small.tfvars >> terraform.tfvars
如果要对生产环境的部署进行 benchmark 测试,则建议采用生产级的配置:
cat prod.tfvars >> terraform.tfvars
prod.tfvars
会默认创建一个新的 VPC,两个子网和一个 f1-micro 实例作为堡垒机,以及使用以下实例类型作为工作节点的 GKE 集群:- 3 台 n1-standard-4 实例:部署 PD
- 3 台 n1-highmem-8 实例:部署 TiKV
- 3 台 n1-standard-16 实例:部署 TiDB
3 台 n1-standard-2 实例:部署监控组件
如上所述,生产环境的部署需要 91 个 CPU,超过了 GCP 项目的默认配额。可以参考来增加项目配额。扩容同样需要更多 CPU。
注意:
工作节点的数量取决于指定 Region 中可用区的数量。大部分 Region 有 3 个可用区,但是
us-central1
有 4 个可用区。参考 Regions and Zones 查看更多信息。参考部分来自定义区域集群的节点池。
启动脚本来部署 TiDB 集群:
terraform apply
注意:
如果未提前设置上文所述的 3 个环境变量,执行
terraform apply
过程中会有提示出现,要求对 3 个变量进行设置。详情请参考配置 Terraform。整个过程可能至少需要 10 分钟。
terraform apply
执行成功后,会输出类似如下的信息:Apply complete! Resources: 23 added, 0 changed, 0 destroyed.
Outputs:
how_to_connect_to_default_cluster_tidb_from_bastion = mysql -h 172.31.252.20 -P 4000 -u root
how_to_ssh_to_bastion = gcloud compute ssh tidb-cluster-bastion --zone us-west1-b
how_to_set_reclaim_policy_of_pv_for_default_tidb_cluster_to_delete = kubectl --kubeconfig /.../credentials/kubeconfig_tidb-cluster get pvc -n tidb-cluster -o jsonpath='{.items[*].spec.volumeName}'|fmt -1 | xargs -I {} kubectl --kubeconfig /.../credentials/kubeconfig_tidb-cluster patch pv {} -p '{"spec":{"persistentVolumeReclaimPolicy":"Delete"}}'
kubeconfig_file = ./credentials/kubeconfig_tidb-cluster
monitor_lb_ip = 35.227.134.146
monitor_port = 3000
region = us-west1
tidb_version = v3.0.1
terraform apply
运行完成后,可执行以下步骤来访问 TiDB 数据库。注意用小节的输出信息替换 <>
部分的内容。
通过
ssh
远程连接到堡垒机。-
mysql -h <tidb_ilb_ip> -P 4000 -u root
注意:
通过 MySQL 连接 TiDB 前,需要先安装 MySQL 客户端。
与 GKE 集群交互
你可以通过 kubectl
和 helm
使用 kubeconfig 文件 credentials/kubeconfig_<gke_cluster_name>
和 GKE 集群交互。交互方式主要有以下两种。
指定
--kubeconfig
参数:kubectl --kubeconfig credentials/kubeconfig_<gke_cluster_name> get po -n <tidb_cluster_name>
注意:
下面这条命令使用的
--kubeconfig
参数至少需要 Helm 2.10.0 版本以上。helm --kubeconfig credentials/kubeconfig_<gke_cluster_name> ls
设置
KUBECONFIG
环境变量:kubectl get po -n <tidb_cluster_name>
helm ls
升级 TiDB 集群
要升级 TiDB 集群,可执行以下步骤:
- 编辑
variables.tf
文件,将tidb_version
变量的值修改为更高版本。 - 运行
terraform apply
。
例如,要将 TiDB 集群升级到 3.0.0-rc.2,可修改 tidb_version
为 v3.0.0-rc.2
:
variable "tidb_version" {
description = "TiDB version"
default = "v3.0.0-rc.2"
}
升级过程会持续一段时间。你可以通过以下命令来持续观察升级进度:
kubectl --kubeconfig credentials/kubeconfig_<gke_cluster_name> get po -n <tidb_cluster_name> --watch
然后,你可以访问数据库并通过 tidb_version()
确认 TiDB 集群是否升级成功:
select tidb_version();
*************************** 1. row ***************************
tidb_version(): Release Version: v3.0.0-rc.2
Git Commit Hash: 06f3f63d5a87e7f0436c0618cf524fea7172eb93
UTC Build Time: 2019-05-28 12:48:52
GoVersion: go version go1.12 linux/amd64
Race Enabled: false
TiKV Min Version: 2.1.0-alpha.1-ff3dd160846b7d1aed9079c389fc188f7f5ea13e
Check Table Before Drop: false
1 row in set (0.001 sec)
一个 tidb-cluster
模块的实例对应一个 GKE 集群中的 TiDB 集群。要添加一个新的 TiDB 集群,可执行以下步骤:
编辑
tidbclusters.tf
文件来添加一个tidb-cluster
模块。例如:
module "example-tidb-cluster" {
providers = {
helm = "helm.gke"
}
source = "../modules/gcp/tidb-cluster"
cluster_id = module.tidb-operator.cluster_id
tidb_operator_id = module.tidb-operator.tidb_operator_id
gcp_project = var.GCP_PROJECT
gke_cluster_location = local.location
gke_cluster_name = <gke-cluster-name>
cluster_name = <example-tidb-cluster>
cluster_version = "v3.0.1"
kubeconfig_path = local.kubeconfig
tidb_cluster_chart_version = "v1.0.0"
pd_instance_type = "n1-standard-1"
tikv_instance_type = "n1-standard-4"
tidb_instance_type = "n1-standard-2"
monitor_instance_type = "n1-standard-1"
pd_node_count = 1
tikv_node_count = 2
tidb_node_count = 1
monitor_node_count = 1
}
注意:
- 每个集群的
cluster_name
必须是唯一的。 - 为任一组件实际创建的总节点数等于配置文件中的节点数乘以该 Region 中可用区的个数。
你可以通过
kubectl
获取创建的 TiDB 集群和监控组件的地址。如果你希望 Terraform 脚本打印此信息,可在outputs.tf
中添加一个output
配置项,如下所示:output "how_to_connect_to_example_tidb_cluster_from_bastion" {
value = module.example-tidb-cluster.how_to_connect_to_tidb_from_bastion
}
上述配置可使该脚本打印出用于连接 TiDB 集群的命令。
修改完成后,执行以下命令来创建集群。
terraform init
terraform apply
扩容
如果需要扩容 TiDB 集群,可执行以下步骤:
- 按需修改
variables.tf
文件中的tikv_count
、tidb_count
变量。 - 运行
terraform apply
。
警告:
由于缩容过程中无法确定哪个节点会被删除,因此目前不支持集群缩容。通过修改
tikv_count
来进行缩容可能会导致数据丢失。
扩容过程会持续几分钟,你可以通过以下命令来持续观察进度:
kubectl --kubeconfig credentials/kubeconfig_<gke_cluster_name> get po -n <tidb_cluster_name> --watch
例如,可以将 tidb_count
从 1 改为 2 来扩容 TiDB:
variable "tidb_count" {
description = "Number of TiDB nodes per availability zone"
default = 2
}
自定义
你可以更改 variables.tf
中的默认值,例如集群名称和镜像版本等,但更建议在 terraform.tfvars
文件或其它相关文件中来指定值。
GCP 允许 n1-standard-1
或者更大的实例类型挂载本地 SSD,这提供了更好的自定义特性。
自定义 TiDB 参数配置
Terraform 脚本为 GKE 中的 TiDB 集群提供了默认设置。你也可以在 tidbclusters.tf
中为每个 TiDB 集群指定一个覆盖配置 override_values
或者覆盖配置文件 override_values_file
。如果同时配置两个变量,override_values
配置将生效,该自定义配置会覆盖默认设置,示例如下:
override_values = <<EOF
image: pingcap/tidb-operator:v1.0.1
imagePullPolicy: IfNotPresent
resources:
limits:
cpu: 250m
memory: 150Mi
requests:
cpu: 30m
memory: 30Mi
EOF
集群默认使用 deploy/modules/gcp/tidb-cluster
模块中的 values/default.yaml
作为覆盖配置文件。
在 GKE 中,某些值不支持在 values.yaml
中自定义,包括集群版本、副本数、NodeSelector
以及 Tolerations
。NodeSelector
和 Tolerations
由 Terraform 直接管理,以确保基础设施与 TiDB 集群之间的一致性。
注意:
自定义配置中,不建议在
values.yaml
中包含以下配置(tidb-cluster
module 默认固定配置):
pd:
storageClassName: pd-ssd
tikv:
stroageClassName: local-storage
tidb:
service:
type: LoadBalancer
annotations:
cloud.google.com/load-balancer-type: "Internal"
separateSlowLog: true
monitor:
storageClassName: pd-ssd
persistent: true
grafana:
config:
GF_AUTH_ANONYMOUS_ENABLED: "true"
service:
type: LoadBalancer
自定义 TiDB Operator
如果要自定义 TiDB Operator,可以使用 operator_helm_values
变量来指定覆盖配置或者使用 operator_helm_values_file
变量来指定覆盖配置文件。如果同时配置两个变量,operator_helm_values
配置将生效,该自定义配置会传递给 tidb-operator
模块,示例如下:
operator_helm_values = <<EOF
controllerManager:
resources:
limits:
cpu: 250m
memory: 150Mi
requests:
cpu: 30m
memory: 30Mi
EOF
operator_helm_values_file = "./test-operator.yaml"
GKE 使用 作为其默认的日志收集工具,然后将日志转发到 Stackdriver。Fluentd 进程可能会占用大量资源,消耗大量的 CPU 和 RAM。Fluent Bit 是一种性能更高,资源占用更少的替代方案。与 Fluentd 相比,更建议在生产环境中使用 Fluent Bit。可参考。
自定义节点池
集群是按区域 (regional) 而非按可用区 (zonal) 来创建的。也就是说,GKE 向每个可用区复制相同的节点池,以实现更高的可用性。但对于 Grafana 这样的监控服务来说,通常没有必要维护相同的可用性。你可以通过 gcloud
手动删除节点。
注意:
GKE 节点池通过实例组管理。如果你使用
gcloud compute instances delete
命令删除某个节点,GKE 会自动重新创建节点并将其添加到集群。
如果你需要从监控节点池中删掉一个节点,可采用如下步骤:
获取托管的实例组和所在可用区。
gcloud compute instance-groups managed list | grep monitor
输出结果类似:
gke-tidb-monitor-pool-08578e18-grp us-west1-b zone gke-tidb-monitor-pool-08578e18 0 0 gke-tidb-monitor-pool-08578e18 no
gke-tidb-monitor-pool-7e31100f-grp us-west1-c zone gke-tidb-monitor-pool-7e31100f 1 1 gke-tidb-monitor-pool-7e31100f no
gke-tidb-monitor-pool-78a961e5-grp us-west1-a zone gke-tidb-monitor-pool-78a961e5 1 1 gke-tidb-monitor-pool-78a961e5 no
第一列是托管的实例组,第二列是所在的可用区。
获取实例组中的实例名字。
gcloud compute instance-groups managed list-instances <the-name-of-the-managed-instance-group> --zone <zone>
示例:
gcloud compute instance-groups managed list-instances gke-tidb-monitor-pool-08578e18-grp --zone us-west1-b
输出结果类似:
NAME ZONE STATUS ACTION INSTANCE_TEMPLATE VERSION_NAME LAST_ERROR
gke-tidb-monitor-pool-08578e18-c7vd us-west1-b RUNNING NONE gke-tidb-monitor-pool-08578e18
通过指定托管的实例组和实例的名称来删掉该实例。
例如:
gcloud compute instance-groups managed delete-instances gke-tidb-monitor-pool-08578e18-grp --instances=gke-tidb-monitor-pool-08578e18-c7vd --zone us-west1-b
如果你不想再继续使用 TiDB 集群,可以通过如下命令进行销毁:
terraform destroy
注意:
在执行
terraform destroy
过程中,可能会发生错误:Error reading Container Cluster "tidb": Cluster "tidb" has status "RECONCILING" with message""
。当 GCP 升级 Kubernetes master 节点时会出现该问题。一旦问题出现,就无法删除集群,需要等待 GCP 升级结束,再次执行terraform destroy
。
删除磁盘
如果你不再需要之前的数据,并且想要删除正在使用的磁盘,有以下两种方法可以完成此操作:
手动删除:在 Google Cloud Console 中删除磁盘,或使用
gcloud
命令行工具执行删除操作。自动删除:在执行
terraform destroy
之前将 Kubernetes 的 PV (Persistent Volume) 回收策略设置为Delete
,具体操作为在terraform destroy
之前运行以下kubectl
命令:kubectl --kubeconfig /path/to/kubeconfig/file get pvc -n namespace-of-tidb-cluster -o jsonpath='{.items[*].spec.volumeName}'|fmt -1 | xargs -I {} kubectl --kubeconfig /path/to/kubeconfig/file patch pv {} -p '{"spec":{"persistentVolumeReclaimPolicy":"Delete"}}'
上述命令将获取 TiDB 集群命名空间中的 PVC (Persistent Volume Claim),并将绑定的 PV 的回收策略设置为
Delete
。在执行terraform destroy
过程中删除 PVC 时,也会将磁盘删除。下面是一个名为
change-pv-reclaimpolicy.sh
的脚本。相对于仓库根目录来说,它在deploy/gcp
目录,简化了上述过程。./change-pv-reclaimpolicy.sh /path/to/kubeconfig/file <tidb-cluster-namespace>
管理多个 Kubernetes 集群
本节介绍管理多个 Kubernetes 集群的最佳实践,其中每个 Kubernetes 集群都可以部署一个或多个 TiDB 集群。
在 TiDB 的案例中,Terraform 模块通常结合了几个子模块:
tidb-operator
:为 TiDB 集群提供 Kubernetes Control Plane 并部署 TiDB Operator。tidb-cluster
:在目标 Kubernetes 集群中创建资源池并部署 TiDB 集群。- 一个
vpc
模块,一个bastion
模块和一个project-credentials
模块:专门用于 GKE 上的 TiDB 集群。
管理多个 Kubernetes 集群的最佳实践有以下两点:
- 为每个 Kubernetes 集群创建一个新目录。
- 根据具体需求,使用 Terraform 脚本将上述模块进行组合。
如果采用了最佳实践,集群中的 Terraform 状态不会相互干扰,并且可以很方便地管理多个 Kubernetes 集群。示例如下(假设已在项目根目录):
mkdir -p deploy/gcp-staging && \
vim deploy/gcp-staging/main.tf
deploy/gcp-staging/main.tf
中的内容类似:
如上述代码所示,你可以在每个模块调用中省略几个参数,因为有合理的默认值,并且可以轻松地自定义配置。例如,如果你不需要调用堡垒机模块,将其删除即可。
如果要自定义每个字段,可使用以下两种方法中的一种:
- 直接修改
*.tf
文件中module
的参数配置。 - 参考每个模块的
variables.tf
文件,了解所有可修改的参数,并在terraform.tfvars
中设置自定义值。