📘
For an overview of the Connector component, see Getting Started.

Adding a Connector Site

Prerequisites

An existing working Cyolo tenant running version 6.32 or later.
A tenant license with the Connector feature enabled.

Register Site

The Site linked to the Connector must be registered under Sites with the corresponding type Connector.

To add a Connector:

Go to Topology > Sites and click New.

Type a name and then select Connector as type:

The Site linked to the Connector must be registered under Sites with the corresponding type "Connector" (currently only via API).
It is not recommended to include both an IDAC and a Connector in the same site.
The body of the API to

Setting Up Connector via API

The following API functions are available for setting up and managing Connectors:

To get Connector details: : GET /console.TENANT.cyolo.io/v1/connector
To delete a Connector: DELETE /console.TENANT.cyolo.io/v1/connector/{ID}

📘
Note:
A Connector can only be deleted if it is offline.

Connector Configuration Files

The structure of the folder that contains the Connector configuration files is shown below.

/etc/cyolo_connector/
├── certs
│   ├── license.cyolo
│   ├── cert.pem
│   └── key.pem
└── config
    ├── connector_idfile
    ├── connector.yml
    └── docker-compose_connector.yml

The certs folder must contain the certificate and key files as as well the Cyolo license file.
The file connector.yml must have the details as show below.

upstream: 
upstream_sni: 
site: 
license: config/certs/license.cyolo (It is optional, default value is /certs/license.cyolo)
cert: config/certs/cert.pem (It is optional, default value is /certs/cert.pem)
key: config/certs/key.pem (It is optional, default value is /certs/key.pem)
id_file: /config/connector_idfile (It is optional default is /config/connector_idfile)

Example of populated file connector.yml

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

Example for docker-compose_connector.yml

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