跳到主要内容

创建并连接 ApeCloud MySQL 集群

本文档展示如何创建并连接到 ApeCloud MySQL 集群。

创建并连接到 ApeCloud MySQL 集群​

开始之前​

  • 如果您想通过 kbcli 创建并连接 ApeCloud MySQL 集群，请先安装 kbcli。

  • 安装 KubeBlocks，可通过 kbcli 或者 Helm 安装。

  • 确保 ApeCloud MySQL 引擎已启用。KubeBlocks 默认已安装 ApeCloud MySQL，如果您在安装 KubeBlocks 关闭/卸载了该引擎，可参考相关文档，再次启用/安装该引擎，可通过 kbcli 或者 Helm 操作。

    kubectl get addons.extensions.kubeblocks.io apecloud-mysql
    >
    NAME             TYPE   VERSION   PROVIDER   STATUS    AGE
    apecloud-mysql   Helm                        Enabled   61m

  • 查看可用于创建集群的数据库类型和版本。

    确认 apecloud-mysql cluster definition 是否已安装。

    kubectl get clusterdefinition apecloud-mysql
    >
    NAME             TOPOLOGIES   SERVICEREFS   STATUS      AGE
    apecloud-mysql                              Available   85m

    查看可用于创建集群的版本。

    kubectl get clusterversions -l clusterdefinition.kubeblocks.io/name=apecloud-mysql
    >
    NAME                CLUSTER-DEFINITION   STATUS      AGE
    ac-mysql-8.0.30     apecloud-mysql       Available   85m

  • 为保持隔离，本教程中创建一个名为 demo 的独立命名空间。

    kubectl create namespace demo

创建集群​

KubeBlocks 支持创建两种类型的 ApeCloud MySQL 集群：单机版（Standalone）和集群版（RaftGroup）。单机版仅支持一个副本，适用于对可用性要求较低的场景。 集群版包含三个副本，适用于对高可用性要求较高的场景。为了确保高可用性，所有的副本都默认分布在不同的节点上。

  1. 创建 ApeCloud MySQL 集群。

    KubeBlocks 通过 Cluster 定义集群。以下是创建 ApeCloud MySQL 集群版的示例。

    如果您只有一个节点可用于部署集群版，可将 spec.affinity.topologyKeys 设置为 null。但生产环境中，不建议将所有副本部署在同一个节点上，因为这可能会降低集群的可用性。

    cat <<EOF | kubectl apply -f -
    apiVersion: apps.kubeblocks.io/v1alpha1
    kind: Cluster
    metadata:
      name: mycluster
      namespace: default
    spec:
      clusterDefinitionRef: apecloud-mysql
      clusterVersionRef: ac-mysql-8.0.30
      terminationPolicy: Delete
      affinity:
        podAntiAffinity: Preferred
        topologyKeys:
        - kubernetes.io/hostname
      tolerations:
        - key: kb-data
          operator: Equal
          value: 'true'
          effect: NoSchedule
      componentSpecs:
      - name: mysql
        componentDefRef: mysql
        enabledLogs:
        - error
        - general
        - slow
        disableExporter: true
        replicas: 3
        serviceAccountName: kb-acmysql-cluster
        resources:
          limits:
            cpu: '0.5'
            memory: 0.5Gi
          requests:
            cpu: '0.5'
            memory: 0.5Gi
        volumeClaimTemplates:
        - name: data
          spec:
            accessModes:
            - ReadWriteOnce
            resources:
              requests:
                storage: 20Gi
    EOF
    字段定义
    spec.clusterDefinitionRef集群定义 CRD 的名称，用来定义集群组件。
    spec.clusterVersionRef集群版本 CRD 的名称，用来定义集群版本。
    spec.terminationPolicy集群的终止策略，默认值为 Delete，有效值为 DoNotTerminate、Delete 和 WipeOut。具体定义可参考 终止策略。
    spec.affinity为集群的 Pods 定义了一组节点亲和性调度规则。该字段可控制 Pods 在集群中节点上的分布。
    spec.affinity.podAntiAffinity定义了不在同一 component 中的 Pods 的反亲和性水平。该字段决定了 Pods 以何种方式跨节点分布，以提升可用性和性能。
    spec.affinity.topologyKeys用于定义 Pod 反亲和性和 Pod 分布约束的拓扑域的节点标签值。
    spec.tolerations该字段为数组，用于定义集群中 Pods 的容忍，确保 Pod 可被调度到具有匹配污点的节点上。
    spec.componentSpecs集群 components 列表，定义了集群 components。该字段允许对集群中的每个 component 进行自定义配置。
    spec.componentSpecs.componentDefRef表示 cluster definition 中定义的 component definition 的名称，可通过执行 kubectl get clusterdefinition apecloud-mysql -o json \| jq '.spec.componentDefs[].name' 命令获取 component definition 名称。
    spec.componentSpecs.name定义了 component 的名称。
    spec.componentSpecs.disableExporter定义了是否开启监控功能。
    spec.componentSpecs.replicas定义了 component 中 replicas 的数量。
    spec.componentSpecs.resources定义了 component 的资源要求。

    KubeBlocks operator 监控 Cluster CRD 并创建集群和全部依赖资源。您可执行以下命令获取集群创建的所有资源信息。

    kubectl get all,secret,rolebinding,serviceaccount -l app.kubernetes.io/instance=mycluster -n demo

    执行以下命令，查看已创建的 ApeCloud MySQL 集群的 YAML 文件：

    kubectl get cluster mycluster -n demo -o yaml

  2. 查看集群是否创建成功。

    kubectl get cluster mycluster -n demo
    >
    NAME        CLUSTER-DEFINITION   VERSION           TERMINATION-POLICY   STATUS    AGE
    mycluster   apecloud-mysql       ac-mysql-8.0.30   Delete               Running   12m

连接集群​

使用 kubectl exec 命令进入 Pod 并连接到数据库。

KubeBlocks operator 会创建一个名为 mycluster-conn-credential 的新的 Secret 来存储集群的连接凭证。该 Secret 包含以下 key：

  • username：集群的根用户名。
  • password：根用户的密码。
  • port：集群的端口。
  • host：集群的主机。
  • endpoint：集群的终端节点，与 host:port 相同。

  1. 获取用于 kubectl exec 命令的 username 和 password。

    kubectl get secrets -n demo mycluster-conn-credential -o jsonpath='{.data.username}' | base64 -d
    >
    root

    kubectl get secrets -n demo mycluster-conn-credential -o jsonpath='{.data.password}' | base64 -d
    >
    2gvztbvz

  2. 使用用户名和密码，进入 Pod mycluster-mysql-0 并连接到数据库。

    kubectl exec -ti -n demo mycluster-mysql-0 -- bash

    mysql -uroot -p2gvztbvz

有关详细的数据库连接指南，请参考连接数据库。