Beer Garden Configuration

This document describes the configuration for Beer Garden. Each section will document a particular configuration value and its description. First, though, we start with the possible sources.

This documentation was auto-generated by yapconf, then converted to AsciiDoc via kramdoc.

Sources

Beer Garden configuration can be loaded from the below sources:

Configuration

This section outlines the various configuration items Beer Garden supports.

Name Type Default Description

auth.authentication_handlers.basic.enabled

bool

True

Enable authentication via username andpassword

auth.authentication_handlers.trusted_header.create_users

bool

True

Create an account for the user specified byusername_header if one does not already exist

auth.authentication_handlers.trusted_header.enabled

bool

False

Enable authentication via trusted headers

auth.authentication_handlers.trusted_header.user_alias_mapping_header

str

bg-user-alias-mapping

The http header containing the JSON list of the user’s alias user accounts mapping

auth.authentication_handlers.trusted_header.user_local_roles_header

str

bg-user-local-roles

The http header containing the str list of the user’s local role names

auth.authentication_handlers.trusted_header.user_upstream_roles_header

str

bg-user-upstream-roles

The http header containing the JSON list of the user’s roles

auth.authentication_handlers.trusted_header.username_header

str

bg-username

The http header containing the username

auth.default_admin.password

str

password

The password for the default admin account that will be created when initializing a new environment

auth.default_admin.username

str

admin

The username for the default admin account that will be created when initializing a new environment

auth.enabled

bool

False

Use role-based authentication / authorization

auth.role_definition_file

str

None

Path to the yaml file that defines roles used for authorization

auth.token_access_ttl.garden_admin

int

15

The Garden Admin Permission access token expiration time

auth.token_access_ttl.operator

int

15

The Operator Permission access token expiration time

auth.token_access_ttl.plugin_admin

int

15

The Plugin Admin Permission access token expiration time

auth.token_access_ttl.read_only

int

15

The Read Only Permission access token expiration time

auth.token_refresh_ttl.garden_admin

int

720

The Garden Admin Permission refresh token expiration time

auth.token_refresh_ttl.operator

int

720

The Operator Permission refresh token expiration time

auth.token_refresh_ttl.plugin_admin

int

720

The Plugin Admin Permission refresh token expiration time

auth.token_refresh_ttl.read_only

int

720

The Read Only Permission refresh token expiration time

auth.token_secret

str

Secret to use when signing authentication tokens

auth.user_definition_file

str

None

Path to the yaml file that defines users used for authorization

children.directory

str

./children

Directory where child garden configs are located

configuration.file

str

None

Path to configuration file to use

db.connection.host

str

localhost

Hostname/IP of the database server

db.connection.password

str

None

Password to connect to the database

db.connection.port

int

27017

Port of the database server

db.connection.username

str

None

Username to connect to the database

db.name

str

beer_garden

Name of the database to use

db.prune_interval

int

15

Number of minutes to wait before running db pruner

db.ttl.action

int

-1

Number of minutes to wait before deleting ACTION requests (negative number for never)

db.ttl.admin

int

-1

Number of minutes to wait before deleting Admin requests (negative number for never)

db.ttl.batch_size

int

-1

Batch size for deleting documents (negative number for never)

db.ttl.file

int

15

Number of minutes to wait before deleting FILE documents (negative number for never)

db.ttl.in_progress

int

-1

Number of minutes to wait for a request in CREATED or IN_PROGRESSto complete before considering timed out and marking as CANCELLED(negative number for never)

db.ttl.info

int

15

Number of minutes to wait before deleting INFO requests (negative number for never)

db.ttl.temp

int

15

Number of minutes to wait before deleting TEMP requests (negative number for never)

entry.http.enabled

bool

True

Run an HTTP server

entry.http.host

str

0.0.0.0

Host for the HTTP Server to bind to

entry.http.port

int

2337

Serve content on this port

entry.http.ssl.ca_cert

str

None

Path to CA certificate file to use for SSLContext

entry.http.ssl.ca_path

str

None

Path to CA certificate path to use for SSLContext

entry.http.ssl.client_cert_verify

str

NONE

Client certificate mode to use when handling requests

entry.http.ssl.enabled

bool

False

Serve content using SSL

entry.http.ssl.private_key

str

None

Path to a private key

entry.http.ssl.public_key

str

None

Path to a public key

entry.http.url_prefix

str

/

URL path prefix

entry.stomp.enabled

bool

False

Connect to a Stomp Broker

entry.stomp.headers

list

[]

Headers to be sent with messages. Follows standard YAML formatting for lists with two variables 'key' and 'value'

entry.stomp.host

str

localhost

Broker hostname

entry.stomp.password

str

None

Password to use for authentication

entry.stomp.port

int

61613

Broker port

entry.stomp.send_destination

str

None

Topic where events are published

entry.stomp.ssl.ca_cert

str

None

Path to certificate file containing the certificate of the authority that issued the message broker certificate

entry.stomp.ssl.client_cert

str

None

Path to client public certificate to use when communicating with the message broker

entry.stomp.ssl.client_key

str

None

Path to client private key to use when communicating with the message broker

entry.stomp.ssl.use_ssl

bool

False

Use SSL when connecting to the message broker

entry.stomp.subscribe_destination

str

None

Topic to listen for operations

entry.stomp.username

str

None

Username to use for authentication

garden.name

str

default

The routing name for upstream Beer Gardens to use

garden.status_history

int

50

Amount of historical status heartbeats tracked for Garden and Connections

log.config_file

str

None

Path to a logging config file.

log.fallback_file

str

None

File to log to if config_file is not specified

log.fallback_level

str

INFO

Log level to use if config_file is not specified

metrics.elastic.enabled

bool

False

Enable elastic APM server

metrics.elastic.url

str

None

URL to elastic apm server.

metrics.prometheus.enabled

bool

False

Enable prometheus server

metrics.prometheus.host

str

0.0.0.0

Host to bind the prometheus server to

metrics.prometheus.port

int

2338

Port for prometheus server to listen on.

metrics.prometheus.url

str

None

URL to prometheus/grafana server.

mq.admin_queue_expiry

int

3600000

Time before unused admin queues are removed

mq.blocked_connection_timeout

int

5

Time to wait for a blocked connection to be unblocked

mq.connection_attempts

int

3

Number of retries to connect to MQ

mq.connections.admin.password

str

guest

Password to login to the MQ admin

mq.connections.admin.port

int

15672

Port of the MQ Admin host

mq.connections.admin.ssl.ca_cert

str

None

Path to CA certificate file to use

mq.connections.admin.ssl.ca_verify

bool

True

Verify external certificates

mq.connections.admin.ssl.client_cert

str

None

Path to client combined key / certificate

mq.connections.admin.ssl.enabled

bool

False

Should the connection use SSL

mq.connections.admin.user

str

guest

Username to login to the MQ admin

mq.connections.message.password

str

guest

Password to login to the MQ host

mq.connections.message.port

int

5672

Port of the MQ host

mq.connections.message.ssl.ca_cert

str

None

Path to CA certificate file to use

mq.connections.message.ssl.ca_verify

bool

True

Verify external certificates

mq.connections.message.ssl.client_cert

str

None

Path to client combined key / certificate

mq.connections.message.ssl.enabled

bool

False

Should the connection use SSL

mq.connections.message.user

str

guest

Username to login to the MQ host

mq.exchange

str

beer_garden

Exchange name to use for MQ

mq.heartbeat_interval

int

3600

Heartbeat interval for MQ

mq.host

str

localhost

Will be used by the Beergarden application as the location of the message broker.

mq.virtual_host

str

/

Virtual host to use for MQ

parent.http.access_token

str

None

Access token for authentication

parent.http.api_version

int

1

Beergarden API version

parent.http.client_timeout

float

-1

Max time RestClient will wait for server response

parent.http.enabled

bool

False

Publish events to parent garden over HTTP

parent.http.host

str

None

Host for the HTTP Server to bind to

parent.http.password

str

None

Password for authentication

parent.http.port

int

2337

Serve content on this port

parent.http.refresh_token

str

None

Refresh token for authentication

parent.http.ssl.ca_cert

str

None

Path to CA certificate file to use for SSLContext

parent.http.ssl.ca_verify

bool

True

Verify server certificate when using SSL

parent.http.ssl.client_cert

str

None

Client certificate to use

parent.http.ssl.client_key

str

None

Client key to use

parent.http.ssl.enabled

bool

False

Use SSL when connecting

parent.http.url_prefix

str

/

URL path prefix

parent.http.username

str

None

Username for authentication

parent.skip_events

list

[]

Events to be skipped

parent.stomp.enabled

bool

False

Publish events to parent garden over STOMP

parent.stomp.headers

list

[]

Headers to be sent with messages. Follows standard YAML formatting for lists with two variables 'key' and 'value'

parent.stomp.host

str

localhost

Broker hostname

parent.stomp.password

str

None

Password to use for authentication

parent.stomp.port

int

61613

Broker port

parent.stomp.send_destination

str

None

Topic where events are published

parent.stomp.ssl.ca_cert

str

None

Path to certificate file containing the certificate of the authority that issued the message broker certificate

parent.stomp.ssl.client_cert

str

None

Path to client public certificate to use when communicating with the message broker

parent.stomp.ssl.client_key

str

None

Path to client private key to use when communicating with the message broker

parent.stomp.ssl.use_ssl

bool

False

Use SSL when connecting to message broker

parent.stomp.subscribe_destination

str

None

Topic to listen for operations

parent.stomp.username

str

None

Username to use for authentication

parent.sync_interval

int

15

Number of minutes to wait before sending Garden Sync event to parent

plugin.allow_command_updates

bool

False

Allow commands of non-dev systems to be updated

plugin.local.auth.password

str

password

Password that local plugins will use for authentication (needs bg-plugin role)

plugin.local.auth.username

str

plugin_admin

Username that local plugins will use for authentication (needs bg-plugin role)

plugin.local.directory

str

None

Directory where local plugins are located

plugin.local.host_env_vars

list

[]

Host environment variables that will be propagated to local plugin processes

plugin.local.logging.config_file

str

None

Path to a logging configuration file for local plugins

plugin.local.logging.fallback_level

str

INFO

Level that will be used with a default logging configuration if config_file is not specified

plugin.local.timeout.shutdown

int

10

Seconds to wait for a plugin to stopgracefully

plugin.local.timeout.startup

int

5

Seconds to wait for a plugin to start

plugin.mq.host

str

localhost

Globally resolvable host name of message broker

plugin.remote.logging.config_file

str

None

Path to a logging configuration file for plugins

plugin.remote.logging.fallback_level

str

INFO

Level that will be used with a default logging configuration if config_file is not specified

plugin.status_heartbeat

int

10

Amount of time between status messages

plugin.status_history

int

50

Amount of historical status heartbeats tracked

plugin.status_timeout

int

30

Amount of time to wait before marking a plugin asunresponsive

replication.enabled

bool

False

Publish subset of events to Rabbit to allow all Gardens to stay in sync when replicated

request_validation.dynamic_choices.command.timeout

int

10

Time to wait for a command-based choices validation

request_validation.dynamic_choices.url.ca_cert

str

None

CA file for validating url-based choices

request_validation.dynamic_choices.url.ca_verify

bool

True

Verify external certificates for url-based choices

scheduler.job_defaults.coalesce

bool

True

Should jobs run only once if multiple have missed their window

scheduler.job_defaults.max_instances

int

3

Default maximum instances of a job to run concurrently.

scheduler.max_workers

int

10

Number of workers (processes) to run concurrently.

ui.auto_refresh

bool

False

Auto refresh user interface

ui.cors_enabled

bool

True

Determine if CORS should be enabled

