The following environment variables are available for use in the delegate manifest. Some of these variables are included in the YAML by default; you can specify others based on use case.
The Harness account Id of the account with which this delegate registers.
This value is automatically added to the delegate configuration file (the application manifest of a Kubernetes delegate) when you add the delegate.
- name: ACCOUNT_ID
The Harness account token that is used to register the delegate.
- name: ACCOUNT_SECRET
A text description of the delegate. The description is added to the delegate before registration, in Harness Manager or in YAML. This value is displayed on the delegate details page in Harness Manager.
- name: DELEGATE_DESCRIPTION
The name of the delegate. This is the name that identifies a registered delegate in Harness.
This value is not specified when delegate creation is automated. Instead, a script is used to duplicate the delegate YAML file and add a unique name to the
DELEGATE_NAME environment variable for each delegate to be registered. Go to Automate delegate installation.
- name: DELEGATE_NAME
The namespace for the delegate is taken from the
- name: DELEGATE_NAMESPACE
The Harness organization Identifier in which the delegate registers.
Delegates at the account level do not have a value for this variable.
- name: DELEGATE_ORG_IDENTIFIER
The Harness project Identifier in which the delegate registers.
Delegates at the account or organization level do not have a value for this variable.
- name: DELEGATE_PROJECT_IDENTIFIER
Delegate tags are descriptors that are added to the delegate before the registration process, in Harness Manager or in YAML. Harness generates tags based on the delegate name; you can add others. You can specify multiple tags in YAML as a comma-separated list.
- name: DELEGATE_TAGS
- name: DELEGATE_TAGS
value: has_jq, has_gcloud
Harness enables you to configure a maximum number of tasks for each delegate. This allows Harness Manager to use the task capacity to determine whether to assign a task to the delegate or queue it.
- name: DELEGATE_TASK_CAPACITY
For example, if you set
DELEGATE_TASK_CAPACITY to a value of 2 and execute 6 tasks in parallel, Harness Manager only executes 2 tasks at a time. If you don't configure
DELEGATE_TASK_CAPACITY, Harness Manager executes all 6 tasks in parallel.
This functionality is currently behind the feature flag
DELEGATE_TASK_CAPACITY_CHECK and is available for Harness NextGen only. Contact Harness Support to enable the feature. When the feature flag is enabled, the task is broadcast every minute in Harness Manager until it expires.
The type of the delegate.
- name: DELEGATE_TYPE
Used to specify a script that runs when the delegate is initialized. You can use this environment variable to run scripts on the delegate but this is not a best practice. Delegate initialization should be built into the image; not determined on startup.
- name: INIT_SCRIPT
value: echo install wget
apt-get install wget
echo wget installed
JAVA_OPTS environment variable to add or override JVM parameters. The delegate accepts the following JVM options.
- name: JAVA_OPTS
value: "-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap -XX:MaxRAMFraction=2 -Xms64M"
Use this variable to specify the endpoint for your log service in Harness NextGen. This variable is not used in Harness FirstGen.
- name: LOG_STREAMING_SERVICE_URL
The Harness SaaS manager URL. The specification of HTTPS in the URL indicates the use of port 443.
- name: MANAGER_HOST_AND_PORT
Whether the delegate is registers in Harness NextGen or FirstGen. A value of
true indicates that the delegate registers in Harness NextGen; a value of
false indicates that the delegate registers in FirstGen.
- name: NEXT_GEN
Enables or disables polling for delegate tasks.By default, the Delegate uses Secure WebSocket (WSS) for tasks. If the
PROXY\_\* settings are used and the proxy or some intermediary does not allow WSS, then set
POLL\_FOR\_TASKS to true to enable polling.
- name: POLL_FOR_TASKS
Delegates send logs to Harness by default. Harness uses these logs for debugging and support. To disable this functionality, set this value to "false".
- name: STACK_DRIVER_LOGGING_ENABLED
You can use delegate proxy settings to change how the delegate connects to Harness Manager.
secretKeyRef values are named based on delegate name.
- name: PROXY_HOST
- name: PROXY_PORT
- name: PROXY_SCHEME
- name: NO_PROXY
- name: PROXY_MANAGER
- name: PROXY_USER
- name: PROXY_PASSWORD