Targeting Connectware for the connectware-agent Helm Chart

Configure how agents connect to Connectware, including hostname, TLS for the MQTT data plane, and advanced network overrides.

Agents deployed with the connectware-agent Helm chart connect to a Connectware installation. By default, agents are configured to connect to Connectware in the same Kubernetes namespace. Override this behavior by setting the connectwareHost parameter.

Follow the instructions in this guide to configure the target Connectware hostname, enable TLS for the MQTT data plane, and override advanced network parameters if needed.

Configuring the Target Connectware Hostname

If your Connectware installation is in a different namespace or cluster, configure the connectwareHost parameter.

Add the following to your values.yaml file. Replace ${CONNECTWARE_HOSTNAME} with the actual hostname.

values.yaml

protocolMapperAgentDefaults:
  connectwareHost: ${CONNECTWARE_HOSTNAME}

Hostname formats:

• Different namespace in the same cluster: Use connectware.${NAMESPACE} (for example, connectware.production).

• Outside the Kubernetes cluster: Use the full hostname or IP address where Connectware is reachable.

Network access:

In the default configuration, the following network ports on Connectware must be reachable for the agent:

• TCP/443

• TCP/1883

• TCP/4223

For detailed network requirements, see System Requirements.

For TLS verification, the exact name used in connectwareHost must be a Subject Alternative Names (SAN) entry in the cybus_server.crt, see Server Certificates.

To override this setting for specific agents, see Configuration Principles for the connectware-agent Helm Chart.

Enabling TLS for the MQTT Data Plane

To enable Transport Layer Security encryption for the MQTT data plane, set the parameter dataPlane.tls to true in your values.yaml file:

values.yaml

protocolMapperAgentDefaults:
  dataPlane:
    tls: true

Enabling TLS changes the MQTT data plane port and adds TCP/8883 to the required ports. Ensure this port is reachable on your Connectware installation.

Overriding MQTT Data Plane Parameters (Advanced)

The connectware-agent Helm chart automatically configures MQTT data plane connection parameters based on your settings. Override these values for advanced network configurations.

Override MQTT Data Plane Host

To override the hostname that the agent uses to connect via MQTT for data transfer, set the parameter dataPlane.host in your values.yaml file:

values.yaml

protocolMapperAgentDefaults:
  dataPlane:
    host: ${MQTT_HOST}

Replace ${MQTT_HOST} with the hostname on which the Connectware MQTT data plane is reachable. Within the same namespace, use broker.

By default, broker is not included in the default cybus_server.crt certificate. If you set a custom dataPlane.host, ensure that you replace the certificate and add the hostname you are setting to the certificate's Subject Alternative Names (SAN).

Override MQTT Data Plane Port

To override the TCP port that the agent uses to connect via MQTT for data transfer, set the parameter dataPlane.port in your values.yaml file:

values.yaml

protocolMapperAgentDefaults:
  dataPlane:
    port: 10883

Overriding Control Streaming Server Parameters (Advanced)

Override Control Streaming Server Host

To override the hostname that an agent uses when connecting to the Control Streaming Server, set the parameter streamServer.host in your values.yaml file:

values.yaml

protocolMapperAgentDefaults:
  streamServer:
    host: ${STREAM_SERVER_HOST}

Replace ${STREAM_SERVER_HOST} with the hostname on which the Control Streaming Server is reachable. Within the same namespace, use nats.

Override Control Streaming Server Port

To override the TCP port that the agent uses to connect to the Control Streaming Server, set the parameter streamServer.port in your values.yaml file:

values.yaml

protocolMapperAgentDefaults:
  streamServer:
    port: 14222