Requirements

An existing working tenant running version 6.32 or later.
Tenant license with the "connector" feature enabled.

Adding a Connector Site

The Site linked to the Connector must be registered under Sites with the corresponding type "Connector". The new Connector site type should be added via Topology/Sites/New page as below:

[SCREENSHOT NEEDED: Topology/Sites/New page showing Connector site type selection]

Important: Setting an IDAC and a Connector on the same site is considered a bad configuration.

API Operations

Addition: Connectors are auto-registered when the connector is running, assuming it has a correct configuration.

Retrieval: GET /console.TENANT.cyolo.io/v1/connector

Deletion: DELETE /console.TENANT.cyolo.io/v1/connector/{ID}

Note: The Connector can only be deleted via the API if it is offline.

Configuration

Configuration Files Structure

The connector requires the following configuration files:

certs folder: Must contain the certificate and key files as well as the Cyolo license file.

connector.yml file: Contains the following configuration parameters:

upstream:  
upstream_sni:  
site:  
license: config/certs/license.cyolo  # Optional, default: /certs/license.cyolo
cert: config/certs/cert.pem          # Optional, default: /certs/cert.pem
key: config/certs/key.pem            # Optional, default: /certs/key.pem
id_file: /config/connector_idfile    # Optional, default: /config/connector_idfile

connector.yml Example

upstream: tcp.cyolo.io:443
upstream_sni: tcp.cyolo.io
site: ConnectorTest
cert: /certs/cert.pem
key: /certs/key.pem
id_file: /config/connector_idfile

docker-compose_connector.yml Example

version: "3.7"
networks:
  cyolo:
    ipam:
      config:
        - subnet: 100.100.100.0/24
services:
  connector:
    image: registry.cyolo.io/cyolosec/connector:latest
    restart: always
    networks:
      - cyolo
    volumes:
      - /etc/cyolo_connector/config:/config
      - /etc/cyolo_connector/certs:/certs
      - /var/run/docker.sock:/var/run/docker.sock
      - /:/host
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
    ulimits:
      nproc: 65535
      nofile:
        soft: 1048576
        hard: 1048576
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "3"
        compress: "true"
    environment:
      - CONFIG_PATH=/config/connector.yml