System Requirements
Hardware, software, and virtual host requirements for installing and operating Connectware.
Last updated
Was this helpful?
Connectware 1.11.0
Hardware, software, and virtual host requirements for installing and operating Connectware.
Last updated
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 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
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 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.
The hardware requirements for deploying Connectware on Docker depend on your deployment scale and your specific use cases.
CPU: 64-bit x86
RAM: 4 GB
Storage: 32 GB
Operating System: Linux (Windows hosts available upon request)
Avoid installing Docker through the Snap package manager due to known issues.
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.
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)
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.
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)
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)
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)
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
CPU: 1 core
RAM: 4 GB
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.
Configure the following environment variables to enable Entra ID authentication. Parameters differ between Kubernetes and Docker deployments.
Kubernetes Inbound Ports
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 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)
Minimum recommended bandwidth: 2.5 Gbps
Higher bandwidth recommended for optimal performance
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.
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.