Setting Up the values.yaml File

The values.yaml file is the configuration file for an application that is deployed through Helm. The values.yaml file allows you to configure your Connectware installation. For example, edit deployment parameters, manage resources, and update your Connectware to a new version.

In this documentation, we will focus on a basic Kubernetes configuration and commonly used parameters.

Note: We recommend that you store the values.yaml file in a version control system.

Creating a Copy of the Default values.yaml File

A Helm chart contains a default configuration. It is likely that you only need to customize some of the configuration parameters. We recommend that you create a copy of the default values.yaml file named default-values.yaml and a new, empty values.yaml file to customize specific parameters.

• Enter the following code to extract the default values and store them in a file named default-values.yaml.

Example

helm show values cybus/connectware > default-values.yaml
Code-Sprache: YAML (yaml)

Creating a values.yaml File

When you have created the default-values.yaml file, you can create the values.yaml file to add your custom configuration parameters.

• Enter the following code. Substitute the editor vi with your preferred editor.

Example

vi values.yaml
Code-Sprache: YAML (yaml)

Specifying the License Key

To install Connectware, you need a valid license key.

• In the values.yaml file, specify the license key in the Helm value global.licenseKey.

Example

global:
licensekey: cY9HiVZJs8aJHG1NVOiAcrqC_ # example value
Code-Sprache: YAML (yaml)

Specifying the Broker Cluster Secret

You must specify a secret for the broker cluster. The cluster secret value is used to secure your broker cluster, just like a password.

Important: Treat the broker cluster secret with the same level of care as a password.

• In the values.yaml file, specify the broker cluster secret in the Helm value global.broker.clusterSecret.

Example

global:
 licensekey: cY9HiVZJs8aJHG1NVOiAcrqC_ # example value
broker:
 clusterSecret: Uhoo:RahShie6goh # example value
Code-Sprache: YAML (yaml)

Allowing Immutable Labels

For a fresh Connectware installation, we recommend that you set best-practice labels on immutable workload objects like StatefulSet volumes.

• In the values.yaml file, set the Helm value global.setImmutableLabels to true.

Example

global:
licensekey: cY9HiVZJs8aJHG1NVOiAcrqC_ # example value
broker:
clusterSecret: Uhoo:RahShie6goh # example value
setImmutableLabels: true
Code-Sprache: YAML (yaml)

Specifying the Broker Cluster Replica Count (Optional)

By default, Connectware uses three nodes for the broker cluster that moves data. You can specify a custom number of broker nodes. For example, increase the broker nodes to handle higher data loads or decrease the broker nodes for a testing environment. 

• In the values.yaml file, specify the number of broker nodes in the Helm value global.broker.replicaCount.

Example

global:
licensekey: cY9HiVZJs8aJHG1NVOiAcrqC_ # example value
broker:
 clusterSecret: Uhoo:RahShie6goh # example value
 replicaCount: 5
setImmutableLabels: true
 clusterSecret: ahciaruighai_t2G # example value
Code-Sprache: YAML (yaml)

Activating a Separate Control-Plane Broker (Optional)

By default, Connectware uses the same broker for data payload processing and control-plane communication. You can use a separate control-plane broker. This might be useful for production environments, as it provides higher resilience and better manageability in cases of the data broker becoming slow to respond due to high load.

1. In the values.yaml file, set the Helm value global.controlPlaneBroker.enabled to true.
2. Specify a broker cluster secret in the Helm value global.controlPlaneBroker.clusterSecret.

Important: Treat the broker cluster secret with the same level of care as a password.

Example

global:
licensekey: cY9HiVZJs8aJHG1NVOiAcrqC_ # example value
broker:
 clusterSecret: Uhoo:RahShie6goh # example value
setImmutableLabels: true
controlPlaneBroker:
 enabled: true
 clusterSecret: ahciaruighai_t2G # example value
Code-Sprache: YAML (yaml)

Tipp: You can activate/deactivate this option within a scheduled maintenance window.

Specifying Which StorageClass Connectware Should Use (Optional)

A broker cluster can contain several Kubernetes StorageClasses. You can specify which StorageClass Connectware should use.

• In the values.yaml file, specify the StorageClass in the Helm value global.storage.storageClassName.

Example

global:
 licensekey: cY9HiVZJs8aJHG1NVOiAcrqC_ # example value
broker:
 clusterSecret: Uhoo:RahShie6goh # example value
setImmutableLabels: true
storage:
 storageClassName: gp2 # example value
Code-Sprache: YAML (yaml)

There are several configuration parameters to control the StorageClass of each volume that Connectware uses.

Specifying CPU and Memory Resources (Optional)

By default, Connectware is configured for high-performance systems and according to the guaranteed Quality of Service (QoS) class. However, you can use the Kubernetes resource management values requests and limits to specify the CPU and memory resources that Connectware is allowed to use.

Important: Adjusting CPU and memory resources can impact the performance and availability of Connectware. When you customize the settings for CPU and memory resources, make sure that you monitor the performance and make adjustments if necessary.

• In the values.yaml file, specify the CPU and memory limits and requests in the Helm value global.podResources. Specify the limits and requests as Kubernetes quantities.
• You can use the default values shipped with Connectware as a starting point. You can find these in your default-values.yaml file you created earlier.

Example

global:
licensekey: cY9HiVZJs8aJHG1NVOiAcrqC_ # example value
broker:
    clusterSecret: Uhoo:RahShie6goh # example value
  setImmutableLabels: true
  podResources:
    distributedProtocolMapper:
      limits:
        cpu: 2000m
        memory: 3000Mi
      requests:
        cpu: 1500m
        memory: 1500Mi
Code-Sprache: YAML (yaml)

Related Links

• Quality of service for pods (Kubernetes documentation)
• Kubernetes resource management (Kubernetes documentation)
• Quantities (Kubernetes documentation)