ui.debug_mode

bool

False

Run the application in debug mode

ui.execute_javascript

bool

False

Execute plugin-provided javascript

ui.icon_default

str

fa-beer

Default font-awesome icon to display

ui.name

str

Beer Garden

The title to display on the GUI

auth.authentication_handlers.basic.enabled

Enable authentication via username andpassword

Attribute Value

item_type

bool

default

True

env_name

BG_AUTH_AUTHENTICATION_HANDLERS_BASIC_ENABLED

required

True

cli_name

--auth-authentication_handlers-basic-no-enabled

fallback

None

choices

None

You can set auth.authentication_handlers.basic.enabled from the environment by setting the environment variable BG_AUTH_AUTHENTICATION_HANDLERS_BASIC_ENABLED

You can set auth.authentication_handlers.basic.enabled from the command-line by specifying --auth-authentication_handlers-basic-no-enabled at Beer Garden’s entrypoint.

If auth.authentication_handlers.basic.enabled is not set in any of the sources listed, it will fallback to the default value True

auth.authentication_handlers.trusted_header.create_users

Create an account for the user specified byusername_header if one does not already exist

Attribute Value

item_type

bool

default

True

env_name

BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_CREATE_USERS

required

True

cli_name

--auth-authentication_handlers-trusted_header-no-create-users

fallback

None

choices

None

You can set auth.authentication_handlers.trusted_header.create_users from the environment by setting the environment variable BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_CREATE_USERS

You can set auth.authentication_handlers.trusted_header.create_users from the command-line by specifying --auth-authentication_handlers-trusted_header-no-create-users at Beer Garden’s entrypoint.

If auth.authentication_handlers.trusted_header.create_users is not set in any of the sources listed, it will fallback to the default value True

auth.authentication_handlers.trusted_header.enabled

Enable authentication via trusted headers

Attribute Value

item_type

bool

default

False

env_name

BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_ENABLED

required

True

cli_name

--auth-authentication_handlers-trusted_header-enabled

fallback

None

choices

None

You can set auth.authentication_handlers.trusted_header.enabled from the environment by setting the environment variable BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_ENABLED

You can set auth.authentication_handlers.trusted_header.enabled from the command-line by specifying --auth-authentication_handlers-trusted_header-enabled at Beer Garden’s entrypoint.

auth.authentication_handlers.trusted_header.user_alias_mapping_header

The http header containing the JSON list of the user’s alias user accounts mapping

Attribute Value

item_type

str

default

bg-user-alias-mapping

env_name

BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_USER_ALIAS_MAPPING_HEADER

required

True

cli_name

--auth-authentication_handlers-trusted_header-user-alias-mapping-header

fallback

None

choices

None

You can set auth.authentication_handlers.trusted_header.user_alias_mapping_header from the environment by setting the environment variable BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_USER_ALIAS_MAPPING_HEADER

You can set auth.authentication_handlers.trusted_header.user_alias_mapping_header from the command-line by specifying --auth-authentication_handlers-trusted_header-user-alias-mapping-header at Beer Garden’s entrypoint.

If auth.authentication_handlers.trusted_header.user_alias_mapping_header is not set in any of the sources listed, it will fallback to the default value bg-user-alias-mapping

auth.authentication_handlers.trusted_header.user_local_roles_header

The http header containing the str list of the user’s local role names

Attribute Value

item_type

str

default

bg-user-local-roles

env_name

BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_USER_LOCAL_ROLES_HEADER

required

True

cli_name

--auth-authentication_handlers-trusted_header-user-local-roles-header

fallback

None

choices

None

You can set auth.authentication_handlers.trusted_header.user_local_roles_header from the environment by setting the environment variable BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_USER_LOCAL_ROLES_HEADER

You can set auth.authentication_handlers.trusted_header.user_local_roles_header from the command-line by specifying --auth-authentication_handlers-trusted_header-user-local-roles-header at Beer Garden’s entrypoint.

If auth.authentication_handlers.trusted_header.user_local_roles_header is not set in any of the sources listed, it will fallback to the default value bg-user-local-roles

auth.authentication_handlers.trusted_header.user_upstream_roles_header

The http header containing the JSON list of the user’s roles

Attribute Value

item_type

str

default

bg-user-upstream-roles

env_name

BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_USER_UPSTREAM_ROLES_HEADER

required

True

cli_name

--auth-authentication_handlers-trusted_header-user-upstream-roles-header

fallback

None

choices

None

You can set auth.authentication_handlers.trusted_header.user_upstream_roles_header from the environment by setting the environment variable BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_USER_UPSTREAM_ROLES_HEADER

You can set auth.authentication_handlers.trusted_header.user_upstream_roles_header from the command-line by specifying --auth-authentication_handlers-trusted_header-user-upstream-roles-header at Beer Garden’s entrypoint.

If auth.authentication_handlers.trusted_header.user_upstream_roles_header is not set in any of the sources listed, it will fallback to the default value bg-user-upstream-roles

auth.authentication_handlers.trusted_header.username_header

The http header containing the username

Attribute Value

item_type

str

default

bg-username

env_name

BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_USERNAME_HEADER

required

True

cli_name

--auth-authentication_handlers-trusted_header-username-header

fallback

None

choices

None

You can set auth.authentication_handlers.trusted_header.username_header from the environment by setting the environment variable BG_AUTH_AUTHENTICATION_HANDLERS_TRUSTED_HEADER_USERNAME_HEADER

You can set auth.authentication_handlers.trusted_header.username_header from the command-line by specifying --auth-authentication_handlers-trusted_header-username-header at Beer Garden’s entrypoint.

If auth.authentication_handlers.trusted_header.username_header is not set in any of the sources listed, it will fallback to the default value bg-username

auth.default_admin.password

The password for the default admin account that will be created when initializing a new environment

Attribute Value

item_type

str

default

password

env_name

BG_AUTH_DEFAULT_ADMIN_PASSWORD

required

True

cli_name

--auth-default_admin-password

fallback

None

choices

None

You can set auth.default_admin.password from the environment by setting the environment variable BG_AUTH_DEFAULT_ADMIN_PASSWORD

You can set auth.default_admin.password from the command-line by specifying --auth-default_admin-password at Beer Garden’s entrypoint.

If auth.default_admin.password is not set in any of the sources listed, it will fallback to the default value password

auth.default_admin.username

The username for the default admin account that will be created when initializing a new environment

Attribute Value

item_type

str

default

admin

env_name

BG_AUTH_DEFAULT_ADMIN_USERNAME

required

True

cli_name

--auth-default_admin-username

fallback

None

choices

None

You can set auth.default_admin.username from the environment by setting the environment variable BG_AUTH_DEFAULT_ADMIN_USERNAME

You can set auth.default_admin.username from the command-line by specifying --auth-default_admin-username at Beer Garden’s entrypoint.

If auth.default_admin.username is not set in any of the sources listed, it will fallback to the default value admin

auth.enabled

Use role-based authentication / authorization

Attribute Value

item_type

bool

default

False

env_name

BG_AUTH_ENABLED

required

True

cli_name

--auth-enabled

fallback

None

choices

None

You can set auth.enabled from the environment by setting the environment variable BG_AUTH_ENABLED

You can set auth.enabled from the command-line by specifying --auth-enabled at Beer Garden’s entrypoint.

auth.role_definition_file

Path to the yaml file that defines roles used for authorization

Attribute Value

item_type

str

default

None

env_name

BG_AUTH_ROLE_DEFINITION_FILE

required

False

cli_name

--auth-role-definition-file

fallback

None

choices

None

You can set auth.role_definition_file from the environment by setting the environment variable BG_AUTH_ROLE_DEFINITION_FILE

You can set auth.role_definition_file from the command-line by specifying --auth-role-definition-file at Beer Garden’s entrypoint.

auth.token_access_ttl.garden_admin

The Garden Admin Permission access token expiration time

Attribute Value

item_type

int

default

15

env_name

BG_AUTH_TOKEN_ACCESS_TTL_GARDEN_ADMIN

required

True

cli_name

--auth-token_access_ttl-garden-admin

fallback

None

choices

None

You can set auth.token_access_ttl.garden_admin from the environment by setting the environment variable BG_AUTH_TOKEN_ACCESS_TTL_GARDEN_ADMIN

You can set auth.token_access_ttl.garden_admin from the command-line by specifying --auth-token_access_ttl-garden-admin at Beer Garden’s entrypoint.

If auth.token_access_ttl.garden_admin is not set in any of the sources listed, it will fallback to the default value 15

auth.token_access_ttl.operator

The Operator Permission access token expiration time

Attribute Value

item_type

int

default

15

env_name

BG_AUTH_TOKEN_ACCESS_TTL_OPERATOR

required

True

cli_name

--auth-token_access_ttl-operator

fallback

None

choices

None

You can set auth.token_access_ttl.operator from the environment by setting the environment variable BG_AUTH_TOKEN_ACCESS_TTL_OPERATOR

You can set auth.token_access_ttl.operator from the command-line by specifying --auth-token_access_ttl-operator at Beer Garden’s entrypoint.

If auth.token_access_ttl.operator is not set in any of the sources listed, it will fallback to the default value 15

auth.token_access_ttl.plugin_admin

The Plugin Admin Permission access token expiration time

Attribute Value

item_type

int

default

15

env_name

BG_AUTH_TOKEN_ACCESS_TTL_PLUGIN_ADMIN

required

True

cli_name

--auth-token_access_ttl-plugin-admin

fallback

None

choices

None

You can set auth.token_access_ttl.plugin_admin from the environment by setting the environment variable BG_AUTH_TOKEN_ACCESS_TTL_PLUGIN_ADMIN

You can set auth.token_access_ttl.plugin_admin from the command-line by specifying --auth-token_access_ttl-plugin-admin at Beer Garden’s entrypoint.

If auth.token_access_ttl.plugin_admin is not set in any of the sources listed, it will fallback to the default value 15

auth.token_access_ttl.read_only

The Read Only Permission access token expiration time

Attribute Value

item_type

int

default

15

env_name

BG_AUTH_TOKEN_ACCESS_TTL_READ_ONLY

required

True

cli_name

--auth-token_access_ttl-read-only

fallback

None

choices

None

You can set auth.token_access_ttl.read_only from the environment by setting the environment variable BG_AUTH_TOKEN_ACCESS_TTL_READ_ONLY

You can set auth.token_access_ttl.read_only from the command-line by specifying --auth-token_access_ttl-read-only at Beer Garden’s entrypoint.

If auth.token_access_ttl.read_only is not set in any of the sources listed, it will fallback to the default value 15

auth.token_refresh_ttl.garden_admin

The Garden Admin Permission refresh token expiration time

Attribute Value

item_type

int

default

720

env_name

BG_AUTH_TOKEN_REFRESH_TTL_GARDEN_ADMIN

required

True

cli_name

--auth-token_refresh_ttl-garden-admin

fallback

None

choices

None

You can set auth.token_refresh_ttl.garden_admin from the environment by setting the environment variable BG_AUTH_TOKEN_REFRESH_TTL_GARDEN_ADMIN

You can set auth.token_refresh_ttl.garden_admin from the command-line by specifying --auth-token_refresh_ttl-garden-admin at Beer Garden’s entrypoint.

If auth.token_refresh_ttl.garden_admin is not set in any of the sources listed, it will fallback to the default value 720

auth.token_refresh_ttl.operator

The Operator Permission refresh token expiration time

Attribute Value

item_type

int

default

720

env_name

BG_AUTH_TOKEN_REFRESH_TTL_OPERATOR

required

True

cli_name

--auth-token_refresh_ttl-operator

fallback

None

choices

None

