The Collector Server is a managed platform that allows running sets of different collectors grouped by Devo domain destinations.
To run an instance of this data collector, the next steps must be followed:
In the Collector Server GUI, access the domain where you want to create this instance, click Add Collector, search for “Cortex XDR - Integrations Factory”, then click on the result.
In the Version field, select the latest value.
In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).
In the Parameters section, establish the Collector Parameters as follows below:Collector services detail
Please, replace the placeholders |
{
"cortex_xdr": {
"id": 1,
"enabled": true,
"credentials": {
"api_key": "<api_key_value>",
"api_key_id": "<api_key_id_value>"
},
"services": {
"incidents": {
"api_fqdn": "<api_fqdn_value>",
"api_endpoint": "{api_fqdn}/public_api/v1/incidents/get_incidents",
"incident_extra_data_endpoint": "{api_fqdn}/public_api/v1/incidents/get_incident_extra_data",
"tag": "<opt_tag_value>",
"alert_tag": "<opt_alert_tag_value>",
"request_period_in_seconds": "<opt_request_period_in_seconds_value>",
"start_time": "<opt_start_time>"
},
"alerts": {
"api_fqdn": "<api_fqdn_value>",
"api_endpoint": "{api_fqdn}/public_api/v1/alerts/get_alerts_multi_events",
"alert_tag": "<opt_alert_tag_value>",
"event_tag": "<opt_event_tag_value>",
"request_period_in_seconds": "<opt_request_period_in_seconds_value>",
"start_time": "<opt_start_time>"
}
}
}
} |
The value chosen for the |
This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.
Structure
The following directory structure should be created for being used when running the collector:
<any_directory>
└── devo-collectors/
└── <product_name>/
├── certs/
│ ├── chain.crt
│ ├── <your_domain>.key
│ └── <your_domain>.crt
├── state/
└── config/
└── config.yaml |
Replace |
Devo credentials
In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <product_name>/certs/. Learn more about security credentials in Devo here.
Replace |
Editing the config.yaml file
globals:
debug: false
id: not_used
name: cortex_xdr
persistence:
type: filesystem
config:
directory_name: state
outputs:
devo_1:
type: devo_platform
config:
address: collector-us.devo.io
port: 443
type: SSL
chain: chain.crt
cert: <devo_domain>.crt
key: <devo_domain>.key
console_1:
type: console
inputs:
cortex_xdr:
id: <short_unique_id>
enabled: true
credentials:
api_key: <api_key_value>
api_key_id: <api_key_id_value>
services:
incidents:
request_period_in_seconds : <request_period_in_seconds_value> #optional
start_time: <start_time> #optional
api_fqdn: <api_fqdn_value>
api_endpoint: <api_endpoint_value>
incident_extra_data_endpoint: <incident_extra_data_endpoint_value>
alerts:
start_time: <start_time_value> # Example 2024-01-01T01:50:00Z
request_period_in_seconds: <request_period_in_seconds_value> #optional
api_fqdn: <api_fqdn_value>
api_endpoint: <api_endpoint_value> |
Download the Docker image
The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
Collector Docker image | SHA-256 hash |
|---|---|
|
Use the following command to add the Docker image to the system:
gunzip -c <image_file>-<version>.tgz | docker load |
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace |
The Docker image can be deployed on the following services:
Docker
Execute the following command on the root directory <any_directory>/devo-collectors/<product_name>/
docker run --name collector-<product_name> --volume $PWD/certs:/devo-collector/certs --volume $PWD/config:/devo-collector/config --volume $PWD/state:/devo-collector/state --env CONFIG_FILE=config.yaml --rm --interactive --tty <image_name>:<version> |
Replace |
Docker Compose
The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/ directory.
version: '3'
services:
collector-<product_name>:
image: <image_name>:${IMAGE_VERSION:-latest}
container_name: collector-<product_name>
volumes:
- ./certs:/devo-collector/certs
- ./config:/devo-collector/config
- ./credentials:/devo-collector/credentials
- ./state:/devo-collector/state
environment:
- CONFIG_FILE=${CONFIG_FILE:-config.yaml} |
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/ directory:
IMAGE_VERSION=<version> docker-compose up -d |
Replace |