Skip to main content

Docker delegate environment variables

The following environment variables are available for use in the Docker delegate manifest. Some of these variables are included in the YAML by default; you can specify others based on use case.

ACCOUNT_ID

The Harness account ID for the account with which this delegate registers.

- ACCOUNT_ID = XXXXXXxxxxxxxxxx

DELEGATE_TOKEN

The Harness account token that is used to register the delegate.

- DELEGATE_TOKEN = d229ee88bf7bbxxxx6ea

MANAGER_HOST_AND_PORT

The Harness SaaS manager URL. https indicates port 443.

- MANAGER_HOST_AND_PORT = https://app.harness.io

WATCHER_STORAGE_URL

The URL location of the Watcher versions. For more information, go to Delegate installation overview.

- WATCHER_STORAGE_URL = https://app.harness.io/public/prod/premium/watchers

WATCHER_CHECK_LOCATION

The location of the delegate version that the Watcher references.

- name: WATCHER_CHECK_LOCATION  
value: current.version

REMOTE_WATCHER_URL_CDN

The CDN URL for Watcher builds.

- name: REMOTE_WATCHER_URL_CDN  
value: https://app.harness.io/public/shared/watchers/builds

DELEGATE_STORAGE_URL

The URL where published delegate JAR files are stored.

- name: DELEGATE_STORAGE_URL  
value: https://app.harness.io

DELEGATE_CHECK_LOCATION

The storage location that hosts the published delegate versions.

- name: DELEGATE_CHECK_LOCATION  
value: delegateprod.txt

DEPLOY_MODE

The mode of deployment, for example, Kubernetes or Docker.

- name: DEPLOY_MODE  
value: DOCKER

DELEGATE_NAME

The name of the delegate. This is the name that appears in Harness when the delegate is registered.

You can automate delegate creation by omitting the name and using a script to copy the delegate YAML file, giving a unique name to the value of the delegate name for each newly created delegate you want to register.

For more information, go to Automate delegate installation.

- name: DELEGATE_NAME  
value: qa

NEXT_GEN

Indicates whether the delegate registers in Harness NextGen (true) or FirstGen (false).

- name: NEXT_GEN  
value: "true"

DELEGATE_DESCRIPTION

The description that is given to the delegate in Harness Manager or YAML before the delegate registers. The description appears on the delegate details page in Harness Manager.

- name: DELEGATE_DESCRIPTION  
value: ""

DELEGATE_TYPE

The type of the delegate.

- name: DELEGATE_TYPE  
value: "DOCKER"

DELEGATE_TAGS

The tags that were added to the delegate in Harness Manager or YAML before delegate registration.

Harness generates tags based on the delegate name. You can add others. The tags appear on the delegate details page in Harness Manager.

For more information, go to Tags reference and Select delegates with tags.

- name: DELEGATE_TAGS  
value: ""

DELEGATE_TASK_LIMIT

The maximum number of tasks the delegate can perform at one time. Delegate operations are categorized as different types of tasks.

- name: DELEGATE_TASK_LIMIT  
value: "50"

DELEGATE_ORG_IDENTIFIER

The Harness organization Identifier where the delegate registers.

This value is not specified for delegates at the account level.

- name: DELEGATE_ORG_IDENTIFIER  
value: "engg"

DELEGATE_PROJECT_IDENTIFIER

The Harness project Identifier within which the delegate registers.

This value is not specified for delegates at the account or organization level.

- name: DELEGATE_PROJECT_IDENTIFIER  
value: "myproject"

PROXY_MANAGER

Indicates whether to use Harness Manager or a proxy. A value of true indicates an outbound proxy of traffic to Harness.

The default value is true.

- PROXY_MANAGER = true

INIT_SCRIPT

You can use this environment variable to run scripts on the delegate. For example, you can add a script to INIT_SCRIPT to install software on the delegate pod. The software is installed after you apply the delegate YAML.

A multiline script must follow the YAML spec for literal scalar style.

For more information, go to Build custom delegate images with third-party tools.

- INIT_SCRIPT =  echo hello world!

USE_CDN

Specifies the delegate use of a CDN for new versions.

- name: USE_CDN  
value: "true"

CDN_URL

The CDN URL for delegate versions.

- name: CDN_URL  
value: https://app.harness.io

VERSION_CHECK_DISABLED

By default, the delegate always checks for new versions (using the Watcher).

- name: VERSION_CHECK_DISABLED  
value: "false"

See also

Delegate environment variables