Working with Cybus Helm Charts

Deploy, configure, and manage deployments using Cybus Helm charts.

The procedures below show how to deploy, configure, and manage installations using Cybus Helm charts. Many of these procedures are not specific to Cybus Helm charts but are typical operations used by Helm charts in general.

Most examples use the connectware Helm chart, but you can substitute any of the charts Cybus offers unless otherwise noted.

Obtaining the Name, Namespace, and Version of Your Installation

If you want to upgrade and configure Connectware, you must know the name, namespace, and version of your Connectware installation.

Prerequisites

• Helm version 4 is installed on your system.

• kubectl is installed on your system.

Procedure

• To display the name, namespace, and app version of your Connectware installation, enter the following command:

helm list -A

Result

The name, namespace, and version number of your Connectware installation is displayed in the NAME, NAMESPACE, and APP VERSION columns. If you have trouble locating your Connectware installation in the list, look for connectware in the CHART column.

NAME	NAMESPACE	REVISION	UPDATED	STATUS	CHART	APP VERSION
connectware	connectware	4	2022-12-01 17:04:16.664663648 +0100 CET	deployed	connectware-3.0.0	2.2.0

For the code examples in this documentation, we use the following variables:

• Name: ${INSTALLATION_NAME}

• Namespace: ${NAMESPACE}

• App version: ${VERSION}

Extracting the values.yaml File

The Helm configuration that Connectware uses is stored in the values.yaml file. You can extract the values.yaml file from your installation.

Prerequisites

• Helm version 4 is installed on your system.

• kubectl is installed on your system.

• You know the name and namespace of your Connectware installation. See Obtaining the Name, Namespace, and Version of Your Installation.

Procedure

• To extract this file from your installation, enter the following command:

helm get values ${INSTALLATION_NAME} -n ${NAMESPACE} -o yaml > values.yaml

For the code examples in this documentation, we use the variable values.yaml to refer to the currently used Helm values.

See also

• Configuring the values.yaml File

Applying Helm Configuration Changes

When you have changed the Helm configuration in your values.yaml file, you must apply the changes via a Helm upgrade.

The former configuration is overwritten when you apply the changes you have made to the values.yaml file. We recommend applying configuration changes during planned maintenance.

Prerequisites

• Helm version 4 is installed on your system.

• kubectl is installed on your system.

• You know the name and namespace of your Connectware installation. See Obtaining the Name, Namespace, and Version of Your Installation.

• The values.yaml file is available.

Procedure

1. In the values.yaml file, edit the configuration parameters. Make sure to stick to the YAML indentation rules.

2. To apply the changed configuration parameters, enter the following command:

helm upgrade -n ${NAMESPACE} ${INSTALLATION_NAME} oci://repo.cybus.io/charts/connectware \
  --version ${VERSION} -f values.yaml

Copying a Helm Chart to a Custom Registry

If you are using a custom registry to install Connectware, you may want to also store the matching version of our Helm charts there. You can use Helm to easily pull and push Helm charts.

Prerequisites

• Helm version 4 is installed on your system.

Procedure

1. Pull the Helm chart from our OCI registry:

helm pull oci://repo.cybus.io/charts/connectware --version ${VERSION}

1. Push the Helm chart to your OCI registry. The following example uses registry.mycompany.tld/cybus:

helm push connectware-${VERSION}.tgz oci://registry.mycompany.tld/cybus

Repeat this procedure for all charts and versions you want to have available on your internal registry.