LogoLogo
Contact Uscybus.io
Connectware 1.10.1
Connectware 1.10.1
  • Getting Started
    • Introduction
    • System Requirements
    • Connectware Admin UI
    • Basic Components of Connectware
    • Connecting your First Machine
      • Your First Service Commissioning File
  • Documentation
    • Installation and Upgrades
      • Installing Connectware
        • Installing Connectware (Kubernetes)
        • Installing Connectware (Docker)
      • Upgrading Connectware
        • Upgrading Connectware (Kubernetes)
          • Version-Specific Upgrades (Kubernetes)
        • Upgrading Connectware (Docker)
          • Version-Specific Upgrades (Docker)
      • Uninstalling Connectware
        • Uninstalling Connectware (Kubernetes)
        • Uninstalling Connectware (Docker)
      • Licensing
    • User Management
      • Users and Roles View
      • Users
      • Roles
      • Permissions
      • Password Policy Rules
      • Default Admin User
      • MQTT Users
      • Adding a MQTT Publish Prefix for Users
      • Multi-Factor Authentication
      • Single Sign-On (SS0)
        • Single Sign-On with Microsoft Entra ID
        • Single Sign-On with LDAP
      • JSON Web Tokens
      • Access Permissions for Admin-UI
        • UI Access
        • Minimum Access Role Pages
    • Services
      • Service Overview
      • Service Resources View
        • Service Links View
        • Servers View
        • Containers View
        • Volumes View
        • Connections View
        • Endpoints View
        • Mappings View
      • Service Details View
      • Service Commissioning Files
        • Version
        • Description
        • Metadata
        • Parameters
        • Definitions
        • Resources
          • Cybus::Connection
          • Cybus::Container
            • Docker Problem with Network Changes
          • Cybus::Endpoint
          • Cybus::File
          • Cybus::IngressRoute
          • Cybus::Link
          • Cybus:Mapping
          • Cybus::Node
          • Cybus::Role
          • Cybus::Server
          • Cybus::User
          • Cybus::Volume
      • Setting Up and Configuring Services
        • Installing Services
        • Enabling Services
        • Updating Services
        • Disabling Services
        • Deleting Services
      • FlowSync
        • Example 1 - Node with Transaction Mode (HTTP)
        • Example 2 - Node Responds (HTTP)
        • Example 3 - Node with Error (HTTP)
        • Example 4 - Node with Timeout Error Code and Error Message (HTTP)
        • Example 5 - Full Transactional Data Flow (HTTP)
        • Example 6 - Full Transactional Data Flow (OPC UA)
      • ServiceID
      • Inter-Service Referencing
      • Deviation
      • Service Logs
        • Logs of Individual Services
        • Logs of All Services
      • Rule Engine
        • Data Processing Rules
        • Rule Sandbox
      • Shared Subscriptions
        • Setting Up Shared Subscriptions
    • Agents
      • Agents View
      • Installing Agents
        • Installing Agents via Docker
        • Installing Agents via Docker Compose
        • Installing Agents via Kubernetes
        • Using Mutual TLS for Agents
      • Registering Agents in Connectware
      • Using Agents
      • Monitoring Agents
      • Agents in Kubernetes
        • Adding Agents Inside your Connectware Installation
        • Remote Agents with the connectware-agent Helm Chart
        • Kubernetes Cluster Requirements for the connectware-agent Helm Chart
        • Installing Connectware Agents using the connectware-agent Helm Chart
        • Installing Connectware Agents without a License Key Using the connectware-agent Helm Chart
        • Upgrading the connectware-agent Helm Chart
        • Uninstalling Connectware agents with the connectware-agent Helm chart
        • Configuration Principles for the connectware-agent Helm Chart
        • Configuring Agents with the connectware-agent Helm Chart
          • Configuring Target Connectware for the connectware-agent Helm Chart
          • Configuring Agent Persistence for the connectware-agent Helm Chart
          • Configuring Compute Resources for the connectware-agent Helm Chart
          • Using a Custom Image Registry for the connectware-agent Helm Chart
          • Configuring Image Pull Policy for the connectware-agent Helm Chart
          • Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart
          • Configuring image name and version for the connectware-agent Helm chart
          • Configuring Environment Variables for the connectware-agent Helm Chart
          • Configuring Labels and Annotations for the connectware-agent Helm Chart
          • Configuring podAntiAffinity for the connectware-agent Helm Chart
          • Assigning Agents to Kubernetes Nodes for the connectware-agent Helm Chart
          • Configuring Security Context for the connectware-agent Helm Chart
          • Controlling the Name of Kubernetes Objects for the connectware-agent Helm Chart
      • Troubleshooting Agents
    • Client Registry
      • Implicit Flow
      • Explicit Flow
      • Granting Access
    • Certificates
    • Monitoring
      • Data Explorer
      • Live Data
    • Workbench
      • Flows in Git Repositories
    • System Status
      • Info
      • Metrics
      • Status
      • Retrieving More System Information
      • System Health
    • Backup and Restore
      • Volumes
      • User Database
    • Connectware on Kubernetes
      • Connectware Helm Chart
      • Resizing Broker Volumes in Kubernetes
      • Configuring Core Services
      • LDAP Authentication
        • Configuring LDAP Authentication
        • Enabling TLS for LDAP Authentication
        • Manual Kubernetes Secret for LDAP Authentication Bind User
        • Customizing the Search Filter for LDAP Authentication
        • Customizing the User RDN for LDAP Authentication
      • Troubleshooting Connectware on Kubernetes
    • Environment Variables
    • Industry Protocol Details
      • ADS
        • ADS Connection Properties
        • ADS Endpoint Properties
      • BACnet
        • BACnet Connection Properties
        • BACnet Endpoint Properties
      • Custom Connectors
        • Developing Custom Connectors
        • Deploying Custom Connectors
        • Using Custom Connectors
      • EtherNet/IP
        • EtherNet/Ip Connection Properties
        • EtherNet/Ip Endpoint Properties
      • FOCAS
        • FOCAS Connection Properties
        • FOCAS Endpoint Properties
      • Hottinger Baldwin Messtechnik (HBM)
        • HBM Connection Properties
        • HBM Endpoint Properties
      • Heidenhain DNC
        • Heidenhain DNC Connection Properties
        • Heidenhain DNC Endpoint Properties
      • HTTP/REST
        • HTTP/REST Connection Properties
        • HTTP/REST Endpoint Properties
      • HTTP Server/Node
        • HTTP Server Properties
        • HTTP Node Properties
      • InfluxDB
        • InfluxDB Connection Properties
        • InfluxDB Endpoint Properties
      • Kafka
        • Kafka Connection Properties
        • Kafka Endpoint Properties
      • Modbus/TCP
        • Modbus/TCP Connection Properties
        • Modbus/TCP Endpoint Properties
      • MQTT
        • MQTT Connection Properties
        • MQTT Endpoint Properties
      • MSSQL
        • Mssql Connection Properties
        • Mssql Endpoint Properties
      • OPC DA
        • OPC DA Connection Properties
        • OPC DA Endpoint Properties
      • OPC UA
        • OPC UA Client
          • OPC UA Client Connection Properties
          • OPC UA Client Endpoint Properties
        • OPC UA Server
          • OPC UA Server Properties
          • OPC UA Node Properties
        • OPC UA Object Types
        • OPC UA Server References
          • OPC UA Reference Node
          • OPC UA Object Node
      • Siemens SIMATIC S7
        • Siemens S7 Connection Properties
        • Siemens S7 Endpoint Properties
      • Shdr
        • Shdr Connection Properties
        • Shdr Endpoint Properties
      • SINUMERIK
        • SINUMERIK Connection Properties
        • SINUMERIK Endpoint Properties
      • SOPAS
        • SOPAS Connection Properties
        • SOPAS Endpoint Properties
      • SQL
        • SQL Connection Properties
        • SQL Endpoint Properties
      • Werma WIN Ethernet
        • Werma WIN Ethernet Connection Properties
        • Werma WIN Ethernet Endpoint Properties
      • Systemstate
        • Systemstate Connection Properties
        • Systemstate Endpoint Properties
    • API Reference
      • User Management (API)
      • Client Registry (API)
      • Services (API)
      • Resources (API)
      • System Status (API)
      • Industry Protocol Details (API)
    • Changelog
      • General changes from 0.x to 1.0
        • Upgrading from 0.x to 1.0
Powered by GitBook
LogoLogo

Cybus

  • Terms and Condition
  • Imprint
  • Data Privacy

© Copyright 2025, Cybus GmbH

On this page
  • Prerequisites
  • Available Helm Values
  • Root-Level Helm Values
  • protocolMapperAgentDefaults Helm Values
  • protocolMapperAgents Helm Values

Was this helpful?

  1. Documentation
  2. Agents
  3. Agents in Kubernetes

Configuring Agents with the connectware-agent Helm Chart

PreviousConfiguration Principles for the connectware-agent Helm ChartNextConfiguring Target Connectware for the connectware-agent Helm Chart

Last updated 3 months ago

Was this helpful?

Prerequisites

  • Helm V3 installed ().

  • kubectl installed ().

  • kubectl configured with the current context pointing to your target cluster ().

You can configure your Connectware agents deployed through the connectware-agent Helm chart by adjusting Helm values in your values.yaml file and re-applying it using a Helm upgrade.

Example

helm upgrade -i connectware-agent cybus/connectware-agent -f values.yaml -n <namespace>

If you need help starting out with a values.yaml file, follow the article.

In our examples we will explain the parameters in the protocolMapperAgents Helm context, but unless otherwise noted they are also available to configure through protocolMapperAgentDefaults as mentioned in .

