LogoLogo
Contact Uscybus.io
Connectware 1.11.0
Connectware 1.11.0
  • 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
      • Restarting Connectware
    • 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
      • Deviations
      • 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
      • Certificates View
      • Adding Certificates
      • Removing Certificates
    • Monitoring
      • Data Explorer
      • Live Data
    • Node-RED Workbench
    • System Status
      • System Container Status
      • Internet Connectivity Status
      • Metrics (Data Points and Messages)
      • Agents Status
      • License Information
      • System Information
    • Backup and Restore
      • Volumes
      • User Database
    • CybusMQ
      • Configuring CybusMQ
    • 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 Endpoint Properties
    • API Reference
      • User Management (API)
      • Client Registry (API)
      • Services (API)
      • Resources (API)
      • System Status (API)
      • Resource Status Tracking (HTTP API)
      • Industry Protocol Details (API)
    • Changelog
Powered by GitBook
LogoLogo

Cybus

  • Terms and Condition
  • Imprint
  • Data Privacy

© Copyright 2025, Cybus GmbH

On this page
  • Connectware Deployment Options
  • Software Requirements
  • Docker Compose Deployment
  • Hardware Requirements
  • System Requirements
  • Kubernetes Deployment
  • Available Distributions
  • Hardware Requirements
  • Kubernetes Cluster Requirements
  • Performance Guidelines
  • Agent Requirements
  • Minimum Agent Requirements
  • Network Requirements
  • Required Inbound Ports
  • Required Outbound Connectivity
  • Network Performance Requirements
  • Implementation Considerations
  • Virtual Host Requirements

Was this helpful?

  1. Getting Started

System Requirements

Hardware, software, and virtual host requirements for installing and operating Connectware.

PreviousIntroductionNextConnectware Admin UI

Last updated 1 month ago

Was this helpful?

This section outlines the technical requirements for installing and operating Cybus Connectware. It covers hardware specifications, network configuration, and system dependencies for both Docker Compose and Kubernetes deployments.

The hardware requirements for Connectware depend on factors such as message rate, message size, and storage requirements. For hardware recommendations based on your specific use cases, and we’ll recommend the appropriate hardware setup.

Connectware Deployment Options

Connectware offers multiple deployment options using Kubernetes, Docker, or a hybrid approach. The choice depends on your specific infrastructure requirements, from enterprise-scale operations to streamlined development environments.

The following table details the features and recommended use cases for Kubernetes and Docker deployments.

Kubernetes

Docker

Platform

Kubernetes using Helm orchestration

Docker with Docker Compose

Environments

Cloud, On-Premises, Hybrid

On-Premises Linux (VM, Bare Metal)

Use case

Enterprise-grade deployment solution

Development and simple production

Key features

• Advanced orchestration • Automated deployment management • For high-demand environments • Comprehensive monitoring • Automated scaling • Robust service management

• Low infrastructure requirements • For development environments • For basic deployment needs

Software Requirements

  • Linux operating system

  • Deployment options

    • Kubernetes

    • Docker

    • Docker Compose

  • Latest stable version of Chrome browser

Connectware is designed to operate on Linux systems, deployed with Docker Compose or Kubernetes. Running Connectware on Windows hosts or with different container-orchestration systems is not part of the standard version of Connectware, but may be available upon request.

Docker Compose Deployment

Docker Compose provides a streamlined deployment option for Connectware, ideal for smaller installations or development environments. This approach simplifies setup and management while maintaining essential functionality, requiring fewer resources than a full Kubernetes implementation.

Hardware Requirements

The hardware requirements for deploying Connectware on Docker depend on your deployment scale and your specific use cases.

Minimum Setup

  • CPU: 64-bit x86

  • RAM: 4 GB

  • Storage: 32 GB

System Requirements

  • Operating System: Linux (Windows hosts available upon request)

Avoid installing Docker through the Snap package manager due to known issues.

Kubernetes Deployment

Kubernetes deployment offers a robust, enterprise-grade platform for Connectware, providing advanced orchestration capabilities, comprehensive monitoring, and efficient scaling. This approach is recommended for production environments with higher performance requirements or more complex integration needs.

Available Distributions

Kubernetes deployments for Connectware can be implemented on various Kubernetes distributions, including cloud-based and on-premise solutions.

For example:

  • Red Hat OpenShift

  • Amazon Elastic Kubernetes Service (EKS)

  • Microsoft Azure Kubernetes Service (AKS)

Hardware Requirements

The hardware requirements for deploying Connectware on Kubernetes depend on your deployment scale and your specific use cases. Here are some general recommendations for a minimum and a production setup.

Test Setup

For a basic setup with standard functionality and typical message loads, the following resources are sufficient:

