List of controller configuration keys¶
This document gives a list of all the configuration keys that can be applied to a Juju controller.
agent-logfile-max-backups¶
agent-logfile-max-backups is the maximum number of old agent log files
to keep (compressed; saved on each unit, synced to the controller).
Type: integer
Default value: 2
Can be changed after bootstrap: yes
agent-logfile-max-size¶
agent-logfile-max-size is the maximum file size of each agent log file,
in MB.
Type: string
Default value: 100M
Can be changed after bootstrap: yes
agent-ratelimit-max¶
agent-ratelimit-max is the maximum size of the token bucket used to
ratelimit the agent connections to the API server.
Type: integer
Default value: 10
Can be changed after bootstrap: yes
agent-ratelimit-rate¶
agent-ratelimit-rate is the interval at which a new token is added to
the token bucket, in milliseconds (ms).
Type: duration
Default value: 250ms
Can be changed after bootstrap: yes
api-port-open-delay¶
api-port-open-delay is a duration that the controller will wait
between when the controller has been deemed to be ready to open
the api-port and when the api-port is actually opened. This value
is only used when a controller-api-port value is set.
Type: duration
Default value: 2s
Can be changed after bootstrap: yes
application-resource-download-limit¶
application-resource-download-limit limits the number of concurrent resource download
requests from unit agents which will be served. The limit is per application.
Use a value of 0 to disable the limit.
Type: integer
Default value: 0
Can be changed after bootstrap: yes
audit-log-capture-args¶
audit-log-capture-args determines whether the audit log will
contain the arguments passed to API methods.
Type: boolean
Default value: false
Can be changed after bootstrap: yes
audit-log-exclude-methods¶
audit-log-exclude-methods is a list of Facade.Method names that
aren’t interesting for audit logging purposes. A conversation
with only calls to these will be excluded from the
log. (They’ll still appear in conversations that have other
interesting calls though.).
Type: list[string]
Can be changed after bootstrap: yes
audit-log-max-backups¶
audit-log-max-backups is the number of old audit log files to keep
(compressed).
Type: integer
Default value: 10
Can be changed after bootstrap: yes
audit-log-max-size¶
audit-log-max-size is the maximum size for the current audit log
file, eg “250M”.
Type: string
Default value: 300M
Can be changed after bootstrap: yes
auditing-enabled¶
auditing-enabled determines whether the controller will record
auditing information.
Type: boolean
Default value: true
Can be changed after bootstrap: yes
batch-raft-fsm¶
batch-raft-fsm allows raft to use batch writing to the FSM.
Type: boolean
caas-image-repo¶
caas-image-repo sets the docker repo to use
for the jujud operator and mongo images.
Type: string
Can be changed after bootstrap: yes
controller-api-port¶
controller-api-port is an optional port that may be set for controllers
that have a very heavy load. If this port is set, this port is used by
the controllers to talk to each other - used for the local API connection
as well as the pubsub forwarders, and the raft workers. If this value is
set, the api-port isn’t opened until the controllers have started
properly.
Type: integer
Can be changed after bootstrap: yes
controller-resource-download-limit¶
controller-resource-download-limit limits the number of concurrent resource download
requests from unit agents which will be served. The limit is for the combined total
of all applications on the controller.
Use a value of 0 to disable the limit.
Type: integer
Default value: 0
Can be changed after bootstrap: yes
features¶
features allows a list of runtime changeable features to be updated.
Type: list[string]
Can be changed after bootstrap: yes
juju-ha-space¶
juju-ha-space is the network space within which the MongoDB replica-set
should communicate.
Type: string
Can be changed after bootstrap: yes
juju-mgmt-space¶
juju-mgmt-space is the network space that agents should use to
communicate with controllers.
Type: string
Can be changed after bootstrap: yes
max-agent-state-size¶
max-agent-state-size is the maximum allowed size of internal state
data that agents can store to the controller in bytes. A value of 0
disables the quota checks although in principle, mongo imposes a
hard (but configurable) limit of 16M.
Type: integer
Default value: 524288
Can be changed after bootstrap: yes
max-charm-state-size¶
max-charm-state-size is the maximum allowed size of charm-specific
per-unit state data that charms can store to the controller in
bytes. A value of 0 disables the quota checks although in
principle, mongo imposes a hard (but configurable) limit of 16M.
Type: integer
Default value: 2097152
Can be changed after bootstrap: yes
max-debug-log-duration¶
max-debug-log-duration is used to provide a backstop to the execution of a
debug-log command. If someone starts a debug-log session in a remote
screen for example, it is very easy to disconnect from the screen while
leaving the debug-log process running. This causes unnecessary load on
the API server. The max debug-log duration has a default of 24 hours,
which should be more than enough time for a debugging session.
Type: duration
Default value: 24h0m0s
Can be changed after bootstrap: yes
max-prune-txn-batch-size¶
This key is deprecated.
max-prune-txn-batch-size (deprecated) is the maximum number of transactions
we will evaluate in one go when pruning. Default is 1M transactions.
A value <= 0 indicates to do all transactions at once.
Type: integer
Default value: 1000000
Can be changed after bootstrap: yes
max-prune-txn-passes¶
This key is deprecated.
max-prune-txn-passes (deprecated) is the maximum number of batches that
we will process. So total number of transactions that can be processed
is max-prune-txn-batch-size * max-prune-txn-passes. A value <= 0 implies
‘do a single pass’. If both max-prune-txn-batch-size and max-prune-txn-passes
are 0, then the default value of 1M BatchSize and 100 passes
will be used instead.
Type: integer
Default value: 100
Can be changed after bootstrap: yes
migration-agent-wait-time¶
migration-agent-wait-time is the maximum time that the migration-master
worker will wait for agents to report for a migration phase when
executing a model migration.
Type: duration
Default value: 15m0s
Can be changed after bootstrap: yes
model-logfile-max-backups¶
model-logfile-max-backups is the number of old model
log files to keep (compressed).
Type: integer
Default value: 2
Can be changed after bootstrap: yes
model-logfile-max-size¶
model-logfile-max-size is the maximum size of the log file written out by the
controller on behalf of workers running for a model.
Type: string
Default value: 10M
Can be changed after bootstrap: yes
model-logs-size¶
model-logs-size is the size of the capped collections used to hold the
logs for the models, eg “20M”. Size is per model.
Type: string
Default value: 20M
Can be changed after bootstrap: yes
mongo-memory-profile¶
mongo-memory-profile sets the memory profile for MongoDB. Valid values are:
“low”: use the least possible memory
“default”: use the default memory profile.
Type: string
Default value: default
Can be changed after bootstrap: yes
non-synced-writes-to-raft-log¶
Do not perform fsync calls after appending entries to the raft log. Disabling sync improves performance at the cost of reliability.
Type: boolean
prune-txn-query-count¶
prune-txn-query-count is the number of transactions to read in a single query.
Minimum of 10, a value of 0 will indicate to use the default value (1000).
Type: integer
Default value: 1000
Can be changed after bootstrap: yes
prune-txn-sleep-time¶
prune-txn-sleep-time is the amount of time to sleep between processing each
batch query. This is used to reduce load on the system, allowing other
queries to time to operate. On large controllers, processing 1000 txs
seems to take about 100ms, so a sleep time of 10ms represents a 10%
slowdown, but allows other systems to operate concurrently.
A negative number will indicate to use the default, a value of 0
indicates to not sleep at all.
Type: duration
Default value: 10ms
Can be changed after bootstrap: yes
public-dns-address¶
public-dns-address is the public DNS address (and port) of the controller.
Type: string
Can be changed after bootstrap: yes