Using the container image

In this section we'll use the Docker image locally, which is useful for integration, testing, and troubleshooting. Docker, e.g. Docker Desktop, must be installed and running. You should also create a new empty directory to which you can change (cd).

The directory will be used to store Airlock IAM configuration files:

Preparation

 
Example
mkdir -p ~/airlock-iam-docker && cd ~/airlock-iam-docker  # Create new directory
docker info  # Make sure Docker daemon is running

Using the CLI to perform application-level configuration tasks works very similarly to the way it does on a traditional installation without docker. The iam command is the default entry-point of the Docker image.

This means that any CLI command can be executed inside a Docker image as follows:

Docker CLI

 
Example
# Show all available parameters and their default values
docker run --rm quay.io/airlock/iam:8.5 default-parameters

# Correct permissions when using native Docker on Linux
mkdir -p "$(pwd)/iam" && sudo chown -R 1000:0 "$(pwd)/iam"

# Create new instance named "auth", enable license analytics
docker run --rm -v "$(pwd)/iam:/home/airlock/iam" quay.io/airlock/iam:8.5 init --instance auth --analytics LICENSE_DATA

# Upgrade configuration of instance named "auth", enable license analytics
docker run --rm -v "$(pwd)/iam:/home/airlock/iam" quay.io/airlock/iam:8.5 upgrade -i auth -a LICENSE_DATA

# Run Airlock IAM and forward the HTTPS port 8443 to the host
docker run --rm -v "$(pwd)/iam:/home/airlock/iam" -p 8443:8443 quay.io/airlock/iam:8.5 run -i auth
 
Notice

Starting with IAM 8.5, the IAM license and analytics feature is mandatory. If it is not configured, configuration activation will fail. The IAM CLI is used to configure the analytics plugin, during the init, reset, and upgrade operations. When you run any of these operations, you must specify your preferred analytics mode. For more information, see License and usage analytics.

Shell access

To access the Airlock IAM CLI without a running container:

Docker CLI

 
Example
docker run --rm -it --entrypoint /bin/bash -v "$(pwd)/iam:/home/airlock/iam" quay.io/airlock/iam:8.5