Skip to content

Latest commit

 

History

History
70 lines (58 loc) · 3.02 KB

DOCKER-COMPOSE_USAGE.md

File metadata and controls

70 lines (58 loc) · 3.02 KB
Raw

ULS Docker-Compose Usage

This document describes the "docker compose" of the ULS software.
All commands referenced in this document are run from the repositories root level.
The docker compose command used in this doc, was recently integrated into the docker cli (currently beta). Nevertheless, all of the docker-composecommands will work as well.

ULS docker compose usage

Table of contents

Requirements

  • Docker needs to be installed on an linux OS (Windows not supported)
  • docker-compose needs to be installed alongside docker
    As alternative to the above, you can now use the latest docker cli with the command docker compose
  • Access to the docker image (see Installation section)
  • Akamai API credentials file - .edgerc (see API Credentials for creation instructions)
  • Understanding of available ULS Environmental Variables

Installation

Obtaining the Docker image

please see the "Obtaining the Docker image" section in the Docker_Usage file.

Setup the .EDGERC File

Make sure you refer the path to your .edgerc file (instructions for creation) within the .env files.

Usage

Docker compose is the recommended way to run AKAMAI ULS in a production environment.
Docker compose enables the definition of multiple parallel uls instances providing different data to multiple ingestion points.

To start the docker-compose script please run the following:

cd docker-compose/simple
docker compose up

In order to run the docker-compose as DAEMON in the background, use the following command

cd docker-compose/simple
docker compose up -d

Usage Examples

  • Simple docker-compose setup that will ship ETP-THREAT events via TCP

    cd docker-compose/simple
docker compose up

    This will run the "simple" use case in foreground. The docker-compose.yml file will reference the etp-threat.env and provide the configuration from that file.
    Files:

  • Complex docker-compose setup delivering different streams to different endpoints

    cd docker-compose/complex
docker compose up

    This triggers a more complex setup consisting out of 3 different data feeds.
    Files: