Configuration Options

agent.sh Argument
Environment Variable
Description
-a
STEADYBIT_AGENT_KEY
The API key the agent uses
Example: foobar
-h
​
Override the hostname for the docker container to use. Useful on docker for mac
-e
STEADYBIT_AGENT_REGISTER_URL
The baseUrl where the agent registers.
Default: https://platform.steadybit.com
-i
STEADYBIT_AGENT_DOCKER_IMAGE
The Agent Docker image to use.
Default: steadybit/agent:latest
-r
STEADYBIT_DOCKER_REGISTRY
The Agent Docker registry to use.
-u
STEADYBIT_DOCKER_REGISTRY_USER
User for authenticating against the Docker Registry.
Default: _
-p
STEADYBIT_DOCKER_REGISTRY_PASSWORD
Password for authenticating against the Docker Registry.
Default: STEADYBIT_AGENT_KEY
-l
STEADYBIT_LOG_LEVEL
Sets the loglevel for the com.steadybit logger
Default: INFO
​
STEADYBIT_ROOT_LOG_LEVEL
Sets the loglevel for the root logger
Default: ERROR
​
STEADYBIT_LOG_CONSOLE
Sets the loglevel threshold for the console logger
Default: ALL
​
STEADYBIT_LOG_FORMAT
Sets the log format for the console logger (json or text)
Default: text
​
STEADYBIT_AGENT_REGISTER_TIMEOUT
Timeout for the registration request.
Default: 5s
​
STEADYBIT_AGENT_REGISTER_INTERVAL
The interval how often the agent registers at the platform.
Default: 5s
​
STEADYBIT_AGENT_EXPERIMENT_TIMEOUT
Timeout for the request to connect to an experiment.
Default: 5s
​
STEADYBIT_AGENT_EXPERIMENT_KEEP_ALIVE_INTERVAL
Interval how often a keep alive is sent during an experiment.
Default: 2s
​
STEADYBIT_AGENT_EXPERIMENT_KEEP_ALIVE_TIMEOUT
Timeout for a keep alive during an experiment
Default: 10s
​
STEADYBIT_AGENT_DISCOVERY_INTERVAL
The interval of often the agent runs the discovery.
Default: 30s
​
STEADYBIT_AGENT_DISCOVERY_TIMEOUT
Timeout for the discovery.
Default: 10s
​
STEADYBIT_AGENT_ATTRIBUTE_FILTER_SKIP_DEFAULTS
Should the default excludes be ignored? (Default excludes: label.io.kubernetes.,label.annotation.io.kubernetes.,k8s.pod.label.controller-revision-hash,k8s.pod.label.pod-template-generation,k8s.pod.label.pod-template-hash)
Default: false
​
STEADYBIT_AGENT_ATTRIBUTE_FILTER_EXCLUDES
Attribute-Keys which should not be sent to the platform.
​
STEADYBIT_AGENT_ATTRIBUTE_FILTER_INCLUDES
Attribute-Keys which should be sent to the platform, even if they are excluded by STEADYBIT_AGENT_ATTRIBUTE_FILTER_EXCLUDES or the default excludes.
​
STEADYBIT_AGENT_GZIP_ENABLED
The interval of often the agent runs the discovery.
Default: true
​
STEADYBIT_DOCKER_SOCKET
Docker Socket to connect to.
Default: /var/run/docker.sock
​
STEADYBIT_DISCOVERY_ENV_LIST
List of environment variables to inlude in the discovery
Example: STEADYBIT_DISCOVERY_ENV_LIST=STAGE,REGION
​
STEADYBIT_LABEL_*
All env vars with this prefix will be added as label
Example: STEADYBIT_LABEL_STAGE=test
​
STEADYBIT_AGENT_AWS_EC2_METADATA_URL
AWS EC2 Metadata URL
Default: http://169.254.169.254/latest/
​
STEADYBIT_HTTP_ENDPOINT_PORT
HTTP endpoint port for the health check url
Default: 42999
​
STEADYBIT_AGENT_ACTIONS_ENABLED
Should this agent be eligible for executing actions?
Default: true
​
STEADYBIT_AGENT_PROXY_HOST
Hostname of a proxy to access steadybit platform

​
STEADYBIT_AGENT_PROXY_PORT
Port of a proxy to access steadybit platform

​
STEADYBIT_AGENT_PROXY_PROTOCOL
Protocol of a proxy to access steadybit platform
Default: http
​
STEADYBIT_AGENT_PROXY_USER
Username of a proxy to access steadybit platform

​
STEADYBIT_AGENT_PROXY_PASSWORD
Password of a proxy to access steadybit platform

