Upgrading Connectware to 2.6.0 (Docker)

How to upgrade Connectware to version 2.6.0 on Docker.

Connectware 2.6.0 adds OpenMetrics endpoints for core components, new Rule Engine functions, and OPC UA namespace URI support. For a complete list of changes, see the 2.6.0 changelog.

Check your upgrade path

The steps in this guide apply to specific setups. Before you continue, check Connectware Upgrade Paths to determine which upgrades and steps apply to your installation.

Complete the following steps in order, as one upgrade operation.

1

InfluxDB 3 Endpoints: Rename Measurement to Table

This step applies if you have services with Influxdb3 endpoints that use the measurement or measurementPrefix properties, or that receive messages carrying a measurement key on the /set topic. Check your service commissioning files for endpoints with protocol: Influxdb3. If you do not use the Influxdb3 protocol, skip this step.

Connectware 2.6.0 renames the measurement and measurementPrefix endpoint properties to table and tablePrefix to align with InfluxDB 3 terminology. The Influxdb (InfluxDB 2) protocol keeps measurement and measurementPrefix.

Update the affected service commissioning files, then upgrade. Connectware 2.5.0 does not accept table or tablePrefix, so do not install the updated files before the upgrade.

resources:
  machineMetricsWrite:
    type: Cybus::Endpoint
    properties:
      protocol: Influxdb3
      connection: !ref influxdb3Connection
      write:
        table: machine_metrics # was: measurement
        tags:
          line: assembly-1

Update any application that publishes a measurement key to the /set topic of an Influxdb3 endpoint to send table instead.

For more information, see InfluxDB 3 Support.

2

Agents on Docker: Change the Network Mode to Bridge

This step applies if you deploy agents with Docker or Docker Compose. If all your agents run on Kubernetes, skip this step.

Agents running the protocol-mapper 2.6.0 image bind port 8888 for their health probe and port 9184 for their metrics endpoint. Agents that run with network_mode: host share the host's ports, so only the first one to start binds them. The remaining agents stop during bootstrap with an EADDRINUSE error.

Change the affected agents to bridge networking:

services:
  protocol-mapper-agent:
    network_mode: bridge

If you start agents with docker run, replace --network=host with --network=bridge.

With bridge networking, localhost refers to the container, not the host. Set CYBUS_HOSTNAME_INGRESS to an address that reaches Connectware from inside the container.

For more information, see Network Mode.

3

Upgrading Connectware to 2.6.0

Follow the instructions in Upgrading Connectware (Docker) to upgrade to version 2.6.0.