Upgrading the connectware-agent Helm Chart

Upgrade the connectware-agent Helm chart to a new version.

Upgrading from connectware-agent chart version 2.1.0 to 3.0.0? That release contains breaking changes to the values.yaml file. Follow Upgrading Connectware and Connectware-Agent Helm Charts to 3.0.0 — Part B instead of this page.

Prerequisites

• Helm version 4 is installed on your system.

• kubectl is installed on your system.

• kubectl configured with the current context pointing to your target cluster (Configure Access to Multiple Clusters).

Overview

Upgrading the connectware-agent Helm chart consists of the following steps:

1. Picking a compatible version

2. Determining the name of your connectware-agent installation

3. Obtaining your values.yaml file

4. Reviewing changes and adjusting Helm values

5. Starting the upgrade

6. Verifying the upgrade

Picking a Compatible Version

Each version of the connectware-agent Helm chart bundles a specific agent version that must match your Connectware installation. Agents must run the same version as Connectware itself.

Before upgrading, consult the Compatibility Matrix to determine which Helm chart version corresponds to your Connectware version.

To prevent accidental upgrades to incompatible agent versions, lock the protocol-mapper image version in your values.yaml file using the protocolMapperAgentDefaults.image.tag value.

Example

protocolMapperAgentDefaults:
  image:
    tag: 2.3.0

You can also lock the version of the connectware-agent Helm chart valid for your values.yaml file by setting the chart version in the Helm value validVersion. For more information, see Locking the Helm Chart Version.

Determining the Name of Your connectware-agent Installation

Identify the release name from your initial installation. If you followed this documentation, it's likely connectware-agent. Use helm list to verify the name in your target namespace. For more information, see Obtaining the Name, Namespace, and Version of Your Installation.

Obtaining Your values.yaml File

The values.yaml file configures your connectware-agent installation. Keep it in version control for operational use. If you do not have it available, extract it from your installation using helm get values. For more information, see Extracting the values.yaml File.

Reviewing Changes and Adjusting Helm Values

Review the Helm chart's README file for changes that might require adjustments to your configuration. Use helm show readme to view the README.

Example

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

If nothing is mentioned for the version you are upgrading to, no configuration adjustments are required.

If you locked the version for the agent's protocol-mapper image using protocolMapperAgentDefaults.image.tag or any agent-specific configuration under protocolMapperAgents, update these values to the target version.

Starting the Upgrade

To start the upgrade, run helm upgrade specifying the target version with the --version parameter and providing your values.yaml file.

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

Replace ${VERSION} with the target Helm chart version, ${INSTALLATION_NAME} with the name determined earlier, and ${NAMESPACE} with the namespace of your connectware-agent installation. You can find additional details in the Helm documentation.

Verifying the Upgrade

Verify that all pods are restarting with the new image version. Using kubectl get pods, check their AGE, verify they are in state Running, and are READY.

Example

kubectl get pods -n ${NAMESPACE} -l app.kubernetes.io/component=protocol-mapper-agent

Next, head to the Connectware Admin UI and verify your agents are connected in the correct version as described in Monitoring Agents.

Should any pods not become READY, continue with Troubleshooting on Kubernetes.