For a basic configuration supporting standard functionality and typical message loads, we recommend the following setup:

  • CPU: 64-bit x86

  • RAM: 4 GB

  • Storage: 60 GB. Must support persistent storage using PersistentVolumes (PV) and PersistentVolumeClaims (PVC)

Production Setup

For an optimized hardware configuration that ensures sufficient resources for deploying Connectware and implementing initial use cases, we recommend the following setup:

  • CPU: 12 cores

  • RAM: 15 GB

  • Storage: Must support persistent storage using PersistentVolumes (PV) and PersistentVolumeClaims (PVC)

Kubernetes Cluster Requirements

  • Dynamic Storage Provisioning

    • StorageClass supporting dynamic PersistentVolumes

    • Support for ReadWriteOnce (RWO) and ReadWriteMany (RWX) access modes

    • Recommended: NetApp with Trident provisioner

  • Load Balancer

    • Must support OSI Layer-4 (TCP) connectivity

    • Example: MetalLB

  • Required Tools

    • Helm for deployment management

    • Access to Cybus Registry (direct or via mirror)

Performance Guidelines

  • Monitor system load

    • At 50% load: Consider resource expansion

    • At 80% load: Strongly recommended to add resources

  • Deployment Strategy

    • Start with test instance

    • Scale progressively through development, staging, and production

Agent Requirements

Minimum Agent Requirements

  • CPU: 1 core

  • RAM: 4 GB

Network Requirements

Connectware's effective operation requires a network infrastructure that links business systems, manufacturing resources, and cloud systems. This ensures data security while preserving essential boundaries between network zones.

  • Enterprise domain: Facilitates interaction with corporate databases and information systems.

  • Operational domain: Establishes connections with factory equipment and industrial assets.

  • External domain: Supports system updates and integration with cloud-based services.

The sections below specify the necessary port configurations to implement this integrated connectivity architecture.

Required Inbound Ports

Configure the following environment variables to enable Entra ID authentication. Parameters differ between Kubernetes and Docker deployments.

Kubernetes Inbound Ports

Port
Protocol
Purpose

443

TCP/HTTPS

Web interface, frontend & registration

1883, 8883

TCP/MQTT(S)

Data broker, agent connection

4841

TCP/OPC UA

OPC UA server (optional)

40000-40100

TCP/HTTP(S)

Application ingress

4222

TCP/HTTP(S)

Control Plane (mTLS)

4223

TCP/HTTP(S)

Control Plane (User name & password)

Docker Inbound Ports

Port
Protocol
Purpose

22

TCP/SSH

Host system administration

443

TCP/HTTPS

Web interface, frontend & registration

1883, 8883

TCP/MQTT(S)

Data broker, agent connection

4841

TCP/OPC UA

OPC UA server (optional)

40000-40100

TCP/HTTP(S)

Application ingress

4222

TCP/HTTP(S)

Control Plane (mTLS)

4223

TCP/HTTP(S)

Control Plane (User name & password)

Required Outbound Connectivity

Cybus Services (HTTPS/443)

Required endpoints for online functionality:

  • registry.cybus.io

  • portal.cybus.io

  • download.cybus.io

  • graphql-server.cybus.io

  • docker-auth.cybus.io

  • repository.cybus.io (only for Kubernetes deployments)

Network Performance Requirements

  • Minimum recommended bandwidth: 2.5 Gbps

  • Higher bandwidth recommended for optimal performance

Implementation Considerations

Beyond the technical setup, successful Connectware deployment requires strategic planning for resilience, security, and growth. This section addresses critical factors that ensure long-term operational effectiveness.

Online vs Offline Operation

Connectware is designed to function effectively in offline environments while offering enhanced capabilities when online. Internet connectivity is required specifically for system updates and management via the Cybus Portal, but core operational functionality remains intact without external connections.

Network Segmentation

Proper network segmentation is essential for operational integrity. Organizations should establish well-defined access protocols between office and production networks, implementing comprehensive security measures at zone boundaries to maintain appropriate isolation between critical system components.

Capacity Planning and Scalability

Proactive resource management is crucial for long-term system viability. We recommend that you regularly monitor resource utilization metrics, with particular attention to early indicators of capacity constraints. Organizations should develop strategic plans for both computational and storage expansion, while implementing appropriate redundancy and backup protocols to ensure operational continuity.

Virtual Host Requirements

When deploying Connectware in virtualized environments, specific platform capabilities are required to ensure proper container operation and system performance.

Full Docker support including privileged containers is required to run Connectware on virtual hosts.

Sufficient platforms:

  • VMware

  • AWS EC2 (e.g. using t3a.large or t3a.xlarge (recommended) instances with Ubuntu 24.04)

  • Azure VM

  • Google Compute Engine

Docker should be installed using the official setup guide . Installing Docker by the package manager Snap is known to be causing issues and should be avoided.

contact us
https://docs.docker.com/engine/install/ubuntu/