analyze-containers client

The analyze containers client image contains the code used to pull and build other images required by the deployment and also run the analyze-deployment-tooling scripts.

Running an analyze-containers client container

An analyze-containers client container uses the analyze-containers client image. In the docker run command, you can use -e to pass environment variables to the container. The environment variables are described in environment variables

The default user is called i2analyze with User ID and Group ID 1000 (this can be changed with the USER_ID and GROUP_ID env variables).

For more information about the command, see docker run reference.

Docker run command

docker run \
  --rm \
  -i \
  -w /opt/analyze-deployment-tooling \
  "${BIND_MOUNTS[@]}" \
  -v "${PATH_TO_DIR}:${PATH_TO_DIR}" \
  -v "ac_m2:/home/i2analyze/.m2" \
  -v "/var/run/docker.sock:/var/run/docker-host.sock" \
  -v "ac_tmp:/opt/analyze-deployment-tooling/.tmp" \
  -e DOCKER_BUILDKIT=1 \
  -e WORKDIR="${PATH_TO_DIR}" \
  -e HOST_HOME="${HOME}" \
  -e USER_ID="$(id -u)" -e GROUP_ID="$(id -g)" \
  "i2eng-analyze-containers-client:3.0.1" "$@"

The local user ID is required so that a user is created in the Docker container with a USER_ID that is the same as the local user. The user is required to ensure that the local user can access any files that are generated on the container. The value of $id comes from your shell.

Bind mounts

The value for BIND_MOUNTS is the paths that are specified as the rootDirectory and upgradeDirectory in the path-configuration.json file. For more information about the path-configuration.json file, see Managing shared configurations.

The value for PATH_TO_DIR is the path where analyze-deployment-tooling is installed. This path is mounted into the analyze-containers client image.

Environment variables

Environment variable	Description
WORKDIR	Where the local version of analyze-deployment-tooling is installed.
USER_ID	The id of the current user.
GROUP_ID	The id of the current user's group.
DOCKER_BUILDKIT	Enable Docker BuildKit.