You can set auth.token_refresh_ttl.operator from the environment by setting the environment variable BG_AUTH_TOKEN_REFRESH_TTL_OPERATOR

You can set auth.token_refresh_ttl.operator from the command-line by specifying --auth-token_refresh_ttl-operator at Beer Garden’s entrypoint.

If auth.token_refresh_ttl.operator is not set in any of the sources listed, it will fallback to the default value 720

auth.token_refresh_ttl.plugin_admin

The Plugin Admin Permission refresh token expiration time

Attribute Value

item_type

int

default

720

env_name

BG_AUTH_TOKEN_REFRESH_TTL_PLUGIN_ADMIN

required

True

cli_name

--auth-token_refresh_ttl-plugin-admin

fallback

None

choices

None

You can set auth.token_refresh_ttl.plugin_admin from the environment by setting the environment variable BG_AUTH_TOKEN_REFRESH_TTL_PLUGIN_ADMIN

You can set auth.token_refresh_ttl.plugin_admin from the command-line by specifying --auth-token_refresh_ttl-plugin-admin at Beer Garden’s entrypoint.

If auth.token_refresh_ttl.plugin_admin is not set in any of the sources listed, it will fallback to the default value 720

auth.token_refresh_ttl.read_only

The Read Only Permission refresh token expiration time

Attribute Value

item_type

int

default

720

env_name

BG_AUTH_TOKEN_REFRESH_TTL_READ_ONLY

required

True

cli_name

--auth-token_refresh_ttl-read-only

fallback

None

choices

None

You can set auth.token_refresh_ttl.read_only from the environment by setting the environment variable BG_AUTH_TOKEN_REFRESH_TTL_READ_ONLY

You can set auth.token_refresh_ttl.read_only from the command-line by specifying --auth-token_refresh_ttl-read-only at Beer Garden’s entrypoint.

If auth.token_refresh_ttl.read_only is not set in any of the sources listed, it will fallback to the default value 720

auth.token_secret

Secret to use when signing authentication tokens

Attribute Value

item_type

str

default

``

env_name

BG_AUTH_TOKEN_SECRET

required

False

cli_name

--auth-token-secret

fallback

None

choices

None

You can set auth.token_secret from the environment by setting the environment variable BG_AUTH_TOKEN_SECRET

You can set auth.token_secret from the command-line by specifying --auth-token-secret at Beer Garden’s entrypoint.

auth.user_definition_file

Path to the yaml file that defines users used for authorization

Attribute Value

item_type

str

default

None

env_name

BG_AUTH_USER_DEFINITION_FILE

required

False

cli_name

--auth-user-definition-file

fallback

None

choices

None

You can set auth.user_definition_file from the environment by setting the environment variable BG_AUTH_USER_DEFINITION_FILE

You can set auth.user_definition_file from the command-line by specifying --auth-user-definition-file at Beer Garden’s entrypoint.

children.directory

Directory where child garden configs are located

Attribute Value

item_type

str

default

./children

env_name

BG_CHILDREN_DIRECTORY

required

False

cli_name

--children-directory

fallback

None

choices

None

You can set children.directory from the environment by setting the environment variable BG_CHILDREN_DIRECTORY

You can set children.directory from the command-line by specifying --children-directory at Beer Garden’s entrypoint.

If children.directory is not set in any of the sources listed, it will fallback to the default value ./children

configuration.file

Path to configuration file to use

Attribute Value

item_type

str

default

None

env_name

BG_CONFIGURATION_FILE

required

False

cli_name

--configuration-file/-c

fallback

None

choices

None

You can set configuration.file from the environment by setting the environment variable BG_CONFIGURATION_FILE

You can set configuration.file from the command-line by specifying --configuration-file/-c at Beer Garden’s entrypoint.

db.connection.host

Hostname/IP of the database server

Attribute Value

item_type

str

default

localhost

env_name

BG_DB_CONNECTION_HOST

required

True

cli_name

--db-connection-host

fallback

None

choices

None

You can set db.connection.host from the environment by setting the environment variable BG_DB_CONNECTION_HOST

You can set db.connection.host from the command-line by specifying --db-connection-host at Beer Garden’s entrypoint.

If db.connection.host is not set in any of the sources listed, it will fallback to the default value localhost

db.connection.password

Password to connect to the database

Attribute Value

item_type

str

default

None

env_name

BG_DB_CONNECTION_PASSWORD

required

False

cli_name

--db-connection-password

fallback

None

choices

None

You can set db.connection.password from the environment by setting the environment variable BG_DB_CONNECTION_PASSWORD

You can set db.connection.password from the command-line by specifying --db-connection-password at Beer Garden’s entrypoint.

db.connection.port

Port of the database server

Attribute Value

item_type

int

default

27017

env_name

BG_DB_CONNECTION_PORT

required

True

cli_name

--db-connection-port

fallback

None

choices

None

You can set db.connection.port from the environment by setting the environment variable BG_DB_CONNECTION_PORT

You can set db.connection.port from the command-line by specifying --db-connection-port at Beer Garden’s entrypoint.

If db.connection.port is not set in any of the sources listed, it will fallback to the default value 27017

db.connection.username

Username to connect to the database

Attribute Value

item_type

str

default

None

env_name

BG_DB_CONNECTION_USERNAME

required

False

cli_name

--db-connection-username

fallback

None

choices

None

You can set db.connection.username from the environment by setting the environment variable BG_DB_CONNECTION_USERNAME

You can set db.connection.username from the command-line by specifying --db-connection-username at Beer Garden’s entrypoint.

db.name

Name of the database to use

Attribute Value

item_type

str

default

beer_garden

env_name

BG_DB_NAME

required

True

cli_name

--db-name

fallback

None

choices

None

You can set db.name from the environment by setting the environment variable BG_DB_NAME

You can set db.name from the command-line by specifying --db-name at Beer Garden’s entrypoint.

If db.name is not set in any of the sources listed, it will fallback to the default value beer_garden

db.prune_interval

Number of minutes to wait before running db pruner

Attribute Value

item_type

int

default

15

env_name

BG_DB_PRUNE_INTERVAL

required

True

cli_name

--db-prune-interval

fallback

None

choices

None

You can set db.prune_interval from the environment by setting the environment variable BG_DB_PRUNE_INTERVAL

You can set db.prune_interval from the command-line by specifying --db-prune-interval at Beer Garden’s entrypoint.

If db.prune_interval is not set in any of the sources listed, it will fallback to the default value 15

db.ttl.action

Number of minutes to wait before deleting ACTION requests (negative number for never)

Attribute Value

item_type

int

default

-1

env_name

BG_DB_TTL_ACTION

required

True

cli_name

--db-ttl-action

fallback

None

choices

None

You can set db.ttl.action from the environment by setting the environment variable BG_DB_TTL_ACTION

You can set db.ttl.action from the command-line by specifying --db-ttl-action at Beer Garden’s entrypoint.

If db.ttl.action is not set in any of the sources listed, it will fallback to the default value -1

db.ttl.admin

Number of minutes to wait before deleting Admin requests (negative number for never)

Attribute Value

item_type

int

default

-1

env_name

BG_DB_TTL_ADMIN

required

True

cli_name

--db-ttl-admin

fallback

None

choices

None

You can set db.ttl.admin from the environment by setting the environment variable BG_DB_TTL_ADMIN

You can set db.ttl.admin from the command-line by specifying --db-ttl-admin at Beer Garden’s entrypoint.

If db.ttl.admin is not set in any of the sources listed, it will fallback to the default value -1

db.ttl.batch_size

Batch size for deleting documents (negative number for never)

Attribute Value

item_type

int

default

-1

env_name

BG_DB_TTL_BATCH_SIZE

required

True

cli_name

--db-ttl-batch-size

fallback

None

choices

None

You can set db.ttl.batch_size from the environment by setting the environment variable BG_DB_TTL_BATCH_SIZE

You can set db.ttl.batch_size from the command-line by specifying --db-ttl-batch-size at Beer Garden’s entrypoint.

If db.ttl.batch_size is not set in any of the sources listed, it will fallback to the default value -1

db.ttl.file

Number of minutes to wait before deleting FILE documents (negative number for never)

Attribute Value

item_type

int

default

15

env_name

BG_DB_TTL_FILE

required

True

cli_name

--db-ttl-file

fallback

None

choices

None

You can set db.ttl.file from the environment by setting the environment variable BG_DB_TTL_FILE

You can set db.ttl.file from the command-line by specifying --db-ttl-file at Beer Garden’s entrypoint.

If db.ttl.file is not set in any of the sources listed, it will fallback to the default value 15

db.ttl.in_progress

Number of minutes to wait for a request in CREATED or IN_PROGRESSto complete before considering timed out and marking as CANCELLED(negative number for never)

Attribute Value

item_type

int

default

-1

env_name

BG_DB_TTL_IN_PROGRESS

required

True

cli_name

--db-ttl-in-progress

fallback

None

choices

None

You can set db.ttl.in_progress from the environment by setting the environment variable BG_DB_TTL_IN_PROGRESS

You can set db.ttl.in_progress from the command-line by specifying --db-ttl-in-progress at Beer Garden’s entrypoint.

If db.ttl.in_progress is not set in any of the sources listed, it will fallback to the default value -1

db.ttl.info

Number of minutes to wait before deleting INFO requests (negative number for never)

Attribute Value

item_type

int

default

15

env_name

BG_DB_TTL_INFO

required

True

cli_name

--db-ttl-info

fallback

None

choices

None

You can set db.ttl.info from the environment by setting the environment variable BG_DB_TTL_INFO

You can set db.ttl.info from the command-line by specifying --db-ttl-info at Beer Garden’s entrypoint.

If db.ttl.info is not set in any of the sources listed, it will fallback to the default value 15

db.ttl.temp

Number of minutes to wait before deleting TEMP requests (negative number for never)

Attribute Value

item_type

int

default

15

env_name

BG_DB_TTL_TEMP

required

True

cli_name

--db-ttl-temp

fallback

None

choices

None

You can set db.ttl.temp from the environment by setting the environment variable BG_DB_TTL_TEMP

You can set db.ttl.temp from the command-line by specifying --db-ttl-temp at Beer Garden’s entrypoint.

If db.ttl.temp is not set in any of the sources listed, it will fallback to the default value 15

entry.http.enabled

Run an HTTP server

Attribute Value

item_type

bool

default

True

env_name

BG_ENTRY_HTTP_ENABLED

required

True

cli_name

--entry-http-no-enabled

fallback

None

choices

None

You can set entry.http.enabled from the environment by setting the environment variable BG_ENTRY_HTTP_ENABLED

You can set entry.http.enabled from the command-line by specifying --entry-http-no-enabled at Beer Garden’s entrypoint.

If entry.http.enabled is not set in any of the sources listed, it will fallback to the default value True

entry.http.host

Host for the HTTP Server to bind to

Attribute Value

item_type

str

default

0.0.0.0

env_name

BG_ENTRY_HTTP_HOST

required

True

cli_name

--entry-http-host

fallback

None

choices

None

You can set entry.http.host from the environment by setting the environment variable BG_ENTRY_HTTP_HOST

You can set entry.http.host from the command-line by specifying --entry-http-host at Beer Garden’s entrypoint.

If entry.http.host is not set in any of the sources listed, it will fallback to the default value 0.0.0.0

entry.http.port

Serve content on this port

Attribute Value

item_type

int

default

2337

env_name

BG_ENTRY_HTTP_PORT

required

True

cli_name

--entry-http-port

fallback

None

choices

None

You can set entry.http.port from the environment by setting the environment variable BG_ENTRY_HTTP_PORT

You can set entry.http.port from the command-line by specifying --entry-http-port at Beer Garden’s entrypoint.