​
STEADYBIT_AGENT_MODE
Currently there are 2 modes: default and aws. More details for the aws mode can be found here
Default: default
​
STEADYBIT_AGENT_AWS_ASSUME_ROLE_LIST
The AWS agent has an option to assume into a list of given Role-ARNs. More detail here
Default: empty, means that the agent does not assume into roles and just uses its own credentials.
​
STEADYBIT_AGENT_IDENTIFIER
The identifier which will be used to register the agent at the platform
Default: The agent will use the hostname as identifier
​
STEADYBIT_AGENT_DISCOVERIES_DISABLED
Option to disable single discoveries
Default: empty
​
STEADYBIT_AGENT_AUTH_PROVIDER
The auth mechanism to use - OAUTH2 or AGENT-KEY
Default: AGENT-KEY
​
STEADYBIT_AGENT_AUTH_OAUTH2_CLIENT_ID
The public identifier of your OAuth 2.0 Client
​
STEADYBIT_AGENT_AUTH_OAUTH2_CLIENT_SECRET
The client secret
​
STEADYBIT_AGENT_AUTH_OAUTH2_ISSUER_URI
The issuer uri of the identity provider
​
STEADYBIT_AGENT_AUTH_OAUTH2_TOKEN_URI
The token uri of the identity provider to directly specify the URL to retrieve the access tokens from
​
STEADYBIT_AGENT_AUTH_OAUTH2_AUDIENCE
Optional - Some provider needs the audience parameter to authenticate the client.
​
STEADYBIT_AGENT_AUTH_OAUTH2_AUTHORIZATION_GRAN_TYPE
The grant type to use either client_credentials or password.
Default: client_credentials
​
STEADYBIT_AGENT_AUTH_OAUTH_USERNAME
The username to use for the username flow
​
STEADYBIT_AGENT_AUTH_OAUTH_PASSWORD
The username to use when using the password flow
​
STEADYBIT_AGENT_AUTH_OAUTH_CLIENT_CERT_CHAIN_FILE
Optional - the x.509 client certificate to use for mutual TLS with the identity provider.
​
STEADYBIT_AGENT_AUTH_OAUTH_CLIENT_CERT_KEY_FILE
Optional - the PKCS#8 encoded private key to use for mutual TLS with the identity provider
​
STEADYBIT_AGENT_AUTH_OAUTH_CLIENT_CERT_PASSWORD
Optional - Password for the the PKCS#8 encoded private key to use for mutual TLS with the identity provider