Connectware’s agents are part of a Kubernetes StatefulSet. If any of them are not in the state “running” when you execute helm upgrade, you will need to manually delete the pod afterwards, for an updated pod to be scheduled.

Available Helm Values

Root-Level Helm Values

These values are on the root level of your values.yaml file.

Helm value
Description
Discussed in

licenseKey

A valid license for Cybus Connectware

protocolMapperAgentDefaults

This set of configuration values is applied to all agents, unless they override specific values

protocolMapperAgents

A collection of Connectware agents to be deployed. Each collection entry can contain configuration to override the defaults

fullnameOverride

Override the full name of this installation, which is used as a name prefix. Use „“ to remove prefixing

nameOverride

Override the chart name of this installation, which is used as part of the name prefix

protocolMapperAgentDefaults Helm Values

These values are within the protocolMapperAgentDefaults section and control the behavior of all deployed agents.

Helm value
Description
Discussed in

connectwareHost

DNS name under which the Connectware installation is available to the agent

controlPlaneBrokerEnabled

Define if the Connectware installation uses the separate control-plane-broker feature

image.name

The name of the container image used for the agent

image.version

Container version or tag used for the agent

image.registry

Container image registry to be used for the agent. Set to „“ to not specify a registry

image.pullPolicy

Kubernetes imagePullPolicy used for the agent. One of: Always, Never, IfNotPresent

image.pullSecrets

A collection of objects containing Kubernetes imagePullSecrets with a name attribute, to be used by the agent

mTLS.enabled

Define if mTLS (Certificate Authentication) is enabled

mTLS.caChain.cert

The Certificate Authority certificate chain as a literal PEM encoded string

mTLS.caChain.existingConfigMap

An existing Kubernetes ConfigMap containing the Certificate Authority certificate chain in a file named ca-chain.pem

mqtt.tls

Define if TLS (Transport Encryption) is enabled

mqtt.controlHost

Override the default host for the control-plane MQTT connection

mqtt.dataHost

Override the default host for the data MQTT connection

mqtt.controlPort

Override the default port for the control-plane MQTT connection

mqtt.dataPort

Override the default port for the data MQTT connection

persistence.accessMode

The Kubernetes AccessMode to request for the persistent volume. One of: ReadWriteOnce, ReadWriteMany, ReadWriteOncePod

persistence.size

A Kubernetes Quantity to request as size for the persistent volume

persistence.storageClassName

The name of the Kubernetes StorageClass to request for the persistent volume

podAntiAffinity

Define what type of podAntiAffinity to use for the agent. One of: none, soft, hard

podAntiAffinityOptions

