创建并连接到 MongoDB 集群
本文档展示如何创建并连接到一个 MongoDB 集群。
创建 MongoDB 集群
开始之前
-
如果您想通过
kbcli创建并连接 MongoDB 集群,请先安 装 kbcli。 -
确保 MongoDB 引擎已启用。如果引擎未安装/启用,可参考相关文档,安装/启用该引擎。
- kubectl
- kbcli
kubectl get addons.extensions.kubeblocks.io mongodb
>
NAME TYPE VERSION PROVIDER STATUS AGE
mongodb Helm Enabled 23mkbcli addon list
>
NAME TYPE STATUS EXTRAS AUTO-INSTALL
...
mongodb Helm Enabled true
... -
查看可用于创建集群的数据库类型和版本。
- kubectl
- kbcli
kubectl get clusterdefinition mongodb
>
NAME TOPOLOGIES SERVICEREFS STATUS AGE
mongodb Available 23mkubectl get clusterversions -l clusterdefinition.kubeblocks.io/name=mongodbkbcli clusterdefinition list
kbcli clusterversion list -
为了保持隔离,本文档中创建一个名为
demo的独立命名空间。kubectl create namespace demo
>
namespace/demo created
创建集群
KubeBlocks 支持创建两种 MongoDB 集群:单机版(Standalone)和主备版(ReplicaSet)。MongoDB 单机版仅支持一个副本,适用于对可用性要求较低的场景。对于高可用性要求较高的场景,建议创建主备版集群,以支持自动故障切换。为了确保高可用性,所有的副本都默认分布在不同的节点上。
- kubectl
- kbcli
-
创建 MongoDB 集群。
KubeBlocks 通过
Cluster定义集群。以下是创建 MongoDB 单机版的示例。cat <<EOF | kubectl apply -f -
apiVersion: apps.kubeblocks.io/v1alpha1
kind: Cluster
metadata:
name: mycluster
namespace: demo
spec:
terminationPolicy: Delete
affinity:
podAntiAffinity: Preferred
topologyKeys:
- kubernetes.io/hostname
tolerations:
- key: kb-data
operator: Equal
value: 'true'
effect: NoSchedule
componentSpecs:
- name: mongodb
componentDef: mongodb
replicas: 3
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.terminationPolicy集群的终止策略,默认值为 Delete,有效值为DoNotTerminate、Halt、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 mongodb -o json | jq '.spec.componentDefs[].name'命令获取 component definition 名称。spec.componentSpecs.name定义了 component 的名称。 spec.componentSpecs.replicas定义了 component 中 replicas 的数量。 spec.componentSpecs.resources定义了 component 的资源要求。 KubeBlocks operator 监控
ClusterCRD 并创建集群和全部依赖资源。您可执行以下命令获取集群创建的所有资源信息。kubectl get all,secret,rolebinding,serviceaccount -l app.kubernetes.io/instance=mycluster -n demo执行以下命令,查看已创建的 MongoDB 集群:
kubectl get cluster mycluster -n demo -o yaml -
验证集群是否创建成功。
kubectl get cluster mycluster -n demo
-
创建 MongoDB 集群。
kbcli cluster create mongodb mycluster -n demo如果您需要自定义集群规格,kbcli 也提供了诸多参 数,如支持设置引擎版本、终止策略、CPU、内存规格。您可通过在命令结尾添加
--help或-h来查看具体说明。比如,kbcli cluster create mongodb --help
kbcli cluster create mongodb -h例如,您可使用
--mode指定集群形态,创建 MongoDB 主备版。kbcli cluster create mongodb mycluster --mode replicaset -n demo如果只有一个节点用于部署主备版集群,请在创建集群时将
availability-policy设置为none。但需要注意的是,生产环境中,不建议将所有副本部署在同一个节点上,因为这可能会降低集群的可用性。kbcli cluster create mongodb mycluster --mode replicaset --availability-policy none -n demo -
验证集群是否创建成功。
kbcli cluster list -n demo
>
NAME NAMESPACE CLUSTER-DEFINITION VERSION TERMINATION-POLICY STATUS CREATED-TIME
mycluster demo mongodb mongodb-7.0.12 Delete Running Sep 19,2024 16:01 UTC+0800
连接到 MongoDB 集群
- kubectl
- port-forward
- kbcli
使用 kubectl exec 命令进入 Pod 并连接到数据库。
KubeBlocks operator 会创建一个名为 mycluster-conn-credential 的新的 Secret 来存储 MongoDB 集群的连接凭证。该 Secret 包含以下 key:
username:集群的根用户名。password:根用户的密码。port:集群的端口。host:集群的主机。endpoint:集群的终端节点,与host:port相同。
-
获取用于
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
>
266zfqx5 -
使用用户名和密码,进入 Pod
mycluster-mongodb-0并连接到数据库。kubectl exec -ti -n demo mycluster-mongodb-0 -- bash
root@mycluster-mongodb-0:/# mongo --username root --password 266zfqx5 --authenticationDatabase admin
还可以使用端口转发在本地计算机上连接数据库。
-
通过端口转发服务。
kubectl port-forward -n demo svc/mycluster-mongodb 27017:27017 -
在新的终端窗口中执行以下命令,连接到数据库。
root@mycluster-mongodb-0:/# mongo --username root --password 266zfqx5 --authenticationDatabase admin
kbcli cluster connect mycluster --namespace demo
有关详细的数据库连接指南,请参考连接数据库。