CyberOptix Integrator Deployment Guide

Guide for deploying the CyberOptix integrator for on-premises integrations.

Overview

The CyberOptix integrator is required for on-premises integrations that cannot be accessed directly from the cloud. The integrator runs on your infrastructure and securely connects to the CyberOptix platform.

Prerequisites

Ubuntu Server 22.04 or Red Hat Enterprise Linux 9.6
Root or sudo access
Network connectivity to CyberOptix API endpoint
Your Organization ID from CyberOptix

Ubuntu Server 22.04 Installation

Step 1: Add Purple Team Software Repository

wget -O - https://apt.fury.io/purpleteamsoftware/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg] https://apt.purpleteamsoftware.com/ /" | sudo tee /etc/apt/sources.list.d/purpleteamsoftware.list

Step 2: Install CyberOptix Integrator

sudo apt update && sudo apt install cyberoptix.integrator -y

Step 3: Disable Swap

sudo sed -i '/swap/ s/^/#/' /etc/fstab
sudo sed -i '/127\.0\.1\.1/ s/^/#/' /etc/hosts

Step 4: Link Integrator to CyberOptix

Replace {BASE_HOST_NAME} and {ORG_ID} with your values:

sudo integrator-link -url https://{BASE_HOST_NAME}-api.cyberoptix.io/ -org_id {ORG_ID}

Step 5: Enable and Start Services

sudo systemctl enable --now integrator-completed-tasks.service \
  integrator-new-tasks.service \
  integrator-task-manager.service \
  integrator.service

Step 6: Verify Services

sudo systemctl status integrator.service
sudo systemctl status integrator-task-manager.service
sudo systemctl status integrator-new-tasks.service
sudo systemctl status integrator-completed-tasks.service

All services should show active (running) status.

Red Hat Enterprise Linux 9.6 Installation

Step 1: Import GPG Key

sudo rpm --import https://apt.fury.io/purpleteamsoftware/gpg.key

Step 2: Create Repository File

sudo tee /etc/yum.repos.d/purpleteamsoftware.repo > /dev/null << 'EOF'
[purpleteamsoftware]
name=PurpleTeam Software Repository
baseurl=https://dnf.purpleteamsoftware.com/
enabled=1
gpgcheck=1
gpgkey=https://apt.fury.io/purpleteamsoftware/gpg.key
EOF

Step 3: Install Dependency Repositories

# EPEL (required for pipx/sysstat/openvpn on EL9)
sudo dnf install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm

# Docker CE repository
sudo dnf -y install dnf-plugins-core
sudo dnf config-manager --add-repo https://download.docker.com/linux/rhel/docker-ce.repo

Step 4: Install CyberOptix Integrator

sudo dnf clean all && sudo dnf makecache && sudo dnf install cyberoptix.integrator -y

Step 5: Disable Swap

sudo sed -i '/swap/ s/^/#/' /etc/fstab

Step 6: Link Integrator to CyberOptix

Replace {BASE_HOST_NAME} and {ORG_ID} with your values:

sudo integrator-link -url https://{BASE_HOST_NAME}-api.cyberoptix.io/ -org_id {ORG_ID}

Step 7: Enable and Start Services

sudo systemctl enable --now integrator-completed-tasks.service \
  integrator-new-tasks.service \
  integrator-task-manager.service \
  integrator.service

Step 8: Verify Services

sudo systemctl status integrator.service
sudo systemctl status integrator-task-manager.service
sudo systemctl status integrator-new-tasks.service
sudo systemctl status integrator-completed-tasks.service

All services should show active (running) status.

Configuration Details

Required Values

Parameter	Description	Example
`{BASE_HOST_NAME}`	Your CyberOptix instance hostname	`mycompany`
`{ORG_ID}`	Your Organization ID from CyberOptix	`org-abc123-def456`

Services Overview

Service	Purpose
integrator.service	Main integrator daemon
integrator-task-manager.service	Manages integration task queue
integrator-new-tasks.service	Processes new integration tasks
integrator-completed-tasks.service	Handles completed task reporting

Network Requirements

The integrator requires outbound HTTPS (443) access to:

https://{BASE_HOST_NAME}-api.cyberoptix.io
Purple Team Software package repositories

No inbound connections are required.

System Requirements

Minimum Specifications

CPU: 2 cores
Memory: 4 GB RAM
Disk: 20 GB available space
OS: Ubuntu Server 22.04 or RHEL 9.6

Recommended Specifications

CPU: 4 cores
Memory: 8 GB RAM
Disk: 50 GB available space
OS: Ubuntu Server 22.04 LTS or RHEL 9.6

Post-Installation

After successful installation and service startup:

The integrator will automatically register with CyberOptix
Integration tasks will begin processing based on your configured integrations
Monitor service logs for any errors:

# View integrator logs
sudo journalctl -u integrator.service -f

# View task manager logs
sudo journalctl -u integrator-task-manager.service -f

Deploy an Integrator