升级 TiDB Operator

本文介绍如何升级 TiDB Operator 到指定版本。你可以选择在线升级离线升级

升级注意事项

  1. 如果使用 v1.3.0-beta.1 及更早版本的 TiDB Operator 跨 Kubernetes 集群部署 TiDB 集群,直接升级 TiDB Operator 会导致集群滚动更新并进入异常状态。如果从更早版本升级 TiDB Operator 到 v1.3,你需要执行以下操作:

    1. 更新 CRD。
    2. 修改 TidbCluster 定义将 spec.acrossK8s 字段设置为 true
    3. 升级 TiDB Operator。
  2. 弃用 Pod ValidatingWebhookMutatingWebhook。如果使用 v1.2 及更早版本的 TiDB Operator 在集群部署了 Webhook,并启用了 Pod ValidatingWebhookMutatingWebhook,升级 TiDB Operator 到 v1.3.0-beta.1 及之后版本,Pod ValidatingWebhookMutatingWebhook 被删除,但这不会对 TiDB 集群管理产生影响,也不会影响正在运行的 TiDB 集群。

在线升级

如果服务器可以访问外网,你可以按照以下步骤在线升级 TiDB Operator:

  1. 升级 TiDB Operator 前,确保 Helm repo 包含你需要升级的 TiDB Operator 版本。通过以下命令查看 Helm repo 包含的 TiDB Operator 版本:

    helm search repo -l tidb-operator
    

    如果输出中未包含你需要的新版本,可以使用 helm repo update 命令更新 repo。详情请参考配置 Helm repo

  2. 更新 Kubernetes 的 CustomResourceDefinition (CRD)。关于 CRD 的更多信息,请参阅 CustomResourceDefinition

    • 如果 Kubernetes 版本大于等于 1.16:

      1. 如果 TiDB Operator 从 v1.2.x 及更早版本升级到 v1.3.x 及以后版本,需要先执行下面命令创建新增加的 TidbNGMonitoring CRD。如果是 v1.3.x 及以后版本的 TiDB Operator 升级,可跳过这一步。

        kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/${operator_version}/manifests/crd/v1/pingcap.com_tidbngmonitorings.yaml
        
      2. 更新 CRD。

        kubectl replace -f https://raw.githubusercontent.com/pingcap/tidb-operator/${operator_version}/manifests/crd.yaml && \
        kubectl get crd tidbclusters.pingcap.com
        
    • 如果 Kubernetes 版本小于 1.16:

      1. 如果 TiDB Operator 从 v1.2.x 及更早版本升级到 v1.3.x 及以后版本,需要先执行下面命令创建新增加的 TidbNGMonitoring CRD。如果是 v1.3.x 及以后版本的 TiDB Operator 升级,可跳过这一步。

        kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/${operator_version}/manifests/crd/v1beta1/pingcap.com_tidbngmonitorings.yaml
        
      2. 更新 CRD。

        kubectl replace -f https://raw.githubusercontent.com/pingcap/tidb-operator/${operator_version}/manifests/crd_v1beta1.yaml && \
        kubectl get crd tidbclusters.pingcap.com
        

    本文以 TiDB Operator v1.4.0-beta.3 为例,你需要替换 ${operator_version} 为你要升级到的 TiDB Operator 版本。

  3. 获取你要升级的 tidb-operator chart 中的 values.yaml 文件:

    mkdir -p ${HOME}/tidb-operator/v1.4.0-beta.3 && \
    helm inspect values pingcap/tidb-operator --version=v1.4.0-beta.3 > ${HOME}/tidb-operator/v1.4.0-beta.3/values-tidb-operator.yaml
    
  4. 修改 ${HOME}/tidb-operator/v1.4.0-beta.3/values-tidb-operator.yamloperatorImage 镜像版本为要升级到的版本。

  5. 如果你在旧版本 values.yaml 中设置了自定义配置,将自定义配置合并到 ${HOME}/tidb-operator/v1.4.0-beta.3/values-tidb-operator.yaml 中。

  6. 执行升级:

    helm upgrade tidb-operator pingcap/tidb-operator --version=v1.4.0-beta.3 -f ${HOME}/tidb-operator/v1.4.0-beta.3/values-tidb-operator.yaml
    
  7. Pod 全部正常启动之后,运行以下命令确认 TiDB Operator 镜像版本:

    kubectl get po -n tidb-admin -l app.kubernetes.io/instance=tidb-operator -o yaml | grep 'image:.*operator:'
    

    如果输出类似下方的结果,则表示升级成功。其中,v1.4.0-beta.3 表示已升级到的版本号。

    image: pingcap/tidb-operator:v1.4.0-beta.3
    image: docker.io/pingcap/tidb-operator:v1.4.0-beta.3
    image: pingcap/tidb-operator:v1.4.0-beta.3
    image: docker.io/pingcap/tidb-operator:v1.4.0-beta.3
    

