Offline installation mode

Akamas is deployed as a set of containerized services running on Docker and managed via Docker Compose. In offine installation mode, the latest version of the Akamas Docker Compose file and all the images required by Docker cannot be downloaded from the AWS ECR repository.

Get Akamas Docker artifacts

Get in contact with Akamas Customer Services to get the latest versions of the Akamas artifacts to be uploaded to a location of your choice on the dedicated Akamas Server.

Akamas installation artifacts will include:

  • images.tar.gz: Akamas main images

  • docker-compose.yml: docker-compose file for Akamas

  • a binary file named akamas: this is the binary file of the akamas CLI that will be used to verify the installation.

Import Docker images

A preliminary step in offline installation mode is to import the shipped Docker images by running the following commands in the same directory where the tar files have been stored:

cd <your bundle files location>
docker image load -i images.tar.gz

Notice that this import procedure could take quite some time!

Configure Akamas environment variables

To configure Akamas, the following environment variables are required to be set:

  • AKAMAS_CUSTOMER: this is the customer name matching the one referenced in the Akamas license.

  • AKAMAS_BASE_URL: this is the endpoint in the Akamas APIs that will be used to interact with the CLI, typically http://<akamas server dns address>:8000

Environment variables creation is performed by the snippet below:

# add double quotes ("xx xx") if the name contains white spaces
export AKAMAS_CUSTOMER=<your name or your organization name>
export AKAMAS_BASE_URL=http://<akamas server dns address>:8000

It is recommended to save these exported variables in your ~/.bashrc file for convenience.

Run installation

To start Akamas you can now simply navigate into the akamas folder and run a docker-compose command as follows:

cd <your docker-compose file location>
docker compose up -d

Notice that you may get the following error:

Error saving credentials: error storing credentials - err: exit status 1, out: Cannot autolaunch D-Bus without X11 $DISPLAY

This is a documented docker bug (see this link) that can be solved by installing the "pass" package:

  • Ubuntu

sudo apt-get install -y pass
  • RHEL

yum install pass

Last updated