If entry.http.port is not set in any of the sources listed, it will fallback to the default value 2337

entry.http.ssl.ca_cert

Path to CA certificate file to use for SSLContext

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_HTTP_SSL_CA_CERT

required

False

cli_name

--entry-http-ssl-ca-cert

fallback

None

choices

None

You can set entry.http.ssl.ca_cert from the environment by setting the environment variable BG_ENTRY_HTTP_SSL_CA_CERT

You can set entry.http.ssl.ca_cert from the command-line by specifying --entry-http-ssl-ca-cert at Beer Garden’s entrypoint.

entry.http.ssl.ca_path

Path to CA certificate path to use for SSLContext

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_HTTP_SSL_CA_PATH

required

False

cli_name

--entry-http-ssl-ca-path

fallback

None

choices

None

You can set entry.http.ssl.ca_path from the environment by setting the environment variable BG_ENTRY_HTTP_SSL_CA_PATH

You can set entry.http.ssl.ca_path from the command-line by specifying --entry-http-ssl-ca-path at Beer Garden’s entrypoint.

entry.http.ssl.client_cert_verify

Client certificate mode to use when handling requests

Attribute Value

item_type

str

default

NONE

env_name

BG_ENTRY_HTTP_SSL_CLIENT_CERT_VERIFY

required

True

cli_name

--entry-http-ssl-client-cert-verify

fallback

None

choices

['NONE', 'OPTIONAL', 'REQUIRED']

You can set entry.http.ssl.client_cert_verify from the environment by setting the environment variable BG_ENTRY_HTTP_SSL_CLIENT_CERT_VERIFY

You can set entry.http.ssl.client_cert_verify from the command-line by specifying --entry-http-ssl-client-cert-verify at Beer Garden’s entrypoint.

If entry.http.ssl.client_cert_verify is not set in any of the sources listed, it will fallback to the default value NONE

entry.http.ssl.enabled

Serve content using SSL

Attribute Value

item_type

bool

default

False

env_name

BG_ENTRY_HTTP_SSL_ENABLED

required

True

cli_name

--entry-http-ssl-enabled

fallback

None

choices

None

You can set entry.http.ssl.enabled from the environment by setting the environment variable BG_ENTRY_HTTP_SSL_ENABLED

You can set entry.http.ssl.enabled from the command-line by specifying --entry-http-ssl-enabled at Beer Garden’s entrypoint.

entry.http.ssl.private_key

Path to a private key

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_HTTP_SSL_PRIVATE_KEY

required

False

cli_name

--entry-http-ssl-private-key

fallback

None

choices

None

You can set entry.http.ssl.private_key from the environment by setting the environment variable BG_ENTRY_HTTP_SSL_PRIVATE_KEY

You can set entry.http.ssl.private_key from the command-line by specifying --entry-http-ssl-private-key at Beer Garden’s entrypoint.

entry.http.ssl.public_key

Path to a public key

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_HTTP_SSL_PUBLIC_KEY

required

False

cli_name

--entry-http-ssl-public-key

fallback

None

choices

None

You can set entry.http.ssl.public_key from the environment by setting the environment variable BG_ENTRY_HTTP_SSL_PUBLIC_KEY

You can set entry.http.ssl.public_key from the command-line by specifying --entry-http-ssl-public-key at Beer Garden’s entrypoint.

entry.http.url_prefix

URL path prefix

Attribute Value

item_type

str

default

/

env_name

BG_ENTRY_HTTP_URL_PREFIX

required

False

cli_name

--entry-http-url-prefix

fallback

None

choices

None

You can set entry.http.url_prefix from the environment by setting the environment variable BG_ENTRY_HTTP_URL_PREFIX

You can set entry.http.url_prefix from the command-line by specifying --entry-http-url-prefix at Beer Garden’s entrypoint.

If entry.http.url_prefix is not set in any of the sources listed, it will fallback to the default value /

entry.stomp.enabled

Connect to a Stomp Broker

Attribute Value

item_type

bool

default

False

env_name

BG_ENTRY_STOMP_ENABLED

required

True

cli_name

--entry-stomp-enabled

fallback

None

choices

None

You can set entry.stomp.enabled from the environment by setting the environment variable BG_ENTRY_STOMP_ENABLED

You can set entry.stomp.enabled from the command-line by specifying --entry-stomp-enabled at Beer Garden’s entrypoint.

entry.stomp.headers

Headers to be sent with messages. Follows standard YAML formatting for lists with two variables 'key' and 'value'

Attribute Value

item_type

list

default

[]

env_name

None

required

False

cli_name

--entry-stomp-headers

fallback

None

choices

None

You can set entry.stomp.headers from the command-line by specifying --entry-stomp-headers at Beer Garden’s entrypoint.

entry.stomp.host

Broker hostname

Attribute Value

item_type

str

default

localhost

env_name

BG_ENTRY_STOMP_HOST

required

True

cli_name

--entry-stomp-host

fallback

None

choices

None

You can set entry.stomp.host from the environment by setting the environment variable BG_ENTRY_STOMP_HOST

You can set entry.stomp.host from the command-line by specifying --entry-stomp-host at Beer Garden’s entrypoint.

If entry.stomp.host is not set in any of the sources listed, it will fallback to the default value localhost

entry.stomp.password

Password to use for authentication

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_STOMP_PASSWORD

required

False

cli_name

--entry-stomp-password

fallback

None

choices

None

You can set entry.stomp.password from the environment by setting the environment variable BG_ENTRY_STOMP_PASSWORD

You can set entry.stomp.password from the command-line by specifying --entry-stomp-password at Beer Garden’s entrypoint.

entry.stomp.port

Broker port

Attribute Value

item_type

int

default

61613

env_name

BG_ENTRY_STOMP_PORT

required

True

cli_name

--entry-stomp-port

fallback

None

choices

None

You can set entry.stomp.port from the environment by setting the environment variable BG_ENTRY_STOMP_PORT

You can set entry.stomp.port from the command-line by specifying --entry-stomp-port at Beer Garden’s entrypoint.

If entry.stomp.port is not set in any of the sources listed, it will fallback to the default value 61613

entry.stomp.send_destination

Topic where events are published

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_STOMP_SEND_DESTINATION

required

False

cli_name

--entry-stomp-send-destination

fallback

None

choices

None

You can set entry.stomp.send_destination from the environment by setting the environment variable BG_ENTRY_STOMP_SEND_DESTINATION

You can set entry.stomp.send_destination from the command-line by specifying --entry-stomp-send-destination at Beer Garden’s entrypoint.

entry.stomp.ssl.ca_cert

Path to certificate file containing the certificate of the authority that issued the message broker certificate

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_STOMP_SSL_CA_CERT

required

False

cli_name

--entry-stomp-ssl-ca-cert

fallback

None

choices

None

You can set entry.stomp.ssl.ca_cert from the environment by setting the environment variable BG_ENTRY_STOMP_SSL_CA_CERT

You can set entry.stomp.ssl.ca_cert from the command-line by specifying --entry-stomp-ssl-ca-cert at Beer Garden’s entrypoint.

entry.stomp.ssl.client_cert

Path to client public certificate to use when communicating with the message broker

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_STOMP_SSL_CLIENT_CERT

required

False

cli_name

--entry-stomp-ssl-client-cert

fallback

None

choices

None

You can set entry.stomp.ssl.client_cert from the environment by setting the environment variable BG_ENTRY_STOMP_SSL_CLIENT_CERT

You can set entry.stomp.ssl.client_cert from the command-line by specifying --entry-stomp-ssl-client-cert at Beer Garden’s entrypoint.

entry.stomp.ssl.client_key

Path to client private key to use when communicating with the message broker

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_STOMP_SSL_CLIENT_KEY

required

False

cli_name

--entry-stomp-ssl-client-key

fallback

None

choices

None

You can set entry.stomp.ssl.client_key from the environment by setting the environment variable BG_ENTRY_STOMP_SSL_CLIENT_KEY

You can set entry.stomp.ssl.client_key from the command-line by specifying --entry-stomp-ssl-client-key at Beer Garden’s entrypoint.

entry.stomp.ssl.use_ssl

Use SSL when connecting to the message broker

Attribute Value

item_type

bool

default

False

env_name

BG_ENTRY_STOMP_SSL_USE_SSL

required

True

cli_name

--entry-stomp-ssl-use-ssl

fallback

None

choices

None

You can set entry.stomp.ssl.use_ssl from the environment by setting the environment variable BG_ENTRY_STOMP_SSL_USE_SSL

You can set entry.stomp.ssl.use_ssl from the command-line by specifying --entry-stomp-ssl-use-ssl at Beer Garden’s entrypoint.

entry.stomp.subscribe_destination

Topic to listen for operations

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_STOMP_SUBSCRIBE_DESTINATION

required

False

cli_name

--entry-stomp-subscribe-destination

fallback

None

choices

None

You can set entry.stomp.subscribe_destination from the environment by setting the environment variable BG_ENTRY_STOMP_SUBSCRIBE_DESTINATION

You can set entry.stomp.subscribe_destination from the command-line by specifying --entry-stomp-subscribe-destination at Beer Garden’s entrypoint.

entry.stomp.username

Username to use for authentication

Attribute Value

item_type

str

default

None

env_name

BG_ENTRY_STOMP_USERNAME

required

False

cli_name

--entry-stomp-username

fallback

None

choices

None

You can set entry.stomp.username from the environment by setting the environment variable BG_ENTRY_STOMP_USERNAME

You can set entry.stomp.username from the command-line by specifying --entry-stomp-username at Beer Garden’s entrypoint.

garden.name

The routing name for upstream Beer Gardens to use

Attribute Value

item_type

str

default

default

env_name

BG_GARDEN_NAME

required

True

cli_name

--garden-name

fallback

None

choices

None

You can set garden.name from the environment by setting the environment variable BG_GARDEN_NAME

You can set garden.name from the command-line by specifying --garden-name at Beer Garden’s entrypoint.

If garden.name is not set in any of the sources listed, it will fallback to the default value default

garden.status_history

Amount of historical status heartbeats tracked for Garden and Connections

Attribute Value

item_type

int

default

50

env_name

BG_GARDEN_STATUS_HISTORY

required

True

cli_name

--garden-status-history

fallback

None

choices

None

You can set garden.status_history from the environment by setting the environment variable BG_GARDEN_STATUS_HISTORY

You can set garden.status_history from the command-line by specifying --garden-status-history at Beer Garden’s entrypoint.

If garden.status_history is not set in any of the sources listed, it will fallback to the default value 50

log.config_file

Path to a logging config file.

Attribute Value

item_type

str

default

None

env_name

BG_LOG_CONFIG_FILE

required

False

cli_name

--log-config-file/-l

fallback

None

choices

None

You can set log.config_file from the environment by setting the environment variable BG_LOG_CONFIG_FILE

You can set log.config_file from the command-line by specifying --log-config-file/-l at Beer Garden’s entrypoint.

log.fallback_file

File to log to if config_file is not specified

Attribute Value

item_type

str

default

None

env_name

BG_LOG_FALLBACK_FILE

required

False

cli_name

--log-fallback-file

fallback

None

choices

None

You can set log.fallback_file from the environment by setting the environment variable BG_LOG_FALLBACK_FILE

You can set log.fallback_file from the command-line by specifying --log-fallback-file at Beer Garden’s entrypoint.

log.fallback_level

Log level to use if config_file is not specified

Attribute Value

item_type

str

default

INFO

env_name

BG_LOG_FALLBACK_LEVEL

required

True

cli_name

--log-fallback-level

fallback

None

choices

['DEBUG', 'INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL']

