Skip to content

consul_agent_windows job from consul/197

Github source: a46fe75 or master branch

Properties

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
false
max_stale

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

Default
5s
service_ttl

TTL for service DNS

Default
0s
domain

Domain suffix for DNS

log_level

Agent log level.

Default
info
node_name_includes_id

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

Default
false
protocol_version

The Consul protocol to use.

Default
2
require_ssl

Require SSL to talk with the local agent

Default
false
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
{}

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

syslog_daemon_config

address

Syslog host

Default
""

port

Syslog port

Default
""

transport

Syslog transport protocol (tcp or udp)

Default
udp

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_windows/ directory (learn more).

  • bin/post-start.ps1 (from post-start.ps1.erb)
  • bin/pre-start.ps1 (from pre-start.ps1.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)
  • 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.