Versions Compared

Old Version 1

changes.mady.by.user Juan Tomás Alonso Nieto

Saved on

compared with

New Version 2

changes.mady.by.user Juan Tomás Alonso Nieto

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For more information on how the events are parsed, visit our page.

Flattening preprocessing

Data source

Collector service

Optional

Flattening details

Source

Service

  • yes

  • no

Flattening steps

Minimum configuration required for basic pulling

...

Rw ui tabs macro
Rw tab
titleOn-premise collector

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:

Code Block
<any_directory>
└── devo-collectors/
    └── <product_name>/
        ├── certs/
        │   ├── chain.crt
        │   ├── <your_domain>.key
        │   └── <your_domain>.crt
        ├── state/
        └── config/ 
            └── config.yaml
Note

Replace <product_name> with the proper value.

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.

Note

Replace <product_name> with the proper value.

Editing the config.yaml file

Code Block
globals:
  debug: <debug_status>
  id: not_used
  name: CTCI CEWL Collector
  persistence:
    type: filesystem
    config:
      directory_name: state
outputs:
  devo_us_1:
    type: devo_platform
    config:
      address: <devo_address>
      port: 443
      type: SSL
      chain: <chain_filename>
      cert: <cert_filename>
      key: <key_filename>
inputs:
  ctci:
    id: <input_id_value>
    enabled: true
    credentials:
      api_token: <api_token_value>
    services:
      cewl:
        override_lookup_name: <override_lookup_name_value>
        request_period_in_seconds: <request_period_in_seconds_value>
        obfuscation_data: [<obfuscation_data_values>]
Info

All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the services object.

Replace the placeholders with your required values following the description table below:

Parameter

Data type

Type

Value range / format

Details

debug_status

bool

mandatory

true / false

If the value is true, the debug logging traces will be enabled when running the collector. If the value is false, only the info, warning, and error logging levels will be printed.

devo_address

str

mandatory

collector-us.devo.io

collector-eu.devo.io

Use this parameter to identify the Devo Cloud where the events will be sent.

chain_filename

str

mandatory

minimum length: 4

maximum length: 20

Use this parameter to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: chain.crt.

cert_filename

str

mandatory

minimum length: 4

maximum length: 20

Use this parameter to identify the file.cert downloaded from your Devo domain.

key_filename

str

mandatory

minimum length: 4

maximum length: 20

Use this parameter to identify the file.key downloaded from your Devo domain.

input_id_value

str

mandatory

minimum length: 1

maximum length: 5

Use this parameter to give a unique ID to this input service.

Info

This parameter is used to build the persistence address; do not use the same value for multiple collectors. It could cause a collision.

input_status

bool

mandatory

true / false

Use this parameter to enable or disable the given input logic when running the collector. If the value is true, the input will be run. If the value is false, it will be ignored.

api_token_value

str

mandatory

The API token copied from the admin portal.

override_lookup_name_value

str

optional

Devo tag-friendly string (no special characters, spaces, etc.)

An optional configuration that allows the user to specify a new name for the CEWL lookup table. 

Info

The default value is ctci_cewl if this parameter is not specified

request_period_in_seconds_value

int

optional

minimum length: 1

Period in seconds used between each data pulling. This value will overwrite the default value (300 seconds).

Info

This parameter can be removed or commented.

obfuscation_data_value

array<object>

optional

The objects in the array look like this:

Code Block
obfuscation_data:

  • name:

  • credentials

    • 
:
  - name:
      -
credentials
      - "*"
    
    value: 
"**********"

    Each object represents the necessary configuration to obfuscate messages before these are sent to Devo.

    Info

    This parameter can be removed or commented.

    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

    collector-ctci_collector-docker-image-1.0.0.tgz

    087aecb3c9e76190f0c3088caedd3ad7ab451bbf0548a2cf9f729e691b2f30b4

    Use the following command to add the Docker image to the system:

    Code Block
    gunzip -c <image_file>-<version>.tgz | docker load
    Note

    Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace <image_file> and <version> with a proper value.

    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>/

    Code Block
    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>
    Note

    Replace <product_name>, <image_name> and <version> with the proper values.

    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.

    Code Block
    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:

    Code Block
    IMAGE_VERSION=<version> docker-compose up -d
    Note

    Replace <product_name>, <image_name> and <version> with the proper values.

    Rw tab
    titleCloud collector

    We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.

    ...