You can set log.fallback_level from the environment by setting the environment variable BG_LOG_FALLBACK_LEVEL

You can set log.fallback_level from the command-line by specifying --log-fallback-level at Beer Garden’s entrypoint.

If log.fallback_level is not set in any of the sources listed, it will fallback to the default value INFO

metrics.elastic.enabled

Enable elastic APM server

Attribute Value

item_type

bool

default

False

env_name

BG_METRICS_ELASTIC_ENABLED

required

True

cli_name

--metrics-elastic-enabled

fallback

None

choices

None

You can set metrics.elastic.enabled from the environment by setting the environment variable BG_METRICS_ELASTIC_ENABLED

You can set metrics.elastic.enabled from the command-line by specifying --metrics-elastic-enabled at Beer Garden’s entrypoint.

metrics.elastic.url

URL to elastic apm server.

Attribute Value

item_type

str

default

None

env_name

BG_METRICS_ELASTIC_URL

required

False

cli_name

--metrics-elastic-url

fallback

None

choices

None

You can set metrics.elastic.url from the environment by setting the environment variable BG_METRICS_ELASTIC_URL

You can set metrics.elastic.url from the command-line by specifying --metrics-elastic-url at Beer Garden’s entrypoint.

metrics.prometheus.enabled

Enable prometheus server

Attribute Value

item_type

bool

default

False

env_name

BG_METRICS_PROMETHEUS_ENABLED

required

True

cli_name

--metrics-prometheus-enabled

fallback

None

choices

None

You can set metrics.prometheus.enabled from the environment by setting the environment variable BG_METRICS_PROMETHEUS_ENABLED

You can set metrics.prometheus.enabled from the command-line by specifying --metrics-prometheus-enabled at Beer Garden’s entrypoint.

metrics.prometheus.host

Host to bind the prometheus server to

Attribute Value

item_type

str

default

0.0.0.0

env_name

BG_METRICS_PROMETHEUS_HOST

required

True

cli_name

--metrics-prometheus-host

fallback

None

choices

None

You can set metrics.prometheus.host from the environment by setting the environment variable BG_METRICS_PROMETHEUS_HOST

You can set metrics.prometheus.host from the command-line by specifying --metrics-prometheus-host at Beer Garden’s entrypoint.

If metrics.prometheus.host is not set in any of the sources listed, it will fallback to the default value 0.0.0.0

metrics.prometheus.port

Port for prometheus server to listen on.

Attribute Value

item_type

int

default

2338

env_name

BG_METRICS_PROMETHEUS_PORT

required

True

cli_name

--metrics-prometheus-port

fallback

None

choices

None

You can set metrics.prometheus.port from the environment by setting the environment variable BG_METRICS_PROMETHEUS_PORT

You can set metrics.prometheus.port from the command-line by specifying --metrics-prometheus-port at Beer Garden’s entrypoint.

If metrics.prometheus.port is not set in any of the sources listed, it will fallback to the default value 2338

metrics.prometheus.url

URL to prometheus/grafana server.

Attribute Value

item_type

str

default

None

env_name

BG_METRICS_PROMETHEUS_URL

required

False

cli_name

--metrics-prometheus-url

fallback

None

choices

None

You can set metrics.prometheus.url from the environment by setting the environment variable BG_METRICS_PROMETHEUS_URL

You can set metrics.prometheus.url from the command-line by specifying --metrics-prometheus-url at Beer Garden’s entrypoint.

mq.admin_queue_expiry

Time before unused admin queues are removed

Attribute Value

item_type

int

default

3600000

env_name

BG_MQ_ADMIN_QUEUE_EXPIRY

required

True

cli_name

--mq-admin-queue-expiry

fallback

None

choices

None

You can set mq.admin_queue_expiry from the environment by setting the environment variable BG_MQ_ADMIN_QUEUE_EXPIRY

You can set mq.admin_queue_expiry from the command-line by specifying --mq-admin-queue-expiry at Beer Garden’s entrypoint.

If mq.admin_queue_expiry is not set in any of the sources listed, it will fallback to the default value 3600000

mq.blocked_connection_timeout

Time to wait for a blocked connection to be unblocked

Attribute Value

item_type

int

default

5

env_name

BG_MQ_BLOCKED_CONNECTION_TIMEOUT

required

True

cli_name

--mq-blocked-connection-timeout

fallback

None

choices

None

You can set mq.blocked_connection_timeout from the environment by setting the environment variable BG_MQ_BLOCKED_CONNECTION_TIMEOUT

You can set mq.blocked_connection_timeout from the command-line by specifying --mq-blocked-connection-timeout at Beer Garden’s entrypoint.

If mq.blocked_connection_timeout is not set in any of the sources listed, it will fallback to the default value 5

mq.connection_attempts

Number of retries to connect to MQ

Attribute Value

item_type

int

default

3

env_name

BG_MQ_CONNECTION_ATTEMPTS

required

True

cli_name

--mq-connection-attempts

fallback

None

choices

None

You can set mq.connection_attempts from the environment by setting the environment variable BG_MQ_CONNECTION_ATTEMPTS

You can set mq.connection_attempts from the command-line by specifying --mq-connection-attempts at Beer Garden’s entrypoint.

If mq.connection_attempts is not set in any of the sources listed, it will fallback to the default value 3

mq.connections.admin.password

Password to login to the MQ admin

Attribute Value

item_type

str

default

guest

env_name

BG_MQ_CONNECTIONS_ADMIN_PASSWORD

required

True

cli_name

--mq-connections-admin-password

fallback

None

choices

None

You can set mq.connections.admin.password from the environment by setting the environment variable BG_MQ_CONNECTIONS_ADMIN_PASSWORD

You can set mq.connections.admin.password from the command-line by specifying --mq-connections-admin-password at Beer Garden’s entrypoint.

If mq.connections.admin.password is not set in any of the sources listed, it will fallback to the default value guest

mq.connections.admin.port

Port of the MQ Admin host

Attribute Value

item_type

int

default

15672

env_name

BG_MQ_CONNECTIONS_ADMIN_PORT

required

True

cli_name

--mq-connections-admin-port

fallback

None

choices

None

You can set mq.connections.admin.port from the environment by setting the environment variable BG_MQ_CONNECTIONS_ADMIN_PORT

You can set mq.connections.admin.port from the command-line by specifying --mq-connections-admin-port at Beer Garden’s entrypoint.

If mq.connections.admin.port is not set in any of the sources listed, it will fallback to the default value 15672

mq.connections.admin.ssl.ca_cert

Path to CA certificate file to use

Attribute Value

item_type

str

default

None

env_name

BG_MQ_CONNECTIONS_ADMIN_SSL_CA_CERT

required

False

cli_name

--mq-connections-admin-ssl-ca-cert

fallback

None

choices

None

You can set mq.connections.admin.ssl.ca_cert from the environment by setting the environment variable BG_MQ_CONNECTIONS_ADMIN_SSL_CA_CERT

You can set mq.connections.admin.ssl.ca_cert from the command-line by specifying --mq-connections-admin-ssl-ca-cert at Beer Garden’s entrypoint.

mq.connections.admin.ssl.ca_verify

Verify external certificates

Attribute Value

item_type

bool

default

True

env_name

BG_MQ_CONNECTIONS_ADMIN_SSL_CA_VERIFY

required

False

cli_name

--mq-connections-admin-ssl-no-ca-verify

fallback

None

choices

None

You can set mq.connections.admin.ssl.ca_verify from the environment by setting the environment variable BG_MQ_CONNECTIONS_ADMIN_SSL_CA_VERIFY

You can set mq.connections.admin.ssl.ca_verify from the command-line by specifying --mq-connections-admin-ssl-no-ca-verify at Beer Garden’s entrypoint.

If mq.connections.admin.ssl.ca_verify is not set in any of the sources listed, it will fallback to the default value True

mq.connections.admin.ssl.client_cert

Path to client combined key / certificate

Attribute Value

item_type

str

default

None

env_name

BG_MQ_CONNECTIONS_ADMIN_SSL_CLIENT_CERT

required

False

cli_name

--mq-connections-admin-ssl-client-cert

fallback

None

choices

None

You can set mq.connections.admin.ssl.client_cert from the environment by setting the environment variable BG_MQ_CONNECTIONS_ADMIN_SSL_CLIENT_CERT

You can set mq.connections.admin.ssl.client_cert from the command-line by specifying --mq-connections-admin-ssl-client-cert at Beer Garden’s entrypoint.

mq.connections.admin.ssl.enabled

Should the connection use SSL

Attribute Value

item_type

bool

default

False

env_name

BG_MQ_CONNECTIONS_ADMIN_SSL_ENABLED

required

True

cli_name

--mq-connections-admin-ssl-enabled

fallback

None

choices

None

You can set mq.connections.admin.ssl.enabled from the environment by setting the environment variable BG_MQ_CONNECTIONS_ADMIN_SSL_ENABLED

You can set mq.connections.admin.ssl.enabled from the command-line by specifying --mq-connections-admin-ssl-enabled at Beer Garden’s entrypoint.

mq.connections.admin.user

Username to login to the MQ admin

Attribute Value

item_type

str

default

guest

env_name

BG_MQ_CONNECTIONS_ADMIN_USER

required

True

cli_name

--mq-connections-admin-user

fallback

None

choices

None

You can set mq.connections.admin.user from the environment by setting the environment variable BG_MQ_CONNECTIONS_ADMIN_USER

You can set mq.connections.admin.user from the command-line by specifying --mq-connections-admin-user at Beer Garden’s entrypoint.

If mq.connections.admin.user is not set in any of the sources listed, it will fallback to the default value guest

mq.connections.message.password

Password to login to the MQ host

Attribute Value

item_type

str

default

guest

env_name

BG_MQ_CONNECTIONS_MESSAGE_PASSWORD

required

True

cli_name

--mq-connections-message-password

fallback

None

choices

None

You can set mq.connections.message.password from the environment by setting the environment variable BG_MQ_CONNECTIONS_MESSAGE_PASSWORD

You can set mq.connections.message.password from the command-line by specifying --mq-connections-message-password at Beer Garden’s entrypoint.

If mq.connections.message.password is not set in any of the sources listed, it will fallback to the default value guest

mq.connections.message.port

Port of the MQ host

Attribute Value

item_type

int

default

5672

env_name

BG_MQ_CONNECTIONS_MESSAGE_PORT

required

True

cli_name

--mq-connections-message-port

fallback

None

choices

None

You can set mq.connections.message.port from the environment by setting the environment variable BG_MQ_CONNECTIONS_MESSAGE_PORT

You can set mq.connections.message.port from the command-line by specifying --mq-connections-message-port at Beer Garden’s entrypoint.

If mq.connections.message.port is not set in any of the sources listed, it will fallback to the default value 5672

mq.connections.message.ssl.ca_cert

Path to CA certificate file to use

Attribute Value

item_type

str

default

None

env_name

BG_MQ_CONNECTIONS_MESSAGE_SSL_CA_CERT

required

False

cli_name

--mq-connections-message-ssl-ca-cert

fallback

None

choices

None

You can set mq.connections.message.ssl.ca_cert from the environment by setting the environment variable BG_MQ_CONNECTIONS_MESSAGE_SSL_CA_CERT

You can set mq.connections.message.ssl.ca_cert from the command-line by specifying --mq-connections-message-ssl-ca-cert at Beer Garden’s entrypoint.

mq.connections.message.ssl.ca_verify

Verify external certificates

Attribute Value

item_type

bool

default

True

env_name

BG_MQ_CONNECTIONS_MESSAGE_SSL_CA_VERIFY

required

False

cli_name

--mq-connections-message-ssl-no-ca-verify

fallback

None

choices

