跳到主要内容

创建并连接 PostgreSQL 集群

本文档展示如何创建并连接到一个 PostgreSQL 集群。

创建 PostgreSQL 集群​

开始之前​

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

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

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

    kubectl get addons.extensions.kubeblocks.io postgresql
    >
    NAME         TOPOLOGIES   SERVICEREFS   STATUS      AGE
    postgresql                              Available   30m

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

    确认 postgresql cluster definition 是否已安装。

    kubectl get clusterdefinition postgresql
    >
    NAME         TOPOLOGIES   SERVICEREFS   STATUS      AGE
    postgresql                              Available   30m

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

    kubectl get clusterversions -l clusterdefinition.kubeblocks.io/name=postgresql
    >
    NAME                 CLUSTER-DEFINITION   STATUS      AGE
    postgresql-12.14.0   postgresql           Available   30m
    postgresql-12.14.1   postgresql           Available   30m
    postgresql-12.15.0   postgresql           Available   30m
    postgresql-14.7.2    postgresql           Available   30m
    postgresql-14.8.0    postgresql           Available   30m
    postgresql-15.7.0    postgresql           Available   30m
    postgresql-16.4.0    postgresql           Available   30m

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

    kubectl create namespace demo

创建集群​

KubeBlocks 支持创建两种 PostgreSQL 集群：单机版（Standalone）和主备版（Replication）。单机版仅支持一个副本，适用于对可用性要求较低的场景。 对于高可用性要求较高的场景，建议创建集群版，以支持自动故障切换。为了确保高可用性，所有的副本都默认分布在不同的节点上。

  1. 创建 PostgreSQL 集群。

    KubeBlocks 通过 Cluster 定义集群。以下是创建 PostgreSQL 主备版的示例。

    cat <<EOF | kubectl apply -f -
    apiVersion: apps.kubeblocks.io/v1alpha1
    kind: Cluster
    metadata:
      name: mycluster
      namespace: demo
    spec:
      clusterDefinitionRef: postgresql
      clusterVersionRef: postgresql-14.8.0
      terminationPolicy: Delete
      affinity:
        podAntiAffinity: Preferred
        topologyKeys:
        - kubernetes.io/hostname
      tolerations:
        - key: kb-data
          operator: Equal
          value: 'true'
          effect: NoSchedule
      componentSpecs:
      - name: postgresql
        componentDefRef: postgresql
        enabledLogs:
        - running
        disableExporter: true
        replicas: 2
        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、Halt、Delete 和 WipeOut。

    - DoNotTerminate 会阻止删除操作。

    - Halt 会删除工作负载资源，如 statefulset 和 deployment 等，但是保留了 PVC 。

    - Delete 在 Halt 的基础上进一步删除了 PVC。

    - WipeOut 在 Delete 的基础上从备份存储的位置完全删除所有卷快照和快照数据。

    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 postgresql -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

    执行以下命令，查看已创建的 PostgreSQL 集群：

    kubectl get cluster mycluster -n demo -o yaml

  2. 验证集群是否创建成功。

    kubectl get cluster mycluster -n demo
    >
    NAME        CLUSTER-DEFINITION   VERSION             TERMINATION-POLICY   STATUS    AGE
    mycluster   postgresql           postgresql-14.8.0   Delete               Running   9m21s

连接到 PostgreSQL 集群​

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

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

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

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

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

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

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

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

    root@mycluster-postgresql-0:/home/postgres# psql -U postgres -W
    Password: h62rg2kl

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