Cluster CLI environment variables

Estimated reading time: 1 minute

Use the following environment variables as needed to configure the Docker Cluster command-line behavior.

AWS_ACCESS_KEY_ID

Represents your AWS Access Key. Overrides the use of AWS_SHARED_CREDENTIALS_FILE and AWS_PROFILE.

export AWS_ACCESS_KEY_ID="AKIFAKEAWSACCESSKEYNLQ"

AWS_SECRET_ACCESS_KEY

Represents your AWS Secret Key. Overrides the use of AWS_SHARED_CREDENTIALS_FILE and AWS_PROFILE.

export AWS_SECRET_ACCESS_KEY="3SZYfAkeS3cr3TKey+L0ok5/rEalBu71sFak3vmy"

AWS_DEFAULT_REGION

Specifies the AWS region to provision resources.

export AWS_DEFAULT_REGION="us-east-1"

AWS_PROFILE

Specifies the AWS profile name as set in the shared credentials file.

export AWS_PROFILE="default"

AWS_SESSION_TOKEN

Specifies the session token used for validating temporary credentials. This is typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterwards, not the 6 digit MFA code used to get temporary credentials.

export AWS_SESSION_TOKEN=AQoDYXdzEJr...<remainder of security token>

AWS_SHARED_CREDENTIALS_FILE

Specifies the path to the shared credentials file. If this is not set and a profile is specified, ~/.aws/credentials is used.

export AWS_SHARED_CREDENTIALS_FILE="~/.production/credentials"

CLUSTER_ORGANIZATION

Specifies the Docker Hub organization to pull the cluster container.

export CLUSTER_ORGANIZATION="docker"

CLUSTER_TAG

Specifies the tag of the cluster container to pull.

export CLUSTER_TAG="latest"

DOCKER_PASSWORD

Overrides docker password lookup from ~/.docker/config.json.

export DOCKER_PASSWORD="il0v3U3000!"

DOCKER_USERNAME

Overrides docker username lookup from ~/.docker/config.json.

export DOCKER_USERNAME="ironman"
documentation, docs, docker, cluster, infrastructure, automation