Beer Garden Children Configuration
Configuration
This section outlines the various configuration items Beer Garden Children supports.
Name | Type | Default | Description |
---|---|---|---|
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 Child 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 |
|
bool |
False |
If disabled, requires manual start for publishing operations |
|
bool |
False |
If disabled, requires manual start for receiving operations |
|
bool |
False |
Publish events to child 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 |
http.access_token
Access token for authentication
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.access_token from the environment by setting the environment variable BG_HTTP_ACCESS_TOKEN
You can set http.access_token
from the command-line by specifying --http-access-token
at Beer Garden Children’s entrypoint.
http.api_version
Beergarden API version
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.api_version from the environment by setting the environment variable BG_HTTP_API_VERSION
You can set http.api_version
from the command-line by specifying --http-api-version
at Beer Garden Children’s entrypoint.
If http.api_version
is not set in any of the sources listed, it will fallback to the default value 1
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 http.client_timeout from the environment by setting the environment variable BG_HTTP_CLIENT_TIMEOUT
You can set http.client_timeout
from the command-line by specifying --http-client-timeout
at Beer Garden Children’s entrypoint.
If 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).
http.enabled
Publish events to Child garden over HTTP
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.enabled from the environment by setting the environment variable BG_HTTP_ENABLED
You can set http.enabled
from the command-line by specifying --http-enabled
at Beer Garden Children’s entrypoint.
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 http.host from the environment by setting the environment variable BG_HTTP_HOST
You can set http.host
from the command-line by specifying --http-host
at Beer Garden Children’s entrypoint.
http.password
Password for authentication
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.password from the environment by setting the environment variable BG_HTTP_PASSWORD
You can set http.password
from the command-line by specifying --http-password
at Beer Garden Children’s entrypoint.
http.port
Serve content on this port
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.port from the environment by setting the environment variable BG_HTTP_PORT
You can set http.port
from the command-line by specifying --http-port
at Beer Garden Children’s entrypoint.
If http.port
is not set in any of the sources listed, it will fallback to the default value 2337
http.refresh_token
Refresh token for authentication
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.refresh_token from the environment by setting the environment variable BG_HTTP_REFRESH_TOKEN
You can set http.refresh_token
from the command-line by specifying --http-refresh-token
at Beer Garden Children’s entrypoint.
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 http.ssl.ca_cert from the environment by setting the environment variable BG_HTTP_SSL_CA_CERT
You can set http.ssl.ca_cert
from the command-line by specifying --http-ssl-ca-cert
at Beer Garden Children’s entrypoint.
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 http.ssl.ca_verify from the environment by setting the environment variable BG_HTTP_SSL_CA_VERIFY
You can set http.ssl.ca_verify
from the command-line by specifying --http-ssl-no-ca-verify
at Beer Garden Children’s entrypoint.
If http.ssl.ca_verify
is not set in any of the sources listed, it will fallback to the default value True
http.ssl.client_cert
Client certificate to use
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.ssl.client_cert from the environment by setting the environment variable BG_HTTP_SSL_CLIENT_CERT
You can set http.ssl.client_cert
from the command-line by specifying --http-ssl-client-cert
at Beer Garden Children’s entrypoint.
http.ssl.client_key
Client key to use
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.ssl.client_key from the environment by setting the environment variable BG_HTTP_SSL_CLIENT_KEY
You can set http.ssl.client_key
from the command-line by specifying --http-ssl-client-key
at Beer Garden Children’s entrypoint.
http.ssl.enabled
Use SSL when connecting
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.ssl.enabled from the environment by setting the environment variable BG_HTTP_SSL_ENABLED
You can set http.ssl.enabled
from the command-line by specifying --http-ssl-enabled
at Beer Garden Children’s entrypoint.
http.url_prefix
URL path prefix
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.url_prefix from the environment by setting the environment variable BG_HTTP_URL_PREFIX
You can set http.url_prefix
from the command-line by specifying --http-url-prefix
at Beer Garden Children’s entrypoint.
If http.url_prefix
is not set in any of the sources listed, it will fallback to the default value /
http.username
Username for authentication
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set http.username from the environment by setting the environment variable BG_HTTP_USERNAME
You can set http.username
from the command-line by specifying --http-username
at Beer Garden Children’s entrypoint.
publishing
If disabled, requires manual start for publishing operations
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set publishing from the environment by setting the environment variable BG_PUBLISHING
You can set publishing
from the command-line by specifying --publishing
at Beer Garden Children’s entrypoint.
receiving
If disabled, requires manual start for receiving operations
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set receiving from the environment by setting the environment variable BG_RECEIVING
You can set receiving
from the command-line by specifying --receiving
at Beer Garden Children’s entrypoint.
stomp.enabled
Publish events to child garden over STOMP
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set stomp.enabled from the environment by setting the environment variable BG_STOMP_ENABLED
You can set stomp.enabled
from the command-line by specifying --stomp-enabled
at Beer Garden Children’s entrypoint.
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 stomp.headers
from the command-line by specifying --stomp-headers
at Beer Garden Children’s entrypoint.
stomp.host
Broker hostname
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set stomp.host from the environment by setting the environment variable BG_STOMP_HOST
You can set stomp.host
from the command-line by specifying --stomp-host
at Beer Garden Children’s entrypoint.
If stomp.host
is not set in any of the sources listed, it will fallback to the default value localhost
stomp.password
Password to use for authentication
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set stomp.password from the environment by setting the environment variable BG_STOMP_PASSWORD
You can set stomp.password
from the command-line by specifying --stomp-password
at Beer Garden Children’s entrypoint.
stomp.port
Broker port
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set stomp.port from the environment by setting the environment variable BG_STOMP_PORT
You can set stomp.port
from the command-line by specifying --stomp-port
at Beer Garden Children’s entrypoint.
If stomp.port
is not set in any of the sources listed, it will fallback to the default value 61613
stomp.send_destination
Topic where events are published
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set stomp.send_destination from the environment by setting the environment variable BG_STOMP_SEND_DESTINATION
You can set stomp.send_destination
from the command-line by specifying --stomp-send-destination
at Beer Garden Children’s entrypoint.
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 stomp.ssl.ca_cert from the environment by setting the environment variable BG_STOMP_SSL_CA_CERT
You can set stomp.ssl.ca_cert
from the command-line by specifying --stomp-ssl-ca-cert
at Beer Garden Children’s entrypoint.
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 stomp.ssl.client_cert from the environment by setting the environment variable BG_STOMP_SSL_CLIENT_CERT
You can set stomp.ssl.client_cert
from the command-line by specifying --stomp-ssl-client-cert
at Beer Garden Children’s entrypoint.
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 stomp.ssl.client_key from the environment by setting the environment variable BG_STOMP_SSL_CLIENT_KEY
You can set stomp.ssl.client_key
from the command-line by specifying --stomp-ssl-client-key
at Beer Garden Children’s entrypoint.
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 stomp.ssl.use_ssl from the environment by setting the environment variable BG_STOMP_SSL_USE_SSL
You can set stomp.ssl.use_ssl
from the command-line by specifying --stomp-ssl-use-ssl
at Beer Garden Children’s entrypoint.
stomp.subscribe_destination
Topic to listen for operations
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set stomp.subscribe_destination from the environment by setting the environment variable BG_STOMP_SUBSCRIBE_DESTINATION
You can set stomp.subscribe_destination
from the command-line by specifying --stomp-subscribe-destination
at Beer Garden Children’s entrypoint.
stomp.username
Username to use for authentication
Attribute | Value |
---|---|
item_type |
|
default |
|
env_name |
|
required |
|
cli_name |
|
fallback |
|
choices |
|
You can set stomp.username from the environment by setting the environment variable BG_STOMP_USERNAME
You can set stomp.username
from the command-line by specifying --stomp-username
at Beer Garden Children’s entrypoint.