Configure cluster parameters

This guide shows how to configure cluster parameters.

Before you start

1. Install KubeBlocks.
2. Create a Kafka cluster.

Configure cluster parameters by editing configuration file

1. Get the configuration file of this cluster.

   kubectl get configurations.apps.kubeblocks.io -n demo
   
   kubectl edit configurations.apps.kubeblocks.io mycluster-kafka-combine -n demo

2. Configure parameters according to your needs. The example below adds the spec.configFileParams part to configure log.cleanup.policy.

   spec:
     clusterRef: mycluster
     componentName: kafka
     configItemDetails:
     - configFileParams:
         server.properties:
           parameters:
             log.cleanup.policy: "compact"
       configSpec:
         constraintRef: kafka-cc
         name: kafka-configuration-tpl
         namespace: kb-system
         templateRef: kafka-configuration-tpl
         volumeName: kafka-config
       name: kafka-configuration-tpl

3. Connect to this cluster to verify whether the configuration takes effect as expected.

   kbcli cluster describe-config mycluster --show-detail | grep log.cleanup.policy
   >
   log.cleanup.policy = compact
   mycluster-reconfiguring-wvqns   mycluster   broker      kafka-configuration-tpl   server.properties   Succeed   restart   1/1        May 10,2024 16:28 UTC+0800   {"server.properties":"{\"log.cleanup.policy\":\"compact\"}"}

Configure cluster parameters with OpsRequest

1. Define an OpsRequest file and configure the parameters in the OpsRequest in a yaml file named mycluster-configuring-demo.yaml. In this example, log.cleanup.policy is configured as compact.

   apiVersion: apps.kubeblocks.io/v1alpha1
   kind: OpsRequest
   metadata:
     name: mycluster-configuring-demo
     namespace: demo
   spec:
     clusterName: mycluster
     reconfigure:
       componentName: kafka
       configurations:
       - keys:
         - key: server.properties
           parameters:
           - key: log.cleanup.policy
             value: "compact"
         name: kafka-configuration-tpl
     preConditionDeadlineSeconds: 0
     type: Reconfiguring
   EOF

   Field	Definition
   metadata.name	It specifies the name of this OpsRequest.
   metadata.namespace	It specifies the namespace where this cluster is created.
   spec.clusterName	It specifies the cluster name that this operation is targeted at.
   spec.reconfigure	It specifies a component and its configuration updates.
   spec.reconfigure.componentName	It specifies the component name of this cluster.
   spec.configurations	It contains a list of ConfigurationItem objects, specifying the component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
   spec.reconfigure.configurations.keys.key	It specifies the configuration map.
   spec.reconfigure.configurations.keys.parameters	It defines a list of key-value pairs for a single configuration file.
   spec.reconfigure.configurations.keys.parameter.key	It represents the name of the parameter you want to edit.
   spec.reconfigure.configurations.keys.parameter.value	It represents the parameter values that are to be updated. If set to nil, the parameter defined by the Key field will be removed from the configuration file.
   spec.reconfigure.configurations.name	It specifies the configuration template name.
   preConditionDeadlineSeconds	It specifies the maximum number of seconds this OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.

2. Apply the configuration opsRequest.

   kubectl apply -f mycluster-configuring-demo.yaml

3. Verify whether the configuration takes effect as expected.

   kbcli cluster describe-config mycluster --show-detail | grep log.cleanup.policy
   >
   log.cleanup.policy = compact

note

Just in case you cannot find the configuration file of your cluster, you can use kbcli to view the current configuration file of a cluster.

kbcli cluster describe-config mycluster -n demo

From the meta information, the cluster mycluster has a configuration file named kafka.conf.

You can also view the details of this configuration file and parameters.

• View the details of the current configuration file.

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

• View the parameter description.

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

• View the user guide of a specified parameter.

  kbcli cluster explain-config mycluster --param=log.cleanup.policy

  --config-specs is required to specify a configuration template since ApeCloud MySQL currently supports multiple templates. You can run kbcli cluster describe-config mycluster to view the all template names.

  Output

  template meta:
    ConfigSpec: kafka-configuration-tpl   ComponentName: kafka-combine    ClusterName: mycluster
  
  Configure Constraint:
    Parameter Name:     log.cleanup.policy
    Allowed Values:     "compact","delete"
    Scope:              Global
    Dynamic:            false
    Type:               string
    Description:        The default cleanup policy for segments beyond the retention window. A comma separated list of valid policies. 
  • Allowed Values: It defines the valid value range of this parameter.
  • Dynamic: The value of Dynamic in Configure Constraint defines how the parameter configuration takes effect. There are two different configuration strategies based on the effectiveness type of modified parameters, i.e. dynamic and static.
    • When Dynamic is true, it means the effectiveness type of parameters is dynamic and can be configured online.
    • When Dynamic is false, it means the effectiveness type of parameters is static and a pod restarting is required to make the configuration effective.
  • Description: It describes the parameter definition.