Skip to content

Latest commit

 

History

History
94 lines (81 loc) · 3.87 KB

DOCKER_USAGE.md

File metadata and controls

94 lines (81 loc) · 3.87 KB
Raw

ULS Docker Usage

This document describes the "docker" of the ULS software.
All commands referenced in this document are run from the repositories root level.
img.png

Table of contents

Requirements

Installation

Obtaining the Docker image

There are two options to retrieve the docker image:

  • DockerHub
    Pull the latest image from DockerHubs online repository 
    docker pull akamai/uls:latest
  • Build using Dockerfile
    Locally build the container using the Dockerfile provided with this repo. 
    docker build --force-rm -t akamai/uls:latest .

For both of the above options the image can be verified with the following command:

docker image ls | grep uls

should return something like (where size, fingerprint and time will differ)

akamai/uls                                                    latest        2a822d4ab406   16 hours ago   929MB

Setup the .EDGERC File

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

docker run ...
...
--mount type=bind,source="/path/to/your/.edgerc",target="/opt/akamai-uls/.edgerc",readonly \
...

Usage

Using the dockerized approach, you have two different ways to set up the options and parameters.

Below are two examples with our Enterprise Threat Protector product:

  • Docker Command Line Arguments:

    docker run -d --name uls_etp-threat -ti \
    --mount type=bind,source="/path/to/your/.edgerc",target="/opt/akamai-uls/.edgerc",readonly \
    akamai/uls \
    --input etp --feed threat --output tcp --host 10.10.10.10 --port 9091

  • Docker Environmental Variables:

    docker run -d --name uls_etp-threat -ti \
    --mount type=bind,source="/path/to/your/.edgerc",target="/opt/akamai-uls/.edgerc",readonly \
    --env ULS_INPUT=ETP \
    --env ULS_FEED=THREAT \
    --env ULS_OUTPUT=TCP \
    --env ULS_OUTPUT_HOST=10.10.10.10 \
    --env ULS_OUTPUT_PORT=9091 \
    akamai/uls

Both of the above examples would do the exact same thing: getting the Enterprise Threat Protector events part of the threat feed and push them into over TCP to the machine 10.10.10.10 on port 9091.

See the full list of supported products and feeds. You can then set input and feed argument from the example above.

You can also find a full set of command line parameters along with the according ENV variables in this document.

Right now, mounting the .edgerc file into the container is the only way applying the authentication. This might get fixed in some later version.
Please change the source= according to your needs within the mount lines.

--mount type=bind,source="/path/to/your/.edgerc",target="/opt/akamai-uls/.edgerc",readonly
  • Display version information 
    docker run -ti --mount type=bind,source="/path/to/your/.edgerc",target="/opt/akamai-uls/.edgerc",readonly --rm akamai/uls -v
    img.png