Skip to content

worker job from concourse/4.2.7

The ground crew registers a Garden worker with the ATC on an interval, advertises supported resource types, and cleans up ephemeral containers on shutdown.

Github source: a2aa231 or master branch

Properties

additional_resource_types

Additional resource types supported by the workers in [{type: string, image: string}] format.

Default
[]

baggageclaim

forward_address

Baggageclaim server connection address to forward through SSH to the TSA.

If not specified, the Baggageclaim server address is registered directly.

url

Baggageclaim server URL to advertise directly to the TSA.

If not specified, either the baggageclaim link is used.

certs_path

A path to a directory on the instance to create the resource certificates volume from.

Default
/etc/ssl/certs

drain_timeout

Maximum wait time in Go duration format (1m = 1 minute) for worker drain to be finished. Only applies when worker is getting shutdown.

If not specified, it will be indefinite.

ephemeral

If set, the worker will immediately disappear upon stalling.

Default
false

garden

address

Garden server connection address to advertise directly to the TSA.

If not specified, either the garden link is used, or the instance’s address is advertised if the link is not found.

forward_address

Garden server connection address to forward through SSH to the TSA.

If not specified, the Garden server address is registered directly.

http_proxy_url

Proxy to use for outgoing http requests from containers.

https_proxy_url

Proxy to use for outgoing https requests from containers.

log_level

The log level for the worker. When set to debug, you’ll see a lot more information.

Default
info

no_proxy

A list domains and IPs with optional port for which the proxy should be bypassed, e.g. [localhost, 127.0.0.1, example.com, domain.com:8080]

Default
[]

platform

Platform to advertise for each worker.

Default
linux

tags

An array of tags to advertise for each worker.

Default
[]

team

Register the worker for a single team.

If not specified, the worker will be shared across all teams.

Default
""

tsa

host

IP or DNS address of the TSA server to register with.

If not specified, the tsa link is used.

host_public_key

Public key to verify for the TSA server. If not specified, the tsa link is used.

Example
ssh-rsa ...

port

Port of the TSA server to register with.

Only used when tsa.host is also specified. Otherwise the port is autodiscovered via the tsa link.

Default
2222

registration_mode

The registration ‘mode’ (direct, or forward), to use when registering the worker with the ATC. If “forward” is specified, the worker’s Baggageclaim and Garden address will be forwarded through SSH to the TSA.

If “direct” is specified, the worker will be registered directly without forwarding over SSH.

Default
direct

worker_key

SSH key to use when authenticating with the TSA.

Example
private_key: |+
  -----BEGIN RSA PRIVATE KEY-----
  ...
  -----END RSA PRIVATE KEY-----
public_key: ssh-rsa ...

Templates

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

  • bin/drain (from drain.erb)
  • bin/worker_ctl (from worker_ctl.erb)
  • config/tsa_host_key.pub (from tsa_host_key.pub.erb)
  • config/worker_key (from worker_key.erb)

Packages

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