Deploy configuration changes to a DataStax Enterprise (DSE) cluster

To make a configuration change, modify and submit the MissionControlCluster manifest (object) that matches your release.

This section partially covers configuration options and their values. An example workflow and specific guidance for key configuration topics are provided.

K8ssandra enables authentication and authorization by default. It uses the Cassandra default PasswordAuthenticator and CassandraAuthorizer functionality.

Explore topic-specific configuration:

Performance impact

Increasing the heap size parameter that is used by all objects in the cluster may increase the time it takes to find, process, and collect objects included in the heap.

Timeout settings are adjusted to increase throughput and maintain near ideal requests per second, yielding better performance.

Example of a configuration change

This example uses resource_name.kind.yaml as the filename of the Custom Resource (CR). See MissionControlCluster CRD definition file that matches your release. In the appropriate CRD file, increase the heap size and adjust both the write_request_timeout_in_ms and read_request_timeout_in_ms settings. Then deploy these configuration changes to a Control Plane Kubernetes cluster.

In this example a Kubernetes cluster exists with a certain number of nodes. The amount of memory allocated to the Java Virtual Machine (JVM) needs to increase. This memory is shared by instances of all the objects created during the runtime of an application.

The heap value is determined by the amount of memory available to the container and should be set to, at a maximum, half of the requested memory. See heap size parameter guidelines and recommendations.

Workflow of user and operators

  1. User submits a modified MissionControlCluster to the Control Plane cluster.

  2. Cluster-level operator detects change, modifies datacenter-level resource (CassandraDatacenter).

  3. Datacenter-level operator detects change, modifies rack-level resource.

  4. Datacenter-level operator terminates instance in rack.

  5. Datacenter-level operator bootstraps replacement node.

  6. Datacenter-level operator repeats steps 3-5 for all racks in the datacenter.

  7. Cluster-level operator repeats steps 2-6 for all datacenters in the cluster.

Reconfigure a DSE cluster

Two Kubernetes clusters exist for this example, a Control Plane cluster and a Data Plane cluster.

  1. Modify the resource_name.kind.yaml file to define the MissionControlCluster config specification. Set updated heap parameters for the jvmOptions key. Increase both the initial and the maximum heap sizes from 1Gi to 2Gi. Further modify the write_request_timeout_in_ms and read_request_timeout_in_ms properties for the cassandraYaml key as follows:

    ...
    config:
        cassandraYaml:
          write_request_timeout_in_ms: 5000
          read_request_timeout_in_ms: 10000
        jvmOptions:
          heap_initial_size: 2Gi
          heap_max_size: 2Gi

    The MissionControlCluster config: specification supports 3 keys:

    1. cassandraYaml

    2. dseYaml

    3. jvmOptions

  2. Submit the modified MissionControlCluster manifest, resource_name.kind.yaml, to the Control Plane Kubernetes cluster from a terminal window.

    kubectl apply -f resource_name.cassandratask.yaml
  3. Monitor the progress of the task from the Data Plane cluster by submitting the following command:

    kubectl get cassandradatacenter dc1 -o yaml
    Sample results
    status:
      cassandraOperatorProgress: Updating
      conditions:
      - lastTransitionTime: "2022-10-19T19:08:09Z"
        message: ""
        reason: ""
        status: "True"
        type: Healthy
      - lastTransitionTime: "2022-10-19T19:08:10Z"
        message: ""
        reason: ""
        status: "False"
        type: Stopped
    ...
    - lastTransitionTime: "2022-10-19T19:10:43Z"
        message: ""
        reason: ""
        status: "True"
        type: Updating
    ...

    The status field is set to "False" when the Updating operation completes.

    Changes are applied in the same order in which the racks are declared in the MissionControlCluster manifest.

    The configuration changes are applied in a rolling fashion one rack at a time and one DSE node at a time within each rack. The changes also trigger a rolling restart as part of the update. The configuration updates take effect as soon as the update is finished.

  4. Submit the following command to check the cassandra.yaml file and verify that the update is complete:

    kubectl exec -it demo-dc1-rack1-sts-0 -c cassandra -- cat resources/cassandra/conf/cassandra.yaml | grep ^'write\|read'_request_timeout_in_ms
    Sample results
    write_request_timeout_in_ms: 5000
    read_request_timeout_in_ms: 10000
  5. Submit the following command to check the jvm-server.options file and verify that it, too, reflects the update:

    kubectl exec -it demo-dc1-rack1-sts-0 -c cassandra -- cat resources/cassandra/conf/jvm-server.options | grep ^'-Xmx\|-Xms'
    Sample results
    -Xms2147483648
    -Xmx2147483648

    The values are shown in bytes.

    Mission Control operators perform the conversion from 2Gi to the appropriate number of bytes.

What’s next

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com