None

You can set mq.connections.message.ssl.ca_verify from the environment by setting the environment variable BG_MQ_CONNECTIONS_MESSAGE_SSL_CA_VERIFY

You can set mq.connections.message.ssl.ca_verify from the command-line by specifying --mq-connections-message-ssl-no-ca-verify at Beer Garden’s entrypoint.

If mq.connections.message.ssl.ca_verify is not set in any of the sources listed, it will fallback to the default value True

mq.connections.message.ssl.client_cert

Path to client combined key / certificate

Attribute Value

item_type

str

default

None

env_name

BG_MQ_CONNECTIONS_MESSAGE_SSL_CLIENT_CERT

required

False

cli_name

--mq-connections-message-ssl-client-cert

fallback

None

choices

None

You can set mq.connections.message.ssl.client_cert from the environment by setting the environment variable BG_MQ_CONNECTIONS_MESSAGE_SSL_CLIENT_CERT

You can set mq.connections.message.ssl.client_cert from the command-line by specifying --mq-connections-message-ssl-client-cert at Beer Garden’s entrypoint.

mq.connections.message.ssl.enabled

Should the connection use SSL

Attribute Value

item_type

bool

default

False

env_name

BG_MQ_CONNECTIONS_MESSAGE_SSL_ENABLED

required

True

cli_name

--mq-connections-message-ssl-enabled

fallback

None

choices

None

You can set mq.connections.message.ssl.enabled from the environment by setting the environment variable BG_MQ_CONNECTIONS_MESSAGE_SSL_ENABLED

You can set mq.connections.message.ssl.enabled from the command-line by specifying --mq-connections-message-ssl-enabled at Beer Garden’s entrypoint.

mq.connections.message.user

Username to login to the MQ host

Attribute Value

item_type

str

default

guest

env_name

BG_MQ_CONNECTIONS_MESSAGE_USER

required

True

cli_name

--mq-connections-message-user

fallback

None

choices

None

You can set mq.connections.message.user from the environment by setting the environment variable BG_MQ_CONNECTIONS_MESSAGE_USER

You can set mq.connections.message.user from the command-line by specifying --mq-connections-message-user at Beer Garden’s entrypoint.

If mq.connections.message.user is not set in any of the sources listed, it will fallback to the default value guest

mq.exchange

Exchange name to use for MQ

Attribute Value

item_type

str

default

beer_garden

env_name

BG_MQ_EXCHANGE

required

True

cli_name

--mq-exchange

fallback

None

choices

None

You can set mq.exchange from the environment by setting the environment variable BG_MQ_EXCHANGE

You can set mq.exchange from the command-line by specifying --mq-exchange at Beer Garden’s entrypoint.

If mq.exchange is not set in any of the sources listed, it will fallback to the default value beer_garden

mq.heartbeat_interval

Heartbeat interval for MQ

Attribute Value

item_type

int

default

3600

env_name

BG_MQ_HEARTBEAT_INTERVAL

required

True

cli_name

--mq-heartbeat-interval

fallback

None

choices

None

You can set mq.heartbeat_interval from the environment by setting the environment variable BG_MQ_HEARTBEAT_INTERVAL

You can set mq.heartbeat_interval from the command-line by specifying --mq-heartbeat-interval at Beer Garden’s entrypoint.

If mq.heartbeat_interval is not set in any of the sources listed, it will fallback to the default value 3600

mq.host

Will be used by the Beergarden application as the location of the message broker.

Attribute Value

item_type

str

default

localhost

env_name

BG_MQ_HOST

required

True

cli_name

--mq-host

fallback

None

choices

None

You can set mq.host from the environment by setting the environment variable BG_MQ_HOST

You can set mq.host from the command-line by specifying --mq-host at Beer Garden’s entrypoint.

If mq.host is not set in any of the sources listed, it will fallback to the default value localhost

mq.virtual_host

Virtual host to use for MQ

Attribute Value

item_type

str

default

/

env_name

BG_MQ_VIRTUAL_HOST

required

True

cli_name

--mq-virtual-host

fallback

None

choices

None

You can set mq.virtual_host from the environment by setting the environment variable BG_MQ_VIRTUAL_HOST

You can set mq.virtual_host from the command-line by specifying --mq-virtual-host at Beer Garden’s entrypoint.

If mq.virtual_host is not set in any of the sources listed, it will fallback to the default value /

parent.http.access_token

Access token for authentication

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_HTTP_ACCESS_TOKEN

required

False

cli_name

--parent-http-access-token

fallback

None

choices

None

You can set parent.http.access_token from the environment by setting the environment variable BG_PARENT_HTTP_ACCESS_TOKEN

You can set parent.http.access_token from the command-line by specifying --parent-http-access-token at Beer Garden’s entrypoint.

parent.http.api_version

Beergarden API version

Attribute Value

item_type

int

default

1

env_name

BG_PARENT_HTTP_API_VERSION

required

True

cli_name

--parent-http-api-version

fallback

None

choices

[1]

You can set parent.http.api_version from the environment by setting the environment variable BG_PARENT_HTTP_API_VERSION

You can set parent.http.api_version from the command-line by specifying --parent-http-api-version at Beer Garden’s entrypoint.

If parent.http.api_version is not set in any of the sources listed, it will fallback to the default value 1

parent.http.client_timeout

Max time RestClient will wait for server response

Attribute Value

item_type

float

default

-1

env_name

BG_PARENT_HTTP_CLIENT_TIMEOUT

required

True

cli_name

--parent-http-client-timeout

fallback

None

choices

None

You can set parent.http.client_timeout from the environment by setting the environment variable BG_PARENT_HTTP_CLIENT_TIMEOUT

You can set parent.http.client_timeout from the command-line by specifying --parent-http-client-timeout at Beer Garden’s entrypoint.

If parent.http.client_timeout is not set in any of the sources listed, it will fallback to the default value -1

This setting controls how long the HTTP(s) client will wait when opening a connection to Beergarden before aborting. This prevents some strange Beergarden server state from causing plugins to hang indefinitely. Set to -1 to disable (this is a bad idea in production code, see the Requests documentation).

parent.http.enabled

Publish events to parent garden over HTTP

Attribute Value

item_type

bool

default

False

env_name

BG_PARENT_HTTP_ENABLED

required

True

cli_name

--parent-http-enabled

fallback

None

choices

None

You can set parent.http.enabled from the environment by setting the environment variable BG_PARENT_HTTP_ENABLED

You can set parent.http.enabled from the command-line by specifying --parent-http-enabled at Beer Garden’s entrypoint.

parent.http.host

Host for the HTTP Server to bind to

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_HTTP_HOST

required

False

cli_name

--parent-http-host

fallback

None

choices

None

You can set parent.http.host from the environment by setting the environment variable BG_PARENT_HTTP_HOST

You can set parent.http.host from the command-line by specifying --parent-http-host at Beer Garden’s entrypoint.

parent.http.password

Password for authentication

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_HTTP_PASSWORD

required

False

cli_name

--parent-http-password

fallback

None

choices

None

You can set parent.http.password from the environment by setting the environment variable BG_PARENT_HTTP_PASSWORD

You can set parent.http.password from the command-line by specifying --parent-http-password at Beer Garden’s entrypoint.

parent.http.port

Serve content on this port

Attribute Value

item_type

int

default

2337

env_name

BG_PARENT_HTTP_PORT

required

True

cli_name

--parent-http-port

fallback

None

choices

None

You can set parent.http.port from the environment by setting the environment variable BG_PARENT_HTTP_PORT

You can set parent.http.port from the command-line by specifying --parent-http-port at Beer Garden’s entrypoint.

If parent.http.port is not set in any of the sources listed, it will fallback to the default value 2337

parent.http.refresh_token

Refresh token for authentication

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_HTTP_REFRESH_TOKEN

required

False

cli_name

--parent-http-refresh-token

fallback

None

choices

None

You can set parent.http.refresh_token from the environment by setting the environment variable BG_PARENT_HTTP_REFRESH_TOKEN

You can set parent.http.refresh_token from the command-line by specifying --parent-http-refresh-token at Beer Garden’s entrypoint.

parent.http.ssl.ca_cert

Path to CA certificate file to use for SSLContext

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_HTTP_SSL_CA_CERT

required

False

cli_name

--parent-http-ssl-ca-cert

fallback

None

choices

None

You can set parent.http.ssl.ca_cert from the environment by setting the environment variable BG_PARENT_HTTP_SSL_CA_CERT

You can set parent.http.ssl.ca_cert from the command-line by specifying --parent-http-ssl-ca-cert at Beer Garden’s entrypoint.

parent.http.ssl.ca_verify

Verify server certificate when using SSL

Attribute Value

item_type

bool

default

True

env_name

BG_PARENT_HTTP_SSL_CA_VERIFY

required

True

cli_name

--parent-http-ssl-no-ca-verify

fallback

None

choices

None

You can set parent.http.ssl.ca_verify from the environment by setting the environment variable BG_PARENT_HTTP_SSL_CA_VERIFY

You can set parent.http.ssl.ca_verify from the command-line by specifying --parent-http-ssl-no-ca-verify at Beer Garden’s entrypoint.

If parent.http.ssl.ca_verify is not set in any of the sources listed, it will fallback to the default value True

parent.http.ssl.client_cert

Client certificate to use

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_HTTP_SSL_CLIENT_CERT

required

False

cli_name

--parent-http-ssl-client-cert

fallback

None

choices

None

You can set parent.http.ssl.client_cert from the environment by setting the environment variable BG_PARENT_HTTP_SSL_CLIENT_CERT

You can set parent.http.ssl.client_cert from the command-line by specifying --parent-http-ssl-client-cert at Beer Garden’s entrypoint.

parent.http.ssl.client_key

Client key to use

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_HTTP_SSL_CLIENT_KEY

required

False

cli_name

--parent-http-ssl-client-key

fallback

None

choices

None

You can set parent.http.ssl.client_key from the environment by setting the environment variable BG_PARENT_HTTP_SSL_CLIENT_KEY

You can set parent.http.ssl.client_key from the command-line by specifying --parent-http-ssl-client-key at Beer Garden’s entrypoint.

parent.http.ssl.enabled

Use SSL when connecting

Attribute Value

item_type

bool

default

False

env_name

BG_PARENT_HTTP_SSL_ENABLED

required

True

cli_name

--parent-http-ssl-enabled

fallback

None

choices

None

You can set parent.http.ssl.enabled from the environment by setting the environment variable BG_PARENT_HTTP_SSL_ENABLED

You can set parent.http.ssl.enabled from the command-line by specifying --parent-http-ssl-enabled at Beer Garden’s entrypoint.

parent.http.url_prefix

URL path prefix

Attribute Value

item_type

str

default

/

env_name

BG_PARENT_HTTP_URL_PREFIX

required

False

cli_name

--parent-http-url-prefix

fallback

None

choices

None

You can set parent.http.url_prefix from the environment by setting the environment variable BG_PARENT_HTTP_URL_PREFIX

You can set parent.http.url_prefix from the command-line by specifying --parent-http-url-prefix at Beer Garden’s entrypoint.

If parent.http.url_prefix is not set in any of the sources listed, it will fallback to the default value /

parent.http.username

Username for authentication

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_HTTP_USERNAME

required

False

cli_name

--parent-http-username

fallback

None

choices

None

You can set parent.http.username from the environment by setting the environment variable BG_PARENT_HTTP_USERNAME

You can set parent.http.username from the command-line by specifying --parent-http-username at Beer Garden’s entrypoint.

parent.skip_events

Events to be skipped

Attribute Value

item_type

list

default

[]

env_name

None

required

False

cli_name

--parent-skip-events

fallback

None

choices

None

You can set parent.skip_events from the command-line by specifying --parent-skip-events at Beer Garden’s entrypoint.

parent.stomp.enabled

Publish events to parent garden over STOMP

Attribute Value

item_type

bool

default

False

env_name

BG_PARENT_STOMP_ENABLED

required

True

cli_name

--parent-stomp-enabled

fallback

None

choices

None

You can set parent.stomp.enabled from the environment by setting the environment variable BG_PARENT_STOMP_ENABLED

You can set parent.stomp.enabled from the command-line by specifying --parent-stomp-enabled at Beer Garden’s entrypoint.

parent.stomp.headers

Headers to be sent with messages. Follows standard YAML formatting for lists with two variables 'key' and 'value'

Attribute Value

item_type

list

default

[]

env_name

None

required

False

cli_name

--parent-stomp-headers

fallback

None

choices

None

You can set parent.stomp.headers from the command-line by specifying --parent-stomp-headers at Beer Garden’s entrypoint.

parent.stomp.host

Broker hostname

Attribute Value

item_type

str

default

localhost

env_name

BG_PARENT_STOMP_HOST

required

True

cli_name

--parent-stomp-host

fallback

None

choices

None

You can set parent.stomp.host from the environment by setting the environment variable BG_PARENT_STOMP_HOST

You can set parent.stomp.host from the command-line by specifying --parent-stomp-host at Beer Garden’s entrypoint.

If parent.stomp.host is not set in any of the sources listed, it will fallback to the default value localhost

parent.stomp.password

Password to use for authentication

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_STOMP_PASSWORD

required

False

cli_name

--parent-stomp-password

fallback

None

choices

None

You can set parent.stomp.password from the environment by setting the environment variable BG_PARENT_STOMP_PASSWORD

You can set parent.stomp.password from the command-line by specifying --parent-stomp-password at Beer Garden’s entrypoint.

parent.stomp.port

Broker port

Attribute Value

item_type

int

default

61613

env_name

BG_PARENT_STOMP_PORT

required

True

cli_name

--parent-stomp-port

fallback

None

choices

None

You can set parent.stomp.port from the environment by setting the environment variable BG_PARENT_STOMP_PORT

You can set parent.stomp.port from the command-line by specifying --parent-stomp-port at Beer Garden’s entrypoint.

If parent.stomp.port is not set in any of the sources listed, it will fallback to the default value 61613

parent.stomp.send_destination

Topic where events are published

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_STOMP_SEND_DESTINATION

required

False

cli_name

--parent-stomp-send-destination

fallback

None

choices

None

You can set parent.stomp.send_destination from the environment by setting the environment variable BG_PARENT_STOMP_SEND_DESTINATION

You can set parent.stomp.send_destination from the command-line by specifying --parent-stomp-send-destination at Beer Garden’s entrypoint.

parent.stomp.ssl.ca_cert

Path to certificate file containing the certificate of the authority that issued the message broker certificate

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_STOMP_SSL_CA_CERT

required

False

cli_name

--parent-stomp-ssl-ca-cert

fallback

None

choices

None

You can set parent.stomp.ssl.ca_cert from the environment by setting the environment variable BG_PARENT_STOMP_SSL_CA_CERT

You can set parent.stomp.ssl.ca_cert from the command-line by specifying --parent-stomp-ssl-ca-cert at Beer Garden’s entrypoint.

parent.stomp.ssl.client_cert

Path to client public certificate to use when communicating with the message broker

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_STOMP_SSL_CLIENT_CERT

required

False

cli_name

--parent-stomp-ssl-client-cert

fallback

None

choices

None

You can set parent.stomp.ssl.client_cert from the environment by setting the environment variable BG_PARENT_STOMP_SSL_CLIENT_CERT

You can set parent.stomp.ssl.client_cert from the command-line by specifying --parent-stomp-ssl-client-cert at Beer Garden’s entrypoint.

parent.stomp.ssl.client_key

Path to client private key to use when communicating with the message broker

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_STOMP_SSL_CLIENT_KEY

required

False

cli_name

--parent-stomp-ssl-client-key

fallback

None

choices

None

You can set parent.stomp.ssl.client_key from the environment by setting the environment variable BG_PARENT_STOMP_SSL_CLIENT_KEY

You can set parent.stomp.ssl.client_key from the command-line by specifying --parent-stomp-ssl-client-key at Beer Garden’s entrypoint.

parent.stomp.ssl.use_ssl

Use SSL when connecting to message broker

Attribute Value

item_type

bool

default

False

env_name

BG_PARENT_STOMP_SSL_USE_SSL

required

True

cli_name

--parent-stomp-ssl-use-ssl

fallback

None

choices

None

You can set parent.stomp.ssl.use_ssl from the environment by setting the environment variable BG_PARENT_STOMP_SSL_USE_SSL

You can set parent.stomp.ssl.use_ssl from the command-line by specifying --parent-stomp-ssl-use-ssl at Beer Garden’s entrypoint.

parent.stomp.subscribe_destination

Topic to listen for operations

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_STOMP_SUBSCRIBE_DESTINATION

required

False

cli_name

--parent-stomp-subscribe-destination

fallback

None

choices

None

You can set parent.stomp.subscribe_destination from the environment by setting the environment variable BG_PARENT_STOMP_SUBSCRIBE_DESTINATION

You can set parent.stomp.subscribe_destination from the command-line by specifying --parent-stomp-subscribe-destination at Beer Garden’s entrypoint.

parent.stomp.username

Username to use for authentication

Attribute Value

item_type

str

default

None

env_name

BG_PARENT_STOMP_USERNAME

required

False

cli_name

--parent-stomp-username

fallback

None

choices

None

You can set parent.stomp.username from the environment by setting the environment variable BG_PARENT_STOMP_USERNAME

You can set parent.stomp.username from the command-line by specifying --parent-stomp-username at Beer Garden’s entrypoint.

parent.sync_interval

Number of minutes to wait before sending Garden Sync event to parent

Attribute Value

item_type

int

default

15

env_name

BG_PARENT_SYNC_INTERVAL

required

True

cli_name

--parent-sync-interval

fallback

None

choices

None

You can set parent.sync_interval from the environment by setting the environment variable BG_PARENT_SYNC_INTERVAL

You can set parent.sync_interval from the command-line by specifying --parent-sync-interval at Beer Garden’s entrypoint.

If parent.sync_interval is not set in any of the sources listed, it will fallback to the default value 15

plugin.allow_command_updates

Allow commands of non-dev systems to be updated

Attribute Value

item_type

bool

default

False

env_name

BG_PLUGIN_ALLOW_COMMAND_UPDATES

required

True

cli_name

--plugin-allow-command-updates

fallback

None

choices

None

You can set plugin.allow_command_updates from the environment by setting the environment variable BG_PLUGIN_ALLOW_COMMAND_UPDATES

You can set plugin.allow_command_updates from the command-line by specifying --plugin-allow-command-updates at Beer Garden’s entrypoint.

When False, this prevents changes to the command definitions of a registered version of a system. This means that the system will fail to start if the commands do not match what is on record for that version of the system. When True, the system will be allowed to start and the commands on record will be updated accordingly. NOTE: System versions containing 'dev' are exempt from this check.

plugin.local.auth.password

Password that local plugins will use for authentication (needs bg-plugin role)

Attribute Value

item_type

str

default

password

env_name

BG_PLUGIN_LOCAL_AUTH_PASSWORD

required

False

cli_name

--plugin-local-auth-password

fallback

None

choices

None

You can set plugin.local.auth.password from the environment by setting the environment variable BG_PLUGIN_LOCAL_AUTH_PASSWORD

You can set plugin.local.auth.password from the command-line by specifying --plugin-local-auth-password at Beer Garden’s entrypoint.

If plugin.local.auth.password is not set in any of the sources listed, it will fallback to the default value password

plugin.local.auth.username

Username that local plugins will use for authentication (needs bg-plugin role)

Attribute Value

item_type

str

default

plugin_admin

env_name

BG_PLUGIN_LOCAL_AUTH_USERNAME

required

False

cli_name

--plugin-local-auth-username

fallback

None

choices

None

You can set plugin.local.auth.username from the environment by setting the environment variable BG_PLUGIN_LOCAL_AUTH_USERNAME

You can set plugin.local.auth.username from the command-line by specifying --plugin-local-auth-username at Beer Garden’s entrypoint.

If plugin.local.auth.username is not set in any of the sources listed, it will fallback to the default value plugin_admin

plugin.local.directory

Directory where local plugins are located

Attribute Value

item_type

str

default

None

env_name

BG_PLUGIN_LOCAL_DIRECTORY

required

False

cli_name

--plugin-local-directory

fallback

None

choices

None

You can set plugin.local.directory from the environment by setting the environment variable BG_PLUGIN_LOCAL_DIRECTORY

You can set plugin.local.directory from the command-line by specifying --plugin-local-directory at Beer Garden’s entrypoint.

plugin.local.host_env_vars

Host environment variables that will be propagated to local plugin processes

Attribute Value

item_type

list

default

[]

env_name

None

required

True

cli_name

--plugin-local-host-env-vars

fallback

None

choices

None

You can set plugin.local.host_env_vars from the command-line by specifying --plugin-local-host-env-vars at Beer Garden’s entrypoint.

plugin.local.logging.config_file

Path to a logging configuration file for local plugins

Attribute Value

item_type

str

default

None

env_name

BG_PLUGIN_LOCAL_LOGGING_CONFIG_FILE

required

False

cli_name

--plugin-local-logging-config-file

fallback

None

choices

None

You can set plugin.local.logging.config_file from the environment by setting the environment variable BG_PLUGIN_LOCAL_LOGGING_CONFIG_FILE

You can set plugin.local.logging.config_file from the command-line by specifying --plugin-local-logging-config-file at Beer Garden’s entrypoint.

plugin.local.logging.fallback_level

Level that will be used with a default logging configuration if config_file is not specified

Attribute Value

item_type

str

default

INFO

env_name

BG_PLUGIN_LOCAL_LOGGING_FALLBACK_LEVEL

required

True

cli_name

--plugin-local-logging-fallback-level

fallback

None

choices

['DEBUG', 'INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL']

You can set plugin.local.logging.fallback_level from the environment by setting the environment variable BG_PLUGIN_LOCAL_LOGGING_FALLBACK_LEVEL

You can set plugin.local.logging.fallback_level from the command-line by specifying --plugin-local-logging-fallback-level at Beer Garden’s entrypoint.

If plugin.local.logging.fallback_level is not set in any of the sources listed, it will fallback to the default value INFO

plugin.local.timeout.shutdown

Seconds to wait for a plugin to stopgracefully

Attribute Value

item_type

int

default

10

env_name

BG_PLUGIN_LOCAL_TIMEOUT_SHUTDOWN

required

True

cli_name

--plugin-local-timeout-shutdown

fallback

None

choices

None

You can set plugin.local.timeout.shutdown from the environment by setting the environment variable BG_PLUGIN_LOCAL_TIMEOUT_SHUTDOWN

You can set plugin.local.timeout.shutdown from the command-line by specifying --plugin-local-timeout-shutdown at Beer Garden’s entrypoint.

If plugin.local.timeout.shutdown is not set in any of the sources listed, it will fallback to the default value 10

plugin.local.timeout.startup

Seconds to wait for a plugin to start

Attribute Value

item_type

int

default

5

env_name

BG_PLUGIN_LOCAL_TIMEOUT_STARTUP

required

True

cli_name

--plugin-local-timeout-startup

fallback

None

choices

None

You can set plugin.local.timeout.startup from the environment by setting the environment variable BG_PLUGIN_LOCAL_TIMEOUT_STARTUP

You can set plugin.local.timeout.startup from the command-line by specifying --plugin-local-timeout-startup at Beer Garden’s entrypoint.

If plugin.local.timeout.startup is not set in any of the sources listed, it will fallback to the default value 5

plugin.mq.host

Globally resolvable host name of message broker

Attribute Value

item_type

str

default

localhost

env_name

BG_PLUGIN_MQ_HOST

required

True

cli_name

--plugin-mq-host

fallback

None

choices

None

You can set plugin.mq.host from the environment by setting the environment variable BG_PLUGIN_MQ_HOST

You can set plugin.mq.host from the command-line by specifying --plugin-mq-host at Beer Garden’s entrypoint.

If plugin.mq.host is not set in any of the sources listed, it will fallback to the default value localhost

This will be supplied to all plugins as the location of the message broker. In order to support both local and remote plugins it’s important that this value be universally resolvable.

plugin.remote.logging.config_file

Path to a logging configuration file for plugins

Attribute Value

item_type

str

default

None

env_name

BG_PLUGIN_REMOTE_LOGGING_CONFIG_FILE

required

False

cli_name

--plugin-remote-logging-config-file

fallback

None

choices

None

You can set plugin.remote.logging.config_file from the environment by setting the environment variable BG_PLUGIN_REMOTE_LOGGING_CONFIG_FILE

You can set plugin.remote.logging.config_file from the command-line by specifying --plugin-remote-logging-config-file at Beer Garden’s entrypoint.

plugin.remote.logging.fallback_level

Level that will be used with a default logging configuration if config_file is not specified

Attribute Value

item_type

str

default

INFO

env_name

BG_PLUGIN_REMOTE_LOGGING_FALLBACK_LEVEL

required

True

cli_name

--plugin-remote-logging-fallback-level

fallback

None

choices

['DEBUG', 'INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL']

You can set plugin.remote.logging.fallback_level from the environment by setting the environment variable BG_PLUGIN_REMOTE_LOGGING_FALLBACK_LEVEL

You can set plugin.remote.logging.fallback_level from the command-line by specifying --plugin-remote-logging-fallback-level at Beer Garden’s entrypoint.

If plugin.remote.logging.fallback_level is not set in any of the sources listed, it will fallback to the default value INFO

plugin.status_heartbeat

Amount of time between status messages

Attribute Value

item_type

int

default

10

env_name

BG_PLUGIN_STATUS_HEARTBEAT

required

True

cli_name

--plugin-status-heartbeat

fallback

None

choices

None

You can set plugin.status_heartbeat from the environment by setting the environment variable BG_PLUGIN_STATUS_HEARTBEAT

You can set plugin.status_heartbeat from the command-line by specifying --plugin-status-heartbeat at Beer Garden’s entrypoint.

If plugin.status_heartbeat is not set in any of the sources listed, it will fallback to the default value 10

plugin.status_history

Amount of historical status heartbeats tracked

Attribute Value

item_type

int

default

50

env_name

BG_PLUGIN_STATUS_HISTORY

required

True

cli_name

--plugin-status-history

fallback

None

choices

None

You can set plugin.status_history from the environment by setting the environment variable BG_PLUGIN_STATUS_HISTORY

You can set plugin.status_history from the command-line by specifying --plugin-status-history at Beer Garden’s entrypoint.

If plugin.status_history is not set in any of the sources listed, it will fallback to the default value 50

plugin.status_timeout

Amount of time to wait before marking a plugin asunresponsive

Attribute Value

item_type

int

default

30

env_name

BG_PLUGIN_STATUS_TIMEOUT

required

True

cli_name

--plugin-status-timeout

fallback

None

choices

None

You can set plugin.status_timeout from the environment by setting the environment variable BG_PLUGIN_STATUS_TIMEOUT

You can set plugin.status_timeout from the command-line by specifying --plugin-status-timeout at Beer Garden’s entrypoint.

If plugin.status_timeout is not set in any of the sources listed, it will fallback to the default value 30

replication.enabled

Publish subset of events to Rabbit to allow all Gardens to stay in sync when replicated

Attribute Value

item_type

bool

default

False

env_name

BG_REPLICATION_ENABLED

required

True

cli_name

--replication-enabled

fallback

None

choices

None

You can set replication.enabled from the environment by setting the environment variable BG_REPLICATION_ENABLED

You can set replication.enabled from the command-line by specifying --replication-enabled at Beer Garden’s entrypoint.

request_validation.dynamic_choices.command.timeout

Time to wait for a command-based choices validation

Attribute Value

item_type

int

default

10

env_name

BG_REQUEST_VALIDATION_DYNAMIC_CHOICES_COMMAND_TIMEOUT

required

False

cli_name

--request_validation-dynamic_choices-command-timeout

fallback

None

choices

None

You can set request_validation.dynamic_choices.command.timeout from the environment by setting the environment variable BG_REQUEST_VALIDATION_DYNAMIC_CHOICES_COMMAND_TIMEOUT

You can set request_validation.dynamic_choices.command.timeout from the command-line by specifying --request_validation-dynamic_choices-command-timeout at Beer Garden’s entrypoint.

If request_validation.dynamic_choices.command.timeout is not set in any of the sources listed, it will fallback to the default value 10

request_validation.dynamic_choices.url.ca_cert

CA file for validating url-based choices

Attribute Value

item_type

str

default

None

env_name

BG_REQUEST_VALIDATION_DYNAMIC_CHOICES_URL_CA_CERT

required

False

cli_name

--request_validation-dynamic_choices-url-ca-cert

fallback

None

choices

None

You can set request_validation.dynamic_choices.url.ca_cert from the environment by setting the environment variable BG_REQUEST_VALIDATION_DYNAMIC_CHOICES_URL_CA_CERT

You can set request_validation.dynamic_choices.url.ca_cert from the command-line by specifying --request_validation-dynamic_choices-url-ca-cert at Beer Garden’s entrypoint.

request_validation.dynamic_choices.url.ca_verify

Verify external certificates for url-based choices

Attribute Value

item_type

bool

default

True

env_name

BG_REQUEST_VALIDATION_DYNAMIC_CHOICES_URL_CA_VERIFY

required

False

cli_name

--request_validation-dynamic_choices-url-no-ca-verify

fallback

None

choices

None

You can set request_validation.dynamic_choices.url.ca_verify from the environment by setting the environment variable BG_REQUEST_VALIDATION_DYNAMIC_CHOICES_URL_CA_VERIFY

You can set request_validation.dynamic_choices.url.ca_verify from the command-line by specifying --request_validation-dynamic_choices-url-no-ca-verify at Beer Garden’s entrypoint.

If request_validation.dynamic_choices.url.ca_verify is not set in any of the sources listed, it will fallback to the default value True

scheduler.job_defaults.coalesce

Should jobs run only once if multiple have missed their window

Attribute Value

item_type

bool

default

True

env_name

BG_SCHEDULER_JOB_DEFAULTS_COALESCE

required

True

cli_name

--scheduler-job_defaults-no-coalesce

fallback

None

choices

None

You can set scheduler.job_defaults.coalesce from the environment by setting the environment variable BG_SCHEDULER_JOB_DEFAULTS_COALESCE

You can set scheduler.job_defaults.coalesce from the command-line by specifying --scheduler-job_defaults-no-coalesce at Beer Garden’s entrypoint.

If scheduler.job_defaults.coalesce is not set in any of the sources listed, it will fallback to the default value True

scheduler.job_defaults.max_instances

Default maximum instances of a job to run concurrently.

Attribute Value

item_type

int

default

3

env_name

BG_SCHEDULER_JOB_DEFAULTS_MAX_INSTANCES

required

True

cli_name

--scheduler-job_defaults-max-instances

fallback

None

choices

None

You can set scheduler.job_defaults.max_instances from the environment by setting the environment variable BG_SCHEDULER_JOB_DEFAULTS_MAX_INSTANCES

You can set scheduler.job_defaults.max_instances from the command-line by specifying --scheduler-job_defaults-max-instances at Beer Garden’s entrypoint.

If scheduler.job_defaults.max_instances is not set in any of the sources listed, it will fallback to the default value 3

scheduler.max_workers

Number of workers (processes) to run concurrently.

Attribute Value

item_type

int

default

10

env_name

BG_SCHEDULER_MAX_WORKERS

required

True

cli_name

--scheduler-max-workers

fallback

None

choices

None

You can set scheduler.max_workers from the environment by setting the environment variable BG_SCHEDULER_MAX_WORKERS

You can set scheduler.max_workers from the command-line by specifying --scheduler-max-workers at Beer Garden’s entrypoint.

If scheduler.max_workers is not set in any of the sources listed, it will fallback to the default value 10

ui.auto_refresh

Auto refresh user interface

Attribute Value

item_type

bool

default

False

env_name

BG_UI_AUTO_REFRESH

required

True

cli_name

--ui-auto-refresh

fallback

None

choices

None

You can set ui.auto_refresh from the environment by setting the environment variable BG_UI_AUTO_REFRESH

You can set ui.auto_refresh from the command-line by specifying --ui-auto-refresh at Beer Garden’s entrypoint.

ui.cors_enabled

Determine if CORS should be enabled

Attribute Value

item_type

bool

default

True

env_name

BG_UI_CORS_ENABLED

required

True

cli_name

--ui-no-cors-enabled

fallback

None

choices

None

You can set ui.cors_enabled from the environment by setting the environment variable BG_UI_CORS_ENABLED

You can set ui.cors_enabled from the command-line by specifying --ui-no-cors-enabled at Beer Garden’s entrypoint.

If ui.cors_enabled is not set in any of the sources listed, it will fallback to the default value True

ui.debug_mode

Run the application in debug mode

Attribute Value

item_type

bool

default

False

env_name

BG_UI_DEBUG_MODE

required

True

cli_name

--ui-debug-mode

fallback

None

choices

None

You can set ui.debug_mode from the environment by setting the environment variable BG_UI_DEBUG_MODE

You can set ui.debug_mode from the command-line by specifying --ui-debug-mode at Beer Garden’s entrypoint.

ui.execute_javascript

Execute plugin-provided javascript

Attribute Value

item_type

bool

default

False

env_name

BG_UI_EXECUTE_JAVASCRIPT

required

True

cli_name

--ui-execute-javascript

fallback

None

choices

None

You can set ui.execute_javascript from the environment by setting the environment variable BG_UI_EXECUTE_JAVASCRIPT

You can set ui.execute_javascript from the command-line by specifying --ui-execute-javascript at Beer Garden’s entrypoint.

This is dangerous!! Setting this to true will instruct the browser to execute javascript provided by plugins. This means you MUST have control over all plugins running in the environment, otherwise this is a problem waiting to happen.

ui.icon_default

Default font-awesome icon to display

Attribute Value

item_type

str

default

fa-beer

env_name

BG_UI_ICON_DEFAULT

required

True

cli_name

--ui-icon-default

fallback

None

choices

None

You can set ui.icon_default from the environment by setting the environment variable BG_UI_ICON_DEFAULT

You can set ui.icon_default from the command-line by specifying --ui-icon-default at Beer Garden’s entrypoint.

If ui.icon_default is not set in any of the sources listed, it will fallback to the default value fa-beer

ui.name

The title to display on the GUI

Attribute Value

item_type

str

default

Beer Garden

env_name

BG_UI_NAME

required

True

cli_name

--ui-name

fallback

None

choices

None

You can set ui.name from the environment by setting the environment variable BG_UI_NAME

You can set ui.name from the command-line by specifying --ui-name at Beer Garden’s entrypoint.

If ui.name is not set in any of the sources listed, it will fallback to the default value Beer Garden