Beer Garden Configuration
Configuration
This section outlines the various configuration items Beer Garden supports.
| Name | Type | Default | Description |
|---|---|---|---|
bool |
True |
Enable authentication via username andpassword |
|
bool |
True |
Create an account for the user specified byusername_header if one does not already exist |
|
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 |
str |
bg-username |
The http header containing the username |
|
str |
password |
The password for the default admin account that will be created when initializing a new environment |
|
str |
admin |
The username for the default admin account that will be created when initializing a new environment |
|
bool |
False |
Use role-based authentication / authorization |
|
str |
None |
Path to the yaml file that defines roles used for authorization |
|
int |
15 |
The Garden Admin Permission access token expiration time |
|
int |
15 |
The Operator Permission access token expiration time |
|
int |
15 |
The Plugin Admin Permission access token expiration time |
|
int |
15 |
The Read Only Permission access token expiration time |
|
int |
720 |
The Garden Admin Permission refresh token expiration time |
|
int |
720 |
The Operator Permission refresh token expiration time |
|
int |
720 |
The Plugin Admin Permission refresh token expiration time |
|
int |
720 |
The Read Only Permission refresh token expiration time |
|
str |
Secret to use when signing authentication tokens |
||
str |
None |
Path to the yaml file that defines users used for authorization |
|
str |
./children |
Directory where child garden configs are located |
|
str |
None |
Path to configuration file to use |
|
str |
localhost |
Hostname/IP of the database server |
|
str |
None |
Password to connect to the database |
|
int |
27017 |
Port of the database server |
|
str |
None |
Username to connect to the database |
|
str |
beer_garden |
Name of the database to use |
|
int |
15 |
Number of minutes to wait before running db pruner |
|
int |
-1 |
Number of minutes to wait before deleting ACTION requests (negative number for never) |
|
int |
-1 |
Number of minutes to wait before deleting Admin requests (negative number for never) |
|
int |
-1 |
Batch size for deleting documents (negative number for never) |
|
int |
15 |
Number of minutes to wait before deleting FILE documents (negative number for never) |
|
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) |
|
int |
15 |
Number of minutes to wait before deleting INFO requests (negative number for never) |
|
int |
15 |
Number of minutes to wait before deleting TEMP requests (negative number for never) |
|
bool |
True |
Run an HTTP server |
|
str |
0.0.0.0 |
Host for the HTTP Server to bind to |
|
int |
2337 |
Serve content on this port |
|
str |
None |
Path to CA certificate file to use for SSLContext |
|
str |
None |
Path to CA certificate path to use for SSLContext |
|
str |
NONE |
Client certificate mode to use when handling requests |
|
bool |
False |
Serve content using SSL |
|
str |
None |
Path to a private key |
|
str |
None |
Path to a public key |
|
str |
/ |
URL path prefix |
|
bool |
False |
Connect to a Stomp Broker |
|
list |
[] |
Headers to be sent with messages. Follows standard YAML formatting for lists with two variables 'key' and 'value' |
|
str |
localhost |
Broker hostname |
|
str |
None |
Password to use for authentication |
|
int |
61613 |
Broker port |
|
str |
None |
Topic where events are published |
|
str |
None |
Path to certificate file containing the certificate of the authority that issued the message broker certificate |
|
str |
None |
Path to client public certificate to use when communicating with the message broker |
|
str |
None |
Path to client private key to use when communicating with the message broker |
|
bool |
False |
Use SSL when connecting to the message broker |
|
str |
None |
Topic to listen for operations |
|
str |
None |
Username to use for authentication |
|
str |
default |
The routing name for upstream Beer Gardens to use |
|
int |
50 |
Amount of historical status heartbeats tracked for Garden and Connections |
|
str |
None |
Path to a logging config file. |
|
str |
None |
File to log to if config_file is not specified |
|
str |
INFO |
Log level to use if config_file is not specified |
|
bool |
False |
Enable elastic APM server |
|
str |
None |
URL to elastic apm server. |
|
bool |
False |
Enable prometheus server |
|
str |
0.0.0.0 |
Host to bind the prometheus server to |
|
int |
2338 |
Port for prometheus server to listen on. |
|
str |
None |
URL to prometheus/grafana server. |
|
int |
3600000 |
Time before unused admin queues are removed |
|
int |
5 |
Time to wait for a blocked connection to be unblocked |
|
int |
3 |
Number of retries to connect to MQ |
|
str |
guest |
Password to login to the MQ admin |
|
int |
15672 |
Port of the MQ Admin host |
|
str |
None |
Path to CA certificate file to use |
|
bool |
True |
Verify external certificates |
|
str |
None |
Path to client combined key / certificate |
|
bool |
False |
Should the connection use SSL |
|
str |
guest |
Username to login to the MQ admin |
|
str |
guest |
Password to login to the MQ host |
|
int |
5672 |
Port of the MQ host |
|
str |
None |
Path to CA certificate file to use |
|
bool |
True |
Verify external certificates |
|
str |
None |
Path to client combined key / certificate |
|
bool |
False |
Should the connection use SSL |
|
str |
guest |
Username to login to the MQ host |
|
str |
beer_garden |
Exchange name to use for MQ |
|
int |
3600 |
Heartbeat interval for MQ |
|
str |
localhost |
Will be used by the Beergarden application as the location of the message broker. |
|
str |
/ |
Virtual host to use for MQ |
|
str |
None |
Access token for authentication |
|
int |
1 |
Beergarden API version |
|
float |
-1 |
Max time RestClient will wait for server response |
|
bool |
False |
Publish events to parent garden over HTTP |
|
str |
None |
Host for the HTTP Server to bind to |
|
str |
None |
Password for authentication |
|
int |
2337 |
Serve content on this port |
|
str |
None |
Refresh token for authentication |
|
str |
None |
Path to CA certificate file to use for SSLContext |
|
bool |
True |
Verify server certificate when using SSL |
|
str |
None |
Client certificate to use |
|
str |
None |
Client key to use |
|
bool |
False |
Use SSL when connecting |
|
str |
/ |
URL path prefix |
|
str |
None |
Username for authentication |
|
list |
[] |
Events to be skipped |
|
bool |
False |
Publish events to parent garden over STOMP |
|
list |
[] |
Headers to be sent with messages. Follows standard YAML formatting for lists with two variables 'key' and 'value' |
|
str |
localhost |
Broker hostname |
|
str |
None |
Password to use for authentication |
|
int |
61613 |
Broker port |
|
str |
None |
Topic where events are published |
|
str |
None |
Path to certificate file containing the certificate of the authority that issued the message broker certificate |
|
str |
None |
Path to client public certificate to use when communicating with the message broker |
|
str |
None |
Path to client private key to use when communicating with the message broker |
|
bool |
False |
Use SSL when connecting to message broker |
|
str |
None |
Topic to listen for operations |
|
str |
None |
Username to use for authentication |
|
int |
15 |
Number of minutes to wait before sending Garden Sync event to parent |
|
bool |
False |
Allow commands of non-dev systems to be updated |
|
str |
password |
Password that local plugins will use for authentication (needs bg-plugin role) |
|
str |
plugin_admin |
Username that local plugins will use for authentication (needs bg-plugin role) |
|
str |
None |
Directory where local plugins are located |
|
list |
[] |
Host environment variables that will be propagated to local plugin processes |
|
str |
None |
Path to a logging configuration file for local plugins |
|
str |
INFO |
Level that will be used with a default logging configuration if config_file is not specified |
|
int |
10 |
Seconds to wait for a plugin to stopgracefully |
|
int |
5 |
Seconds to wait for a plugin to start |
|
str |
localhost |
Globally resolvable host name of message broker |
|
str |
None |
Path to a logging configuration file for plugins |
|
str |
INFO |
Level that will be used with a default logging configuration if config_file is not specified |
|
int |
10 |
Amount of time between status messages |
|
int |
50 |
Amount of historical status heartbeats tracked |
|
int |
30 |
Amount of time to wait before marking a plugin asunresponsive |
|
bool |
False |
Publish subset of events to Rabbit to allow all Gardens to stay in sync when replicated |
|
int |
10 |
Time to wait for a command-based choices validation |
|
str |
None |
CA file for validating url-based choices |
|
bool |
True |
Verify external certificates for url-based choices |
|
bool |
True |
Should jobs run only once if multiple have missed their window |
|
int |
3 |
Default maximum instances of a job to run concurrently. |
|
int |
10 |
Number of workers (processes) to run concurrently. |
|
bool |
False |
Auto refresh user interface |
|
bool |
True |
Determine if CORS should be enabled |
|
bool |
False |
Run the application in debug mode |
|
bool |
False |
Execute plugin-provided javascript |
|
str |
fa-beer |
Default font-awesome icon to display |
|
str |
Beer Garden |
The title to display on the GUI |
auth.authentication_handlers.basic.enabled
Enable authentication via username andpassword
| Attribute | Value |
|---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
`` |
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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 |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
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