Page Comparison

...

Rw ui tabs macro

Rw tab

title	Cloud 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.

Rw tab

title	On-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.

Image Removed

Image Added

Note
Replace `<product_name>` with the proper value.

Editing the config.yaml file

Code Block

globals:
  debug: false
  id: not_used
  name: cyberark_epm
  persistence:
    type: filesystem
    config:
      directory_name: state
outputs:
  devo_1:
    type: devo_platform
    config:
      address: <some_url>.<some_region>.devo.io
      port: <PORT>
      type: SSL
      chain: <some_chain.crt>
      cert: <some_certificate.crt>
      key: <some_key.key>
  console_1:
    type: console

inputs:
  cyberark:
    id: "<short_unique_id>"
    enabled: true
    credentials:
      auth_url: <auth_url>
      username: <username>
      password: <password>
      application_id: <app_id>
    services:
      admin_audit:
        date_from: <date_from>
        tag: <tag>
      raw_events:
        date_from: <date_from>
        tag: <tag>
      policy_event:
        date_from: <date_from>
        tag: <tag>
      aggregate_events:
        date_from: <date_from>
        tag: <tag>
      aggregated_policy_audit:
        date_from: <date_from>
        tag: <tag>

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`	false / true	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.
`address`	`str`	`Mandatory`		The address associated with your Devo account where your data will be received.
`auth_url`	`str`	`Mandatory`		The auth url associated with your CyberArk account.
`username`	`str`	`Mandatory`		The username associated with your CyberArk account.
`password`	`str`	`Mandatory`		The password associated with your CyberArk account
`application_id`	`str`	`Mandatory`		The application id associated with your CyberArk account.
`from_date`	`str`	`Optional`		The date from which you want to fetch data for each service. If not provides, ‘current_time - 1 hr’ will be taken.
`tag`	`str`	`Optional`		Tag where you want to send data. If not provided, default values will be taken. Refer to Data source description section.

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-cyberark_epm_if-docker-image-1.01.0.tgz	`4475e04a30dcc66944e14b68d03f3446e362f8ceb41f543803196659df83eb75b8d65b638e3d5f4c5098fe3398af406f2dd645e271712e5db86aadd07fc08dcb`

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.

...

Versions Compared

Old Version 3

New Version Current

Key

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose