Cluster Mode Setup

Operavix’s cluster mode allows you to integrate the main Operavix application server with additional components—such as the Automation Agent, Webhook Agent, and AI Agent—into a unified distributed system. Communication between components occurs over the gRPC protocol, with mandatory mutual authentication based on X.509 certificates and traffic encryption.

This mode enhances system fault tolerance, scalability, and flexibility when processing large data volumes or executing resource-intensive tasks.

General Cluster Setup Principles

Each cluster node must specify:

• A unique node name within the cluster (string, e.g., "operavix")
• A port for incoming gRPC connections (default: 7000)
• An X.509 certificate and private key in PEM/PKCS#8 format for the current node
• A list of other nodes’ addresses in host:port format
• Certificates of other nodes for mutual authentication and trust establishment

Windows Configuration (Legacy Installation)

If the Operavix server is installed on Windows:

1. Create the configuration file: C:\ProgramData\Operavix\config\cluster.json
2. Populate it with the following content:
   {
       "network": {
           "current": {
               "name": "operavix",
               "port": 7000,
               "ssl": {
                   "cert_chain_path": "ssl/operavix.crt",
                   "private_key_path": "ssl/operavix.key",
                   "trust_certs": ["ssl/agent01.crt", "ssl/agent02.crt"]
               }
           },
           "nodes": ["agent01.domain.local:7000", "agent02.domain.local:7000"]
       }
   }
   

   Explanation:

   Parameter	Description
   name	Unique node name in the cluster (appears in logs and the web UI)
   port	Port for incoming gRPC connections
   cert_chain_path	Path to the node’s X.509 certificate (PEM format), relative to C:\ProgramData\Operavix
   private_key_path	Path to the node’s private key in PKCS#8 format
   trust_certs	Array of paths to certificates of other trusted nodes
   nodes	Array of addresses of other cluster nodes (including the gRPC port)

3. Restart the Operavix service to apply the changes.

Docker Container Configuration (Linux)

When running Operavix in Docker (e.g., Docker Swarm), the configuration is passed via environment variables and Docker secrets.

Environment Variables

Docker Secrets (files mounted inside the container)

Example Docker Swarm Deployment

docker service create --name operavix-app \
  --secret operavix_app_https_certificate \
  --secret operavix_app_https_certificate_password \
  --secret cluster_current.crt \
  --secret cluster_current.key \
  --secret cluster_remote_node_agent01.crt \
  --secret cluster_remote_node_agent02.crt \
  --mount type=volume,src=operavix-app-data,target=/var/lib/operavix/data/ \
  --mount type=volume,src=operavix-app-log,target=/var/log/operavix/ \
  --publish published=443,target=8010,mode=host \
  --restart-max-attempts 5 \
  --restart-condition "on-failure" \
  -e JVM_MAX_MEMORY='4G' \
  -e FE_URL="https://server-name.domain.com" \
  -e FE_CORS_POLICY="*" \
  -e CL_NAME="operavix" \
  -e CL_REMOTE_NODES="agent01.domain.local:7000;agent02.domain.local:7000" \
  operavix/operavix_app:d250603

Verifying the Configuration

After configuring all nodes:

1. Log in to the Operavix web interface using an administrator account.
2. Navigate to: Settings → About System.
3. Ensure all cluster nodes appear in the list.
4. Expand each node to view details, including the version numbers of the components in use.