agent.sh Argument	Environment Variable	Description
-a	`STEADYBIT_AGENT_KEY`	The API key the agent uses Example: `foobar`
-h		Override the hostname for the docker container to use. Useful on docker for mac
-e	`STEADYBIT_AGENT_REGISTER_URL`	The baseUrl where the agent registers. Default: `https://platform.steadybit.com`
-i	`STEADYBIT_AGENT_DOCKER_IMAGE`	The Agent Docker image to use. Default: `steadybit/agent:latest`
-r	`STEADYBIT_DOCKER_REGISTRY`	The Agent Docker registry to use.
-u	`STEADYBIT_DOCKER_REGISTRY_USER`	User for authenticating against the Docker Registry. Default: `_`
-p	`STEADYBIT_DOCKER_REGISTRY_PASSWORD`	Password for authenticating against the Docker Registry. Default: STEADYBIT_AGENT_KEY
-l	`STEADYBIT_LOG_LEVEL`	Sets the loglevel for the com.steadybit logger Default: `INFO`
	`STEADYBIT_ROOT_LOG_LEVEL`	Sets the loglevel for the root logger Default: `ERROR`
	`STEADYBIT_LOG_CONSOLE`	Sets the loglevel threshold for the console logger Default: `ALL`
	`STEADYBIT_LOG_FORMAT`	Sets the log format for the console logger (`json` or `text`) Default: `text`
	`STEADYBIT_AGENT_REGISTER_TIMEOUT`	Timeout for the registration request. Default: `5s`
	`STEADYBIT_AGENT_REGISTER_INTERVAL`	The interval how often the agent registers at the platform. Default: `5s`
	`STEADYBIT_AGENT_EXPERIMENT_TIMEOUT`	Timeout for the request to connect to an experiment. Default: `5s`
	`STEADYBIT_AGENT_EXPERIMENT_KEEP_ALIVE_INTERVAL`	Interval how often a keep alive is sent during an experiment. Default: `2s`
	`STEADYBIT_AGENT_EXPERIMENT_KEEP_ALIVE_TIMEOUT`	Timeout for a keep alive during an experiment Default: `10s`
	`STEADYBIT_AGENT_DISCOVERY_INTERVAL`	The interval of often the agent runs the discovery. Default: `30s`
	`STEADYBIT_AGENT_DISCOVERY_TIMEOUT`	Timeout for the discovery. Default: `10s`
	`STEADYBIT_AGENT_ATTRIBUTE_FILTER_SKIP_DEFAULTS`	Should the default excludes be ignored? (Default excludes: `label.io.kubernetes.`,`label.annotation.io.kubernetes.`,`k8s.pod.label.controller-revision-hash`,`k8s.pod.label.pod-template-generation`,`k8s.pod.label.pod-template-hash`) Default: `false`
	`STEADYBIT_AGENT_ATTRIBUTE_FILTER_EXCLUDES`	Attribute-Keys which should not be sent to the platform.
	`STEADYBIT_AGENT_ATTRIBUTE_FILTER_INCLUDES`	Attribute-Keys which should be sent to the platform, even if they are excluded by STEADYBIT_AGENT_ATTRIBUTE_FILTER_EXCLUDES or the default excludes.
	`STEADYBIT_AGENT_GZIP_ENABLED`	The interval of often the agent runs the discovery. Default: `true`
	`STEADYBIT_DOCKER_SOCKET`	Docker Socket to connect to. Default: `/var/run/docker.sock`
	`STEADYBIT_DISCOVERY_ENV_LIST`	List of environment variables to inlude in the discovery Example: `STEADYBIT_DISCOVERY_ENV_LIST=STAGE,REGION`
	`STEADYBIT_LABEL_*`	All env vars with this prefix will be added as label Example: `STEADYBIT_LABEL_STAGE=test`
	`STEADYBIT_AGENT_AWS_EC2_METADATA_URL`	AWS EC2 Metadata URL Default: `http://169.254.169.254/latest/`
	`STEADYBIT_HTTP_ENDPOINT_PORT`	HTTP endpoint port for the health check url Default: `42999`
	`STEADYBIT_AGENT_ACTIONS_ENABLED`	Should this agent be eligible for executing actions? Default: `true`
	`STEADYBIT_AGENT_PROXY_HOST`	Hostname of a proxy to access steadybit platform
	`STEADYBIT_AGENT_PROXY_PORT`	Port of a proxy to access steadybit platform
	`STEADYBIT_AGENT_PROXY_PROTOCOL`	Protocol of a proxy to access steadybit platform Default: `http`
	`STEADYBIT_AGENT_PROXY_USER`	Username of a proxy to access steadybit platform
	`STEADYBIT_AGENT_PROXY_PASSWORD`	Password of a proxy to access steadybit platform
	`STEADYBIT_AGENT_MODE`	Currently there are 2 modes: `default` and `aws`. More details for the `aws` mode can be found here Default: `default`
	`STEADYBIT_AGENT_AWS_ASSUME_ROLE_LIST`	The AWS agent has an option to assume into a list of given Role-ARNs. More detail here Default: empty, means that the agent does not assume into roles and just uses its own credentials.
	`STEADYBIT_AGENT_IDENTIFIER`	The identifier which will be used to register the agent at the platform Default: The agent will use the hostname as identifier
	`STEADYBIT_AGENT_DISCOVERIES_DISABLED`	Option to disable single discoveries Default: empty
	`STEADYBIT_AGENT_AUTH_PROVIDER`	The auth mechanism to use - `OAUTH2` or `AGENT-KEY` Default: `AGENT-KEY`
	`STEADYBIT_AGENT_AUTH_OAUTH2_CLIENT_ID`	The public identifier of your OAuth 2.0 Client
	`STEADYBIT_AGENT_AUTH_OAUTH2_CLIENT_SECRET`	The client secret
	`STEADYBIT_AGENT_AUTH_OAUTH2_ISSUER_URI`	The issuer uri of the identity provider
	`STEADYBIT_AGENT_AUTH_OAUTH2_TOKEN_URI`	The token uri of the identity provider to directly specify the URL to retrieve the access tokens from
	`STEADYBIT_AGENT_AUTH_OAUTH2_AUDIENCE`	Optional - Some provider needs the audience parameter to authenticate the client.
	`STEADYBIT_AGENT_AUTH_OAUTH2_AUTHORIZATION_GRAN_TYPE`	The grant type to use either `client_credentials` or `password`. Default: `client_credentials`
	`STEADYBIT_AGENT_AUTH_OAUTH_USERNAME`	The username to use for the username flow
	`STEADYBIT_AGENT_AUTH_OAUTH_PASSWORD`	The username to use when using the password flow
	`STEADYBIT_AGENT_AUTH_OAUTH_CLIENT_CERT_CHAIN_FILE`	Optional - the x.509 client certificate to use for mutual TLS with the identity provider.
	`STEADYBIT_AGENT_AUTH_OAUTH_CLIENT_CERT_KEY_FILE`	Optional - the PKCS#8 encoded private key to use for mutual TLS with the identity provider
	`STEADYBIT_AGENT_AUTH_OAUTH_CLIENT_CERT_PASSWORD`	Optional - Password for the the PKCS#8 encoded private key to use for mutual TLS with the identity provider

Install AWS Cloud Service Agent

FAQ

Last modified 3mo ago