Skip to content

consul_agent job from consul/190

Github source: 4246afe or master branch

Properties

confab

timeout_in_seconds

Timeout used by Confab when starting up. Minimum is 60 seconds

Default
60

consul

agent

datacenter

Name of the agent’s datacenter.

Default
dc1
dns_config
allow_stale

Enables a stale query for DNS information. This allows any Consul server, rather than only the leader, to service the request.

Default
true
max_stale

When allow_stale is specified, this is used to limit how stale results are allowed to be.

Default
30s
recursor_timeout

Timeout used by Consul when recursively querying an upstream DNS server.

Default
5s
domain

Domain suffix for DNS

log_level

Agent log level.

Default
info
mode

Mode to run the agent in. (client or server)

Default
client
node_name

Node name for the agent. (Defaults to the BOSH instance group name)

node_name_includes_id

whether to include the unique spec.id in the node name

Default
false
ports
dns

DNS server port

Default
53
protocol_version

The Consul protocol to use.

Default
2
rewrite_resolv

When set to true this property will rewrite the resolv.conf file and add 127.0.0.1 as the first entry

Default
true
servers
lan

LAN server addresses to join on start.

Default
[]
wan

WAN server addresses to join.

Default
[]
services

Map of consul service definitions.

Default
{}
telemetry
statsd_address

Telemetry Statsd address

agent_cert

PEM-encoded agent certificate

agent_key

PEM-encoded client key

ca_cert

PEM-encoded CA certificate

client

enabled

Set to false to disable the consul_agent on a VM.

Default
true

encrypt_keys

A list of passphrases that will be converted into encryption keys, the first key in the list is the active one

server_cert

PEM-encoded server certificate

server_key

PEM-encoded server key

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/consul_agent/ directory (learn more).

  • bin/agent_ctl (from agent_ctl.sh.erb)
  • bin/agent_ctl_wrapper (from agent_ctl_wrapper.erb)
  • bin/drain (from drain)
  • bin/join_ctl (from join_ctl.sh.erb)
  • bin/pre-start (from pre-start.erb)
  • config/certs/agent.crt (from agent.crt.erb)
  • config/certs/agent.key (from agent.key.erb)
  • config/certs/ca.crt (from ca.crt.erb)
  • config/certs/server.crt (from server.crt.erb)
  • config/certs/server.key (from server.key.erb)
  • confab.json (from confab.json.erb)
  • consul_link.json (from consul_link.json.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.