离线升级

如果服务器没有连接外网,你可以按照以下步骤离线升级 TiDB Operator:

  1. 使用有外网的机器,下载升级所需的文件和镜像。

    1. 下载 TiDB Operator 需要的 crd.yaml 文件。关于 CRD 的更多信息,请参阅 CustomResourceDefinition

      • 如果 Kubernetes 版本大于等于 1.16:

        wget -O crd.yaml https://raw.githubusercontent.com/pingcap/tidb-operator/${operator_version}/manifests/crd.yaml
        
      • 如果 Kubernetes 版本小于 1.16:

        wget -O crd.yaml https://raw.githubusercontent.com/pingcap/tidb-operator/${operator_version}/manifests/crd_v1beta1.yaml
        

      本文以 TiDB Operator v1.4.0-beta.3 为例,你需要替换 ${operator_version} 为你要升级到的 TiDB Operator 版本。

    2. 下载 tidb-operator chart 包文件:

      wget http://charts.pingcap.org/tidb-operator-v1.4.0-beta.3.tgz
      
    3. 下载 TiDB Operator 升级所需的 Docker 镜像:

      docker pull pingcap/tidb-operator:v1.4.0-beta.3
      docker pull pingcap/tidb-backup-manager:v1.4.0-beta.3
      
      docker save -o tidb-operator-v1.4.0-beta.3.tar pingcap/tidb-operator:v1.4.0-beta.3
      docker save -o tidb-backup-manager-v1.4.0-beta.3.tar pingcap/tidb-backup-manager:v1.4.0-beta.3
      
  2. 将下载的文件和镜像上传到需要升级的服务器上,在服务器上按照以下步骤进行安装:

    1. 如果 TiDB Operator 从 v1.2.x 及更早版本升级到 v1.3.x 及以后版本,需要先执行下面命令创建新增加的 TidbNGMonitoring CRD。如果是 v1.3.x 及以后版本的 TiDB Operator 升级,可跳过这一步。

      kubectl create -f ./crd.yaml
      

      对于其他 CRD,执行该命令时会报 "AlreadyExists" 的错误,可以忽略该错误。

    2. 升级 TiDB Operator 需要的 crd.yaml 文件:

      kubectl replace -f ./crd.yaml
      
    3. 解压 tidb-operator chart 包文件,并拷贝 values.yaml 文件到升级目录:

      tar zxvf tidb-operator-v1.4.0-beta.3.tgz && \
      mkdir -p ${HOME}/tidb-operator/v1.4.0-beta.3 && \
      cp tidb-operator/values.yaml ${HOME}/tidb-operator/v1.4.0-beta.3/values-tidb-operator.yaml
      
    4. 安装 Docker 镜像到服务器上:

      docker load -i tidb-operator-v1.4.0-beta.3.tar && \
      docker load -i tidb-backup-manager-v1.4.0-beta.3.tar
      
  3. 修改 ${HOME}/tidb-operator/v1.4.0-beta.3/values-tidb-operator.yamloperatorImage 镜像版本为要升级到的版本。

  4. 如果你在旧版本 values.yaml 中设置了自定义配置,将自定义配置合并到 ${HOME}/tidb-operator/v1.4.0-beta.3/values-tidb-operator.yaml 中。

  5. 执行升级:

    helm upgrade tidb-operator ./tidb-operator --version=v1.4.0-beta.3 -f ${HOME}/tidb-operator/v1.4.0-beta.3/values-tidb-operator.yaml
    
  6. Pod 全部正常启动之后,运行以下命令确认 TiDB Operator 镜像版本:

    kubectl get po -n tidb-admin -l app.kubernetes.io/instance=tidb-operator -o yaml | grep 'image:.*operator:'
    

    如果输出类似下方的结果,则表示升级成功。其中,v1.4.0-beta.3 表示已升级到的版本号。

    image: pingcap/tidb-operator:v1.4.0-beta.3
    image: docker.io/pingcap/tidb-operator:v1.4.0-beta.3
    image: pingcap/tidb-operator:v1.4.0-beta.3
    image: docker.io/pingcap/tidb-operator:v1.4.0-beta.3
    
下载 PDF文档反馈社区交流
文档内容是否有帮助?
产品
TiDB
学习
客户案例
PingCAP Education
TiDB in Action
© 2022 PingCAP. All Rights Reserved.