Define configuration values specific to podAntiAffinity

resources.requests.cpu

Kubernetes Quantity that describes the agents CPU requests

resources.requests.memory

Kubernetes Quantity that describes the agents memory requests

resources.limits.cpu

Kubernetes Quantity that describes the agents CPU limits

resources.limits.memory

Kubernetes Quantity that describes the agents memory limits

env

A collection of objects with name and value describing environment variables passed to the agent

annotations

A set of Kubernetes annotations to be added to all agent resources

labels

A set of Kubernetes labels to be added to all agent resources

podAnnotations

A set of Kubernetes annotations to be added to the agent pod only

podLabels

A set of Kubernetes labels to be added to the agent pod only

nodeSelector

A set of Kubernetes labels a node must have for the agent to be scheduled on it

securityContext

Define the Kubernetes SecurityContext for the agent

podSecurityContext

Define the Kubernetes SecurityContext for the agents pod

service.annotations

A set of Kubernetes annotations to be added to the agents service only

service.labels

A set of Kubernetes labels to be added to the agents service only

protocolMapperAgents Helm Values

Helm value
Description
Discussed in

name

The name of the Connectware agent. If you use mTLS this must match the certificates CN/SAN

mTLS.keyPair.cert

The mTLS certificate chain as a literal PEM encoded string

mTLS.keyPair.key

The mTLS private key as a literal PEM encoded string

mTLS.existingSecret

An existing Kubernetes Secret containing the mTLS certificate and key in files named tls.crt and tls.key

These values are within the protocolMapperAgents section, which is a list of agents you want to deploy and are configured per entry for an agent. See for details. Additionally to the values listed here, all values under protocolMapperAgentDefaults are available per-agent.

Helm | Installing Helm
Install Tools
Configure Access to Multiple Clusters
Installing Connectware agents using the connectware-agent Helm chart
Configuration principles for the connectware-agent Helm chart
Configuration principles for the connectware-agent Helm chart
Installing Connectware agents using the connectware-agent Helm chart
Configuration principles for the connectware-agent Helm chart
Configuration principles for the connectware-agent Helm chart
Controlling the name of Kubernetes objects for the connectware-agent Helm chart
Controlling the name of Kubernetes objects for the connectware-agent Helm chart
Configuring target Connectware for the connectware-agent Helm chart
Configuring target Connectware for the connectware-agent Helm chart
Configuring image name and version for the connectware-agent Helm chart
Configuring image name and version for the connectware-agent Helm chart
Using a custom image registry for the connectware-agent Helm chart
Configuring image pull policy for the connectware-agent Helm chart
Using a custom image registry for the connectware-agent Helm chart
Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart
Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart
Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart
Configuring target Connectware for the connectware-agent Helm chart
Configuring target Connectware for the connectware-agent Helm chart
Configuring target Connectware for the connectware-agent Helm chart
Configuring target Connectware for the connectware-agent Helm chart
Configuring target Connectware for the connectware-agent Helm chart
Configuring agent persistence for the connectware-agent Helm chart
Configuring agent persistence for the connectware-agent Helm chart
Configuring agent persistence for the connectware-agent Helm chart
Configuring podAntiAffinity for the connectware-agent Helm chart
Configuring podAntiAffinity for the connectware-agent Helm chart
Configuring compute resources for the connectware-agent Helm chart
Configuring compute resources for the connectware-agent Helm chart
Configuring compute resources for the connectware-agent Helm chart
Configuring compute resources for the connectware-agent Helm chart
Configuring environment variables for the connectware-agent Helm chart
Configuring environment variables for the connectware-agent Helm chart
Configuring labels and annotations for the connectware-agent Helm chart
Configuring labels and annotations for the connectware-agent Helm chart
Configuring labels and annotations for the connectware-agent Helm chart
Assigning agents to Kubernetes nodes for the connectware-agent Helm chart
Configuring security context for the connectware-agent Helm chart
Configuring security context for the connectware-agent Helm chart
Configuring labels and annotations for the connectware-agent Helm chart
Configuring labels and annotations for the connectware-agent Helm chart
Installing Connectware agents using the connectware-agent Helm chart
Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart
Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart
Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart