配置集群参数

本文档演示了如何配置集群参数。

开始之前

安装 KubeBlocks。
创建 Redis 集群。

通过编辑配置文件配置参数

获取集群的配置文件。

kubectl edit configurations.apps.kubeblocks.io mycluster-redis -n demo

按需配置参数。以下实例中添加了 spec.configFileParams，用于配置 acllog-max-len 参数。

spec:
  clusterRef: mycluster
  componentName: redis
  configItemDetails:
  - configSpec:
      constraintRef: redis7-config-constraints
      name: redis-replication-config
      namespace: kb-system
      reRenderResourceTypes:
      - vscale
      templateRef: redis7-config-template
      volumeName: redis-config
  - configFileParams:
      redis.conf:
        parameters:
          acllog-max-len: "256"
    name: mycluster-redis-redis-replication-config

连接集群，确认配置是否生效。

获取用户名和密码。

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

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

连接集群，验证参数是否按预期配置。

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

root@mycluster-redis-0:/# redis-cli -a kpz77mcs  --user default

127.0.0.1:6379> config get parameter acllog-max-len
1) "acllog-max-len"
2) "256"

通过 OpsRerquest 配置参数

在名为 mycluster-configuring-demo.yaml 的 YAML 文件中定义 OpsRequest，并修改参数。如下示例中，acllog-max-len 参数修改为 256。

apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: mycluster-configuring-demo
  namespace: demo
spec:
  clusterName: mycluster
  reconfigure:
    componentName: redis
    configurations:
    - keys:
      - key: redis.conf
        parameters:
        - key: acllog-max-len
          value: "256"
      name: redis-replication-config
  preConditionDeadlineSeconds: 0
  type: Reconfiguring

字段	定义
`metadata.name`	定义了 Opsrequest 的名称。
`metadata.namespace`	定义了集群所在的 namespace。
`spec.clusterName`	定义了本次运维操作指向的集群名称。
`spec.reconfigure`	定义了需配置的 component 及相关配置更新内容。
`spec.reconfigure.componentName`	定义了改集群的 component 名称。
`spec.configurations`	包含一系列 ConfigurationItem 对象，定义了 component 的配置模板名称、更新策略、参数键值对。
`spec.reconfigure.configurations.keys.key`	定义了 configuration map。
`spec.reconfigure.configurations.keys.parameters`	定义了单个参数文件的键值对列表。
`spec.reconfigure.configurations.keys.parameter.key`	代表您需要编辑的参数名称。
`spec.reconfigure.configurations.keys.parameter.value`	代表了将要更新的参数值。如果设置为 nil，Key 字段定义的参数将会被移出配置文件。
`spec.reconfigure.configurations.name`	定义了配置模板名称。
`preConditionDeadlineSeconds`	定义了本次 OpsRequest 中止之前，满足其启动条件的最长等待时间（单位为秒）。如果设置为 0（默认），则必须立即满足启动条件，OpsRequest 才能继续。

应用配置 OpsRequest。

kubectl apply -f mycluster-configuring-demo.yaml

连接集群，确认配置是否生效。

获取用户名和密码。

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

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

连接集群，验证参数是否按预期配置。

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

root@mycluster-redis-0:/# redis-cli -a kpz77mcs  --user default

127.0.0.1:6379> config get parameter acllog-max-len
1) "acllog-max-len"
2) "256"

备注

如果您无法找到集群的配置文件，您可以使用 kbcli 查看集群当前的配置文件。

kbcli cluster describe-config mycluster -n demo

从元信息中可以看到集群 mycluster 的配置文件。

你也可以查看此配置文件和参数的详细信息。

查看当前配置文件的详细信息。

kbcli cluster describe-config mycluster --show-detail -n demo

查看参数描述。

kbcli cluster explain-config mycluster -n demo | head -n 20

查看指定参数的使用文档。

kbcli cluster explain-config mycluster --param=acllog-max-len  -n demo

输出

component: redis
template meta:
  ConfigSpec: redis-replication-config  ComponentName: redis    ClusterName: mycluster

Configure Constraint:
  Parameter Name:     acllog-max-len
  Allowed Values:     [1-10000]
  Scope:              Global
  Dynamic:            true
  Type:               integer
  Description:    

Allowed Values：定义了参数的有效值范围。
Dynamic: 决定了参数配置的生效方式。根据被修改参数的生效类型，有动态和静态两种不同的配置策略。
- Dynamic 为 true 时，参数动态生效，可在线配置。
- Dynamic 为 false 时，参数静态生效，需要重新启动 Pod 才能生效。
Description：描述了参数的定义。

配置集群参数

开始之前​

通过编辑配置文件配置参数​

通过 OpsRerquest 配置参数​

开始之前

通过编辑配置文件配置参数

通过 OpsRerquest 配置参数