atc job from concourse/2.3.1

The ATC (Air Traffic Controller) provides UI and API access. It is responsible for scheduling builds and detecting versions of your resources.

Github source: 8abe10e or master branch

Properties¶

`allow_self_signed_certificates`¶

Allow self-signed certificates.

Default

false

`auth_duration`¶

Length of time for which tokens are valid. Afterwards, users will have to log back in. Use Go duration format (48h = 48 hours).

Default

24h

`basic_auth_password`¶

Password for HTTP basic auth, in plaintext.

Default

""

`basic_auth_username`¶

Username for HTTP basic auth.

Default

""

`bind_ip`¶

IP address on which the ATC should listen for HTTP traffic.

Default

0.0.0.0

`bind_port`¶

Port on which the ATC should listen for HTTP traffic.

Default

`default_check_interval`¶

The interval, in Go duration format (1m = 1 minute), on which to check for new versions of resources.

This can also be specified on a per-resource basis by specifying check_every on the resource config.

Default

1m

`development_mode`¶

Loosen up security for development purposes. This allows the ATC to be configured with no authentication methods.

Default

false

`external_url`¶

Externally reachable URL of the ATCs. Required for OAuth.

Typically this is the URL that you as a user would use to reach your CI. For multiple ATCs it would go to some sort of load balancer.

Example

https://ci.concourse.ci

`generic_oauth`¶

auth_url¶

Generic OAuth provider authorization endpoint url.
Default
""
auth_url_params¶

List Parameter to pass to the authentication server authorization url.
Default
{}
Example
param1: value1
param2: value2
client_id¶

Application client ID for enabling generic OAuth.
Default
""
client_secret¶

Application client secret for enabling generic OAuth.
Default
""
display_name¶

Name of the authentication method to be displayed on the Web UI
Default
""
scope¶

OAuth scope required for users who will have access.
Default
""
token_url¶

Generic OAuth provider token endpoint URL.
Default
""

`github_auth`¶

api_url¶

Override default API endpoint URL for Github Enterprise. Must end in a trailing slash.
Example
https://github.example.com/api/v3/
auth_url¶

Override default OAuth endpoint for Github Enterprise.
Example
https://github.example.com/login/oauth/authorize
authorize¶

An array of different criteria to check for when authorizing a GitHub user. If empty, GitHub authorization is effectively disabled.
Default
[]
Example
- organization: org1
  teams: all
- organization: org2
  teams:
  - Team 1
  - Team 2
- user: user1
- user: user2
client_id¶

GitHub client ID to use for OAuth.

The application must be configured with its callback URL as {external_url}/auth/github/callback (replacing {external_url} with the actual value).
Default
""
client_secret¶

GitHub client secret to use for OAuth.

The application must be configured with its callback URL as {external_url}/auth/github/callback (replacing {external_url} with the actual value).
Default
""
token_url¶

Override default access token endpoint for Github Enterprise.
Example
https://github.example.com/login/oauth/access_token

`log_db_queries`¶

Log database queries. Log level is debug, so requires development mode.

Default

false

`old_resource_grace_period`¶

How long to cache the result of a get step after a newer version of the resource is found. Use Go duration format (1m = 1 minute).

Default

5m

`peer_url`¶

Address used internally to reach the ATC. This will be auto-generated using the IP of each ATC VM if not specified.

Note that this refers to an individual ATC, not the whole cluster. This property is only useful if you’re deploying in a way that cannot autodetect its own IP, e.g. a bosh-init deployment.

You should otherwise leave this value blank.

`postgresql`¶

address¶

Address of a PostgreSQL server to connect to, in HOST:PORT format.

If not specified, one will be autodiscovered via BOSH links.

database¶

Name of the database to use.
Default
atc
role¶
name¶

Name of role to connect with.
Default
atc
password¶

Password to use when connecting.

`postgresql_database`¶

Name of the database to use from the postgresql link.

`resource_cache_cleanup_interval`¶

The interval, in Go duration format (1m = 1 minute), on which to check for and release old caches of resource versions.

Default

30s

`riemann`¶

host¶

If configured, detailed metrics will be emitted to the specified Riemann server.
Default
""
port¶

Port of the Riemann server to emit events to.
Default
5555
service_prefix¶

An optional prefix for emitted Riemann services
Default
""
tags¶

An optional map of tags in key: value format
Default
{}
Example
env: dev
foo: bar

`tls_bind_port`¶

Port on which the ATC should listen for HTTPS traffic.

Default

`tls_cert`¶

SSL cert to use for HTTPS.

If not specified, only HTTP will be enabled.

`tls_key`¶

SSL private key to use for encrypting HTTPS traffic.

If not specified, only HTTP will be enabled.

`uaa_auth`¶

auth_url¶

UAA authorization endpoint url to use for OAuth.
Default
""
cf_api_url¶

Cloud Foundry api endpoint url.
Default
""
cf_ca_cert¶

Cloud Foundry CA Certificate.
Default
""
cf_spaces¶

List of space GUIDs for Cloud Foundry spaces whose developers will have access.
Default
[]
client_id¶

UAA client ID to use for OAuth.
Default
""
client_secret¶

UAA client secret to use for OAuth.
Default
""
token_url¶

UAA token endpoint url to use for OAuth.
Default
""

`yeller`¶

api_key¶

If configured, errors emitted to the logs will also be emitted to Yeller. This is only really useful for Concourse developers.
Default
""
environment_name¶

Environment name to specify for errors emitted to Yeller.
Default
""

Templates¶

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

bin/atc_ctl (from atc_ctl.erb)
config/cf_ca_cert (from cf_ca_cert.erb)
config/tls_cert (from tls_cert.erb)
config/tls_key (from tls_key.erb)

Packages¶

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

atc job from concourse/2.3.1

Properties¶

allow_self_signed_certificates¶

auth_duration¶

basic_auth_password¶

basic_auth_username¶

bind_ip¶

bind_port¶

default_check_interval¶

development_mode¶

external_url¶

generic_oauth¶

auth_url¶

auth_url_params¶

client_id¶

client_secret¶

display_name¶

scope¶

token_url¶

github_auth¶

api_url¶

auth_url¶

authorize¶

client_id¶

client_secret¶

token_url¶

log_db_queries¶

old_resource_grace_period¶

peer_url¶

postgresql¶

address¶

database¶

role¶

name¶

password¶

postgresql_database¶

resource_cache_cleanup_interval¶

riemann¶

host¶

port¶

service_prefix¶

tags¶

tls_bind_port¶

tls_cert¶

tls_key¶

uaa_auth¶

auth_url¶

cf_api_url¶

cf_ca_cert¶

cf_spaces¶

client_id¶

client_secret¶

token_url¶

yeller¶

api_key¶

environment_name¶

Templates¶

Packages¶

`allow_self_signed_certificates`¶

`auth_duration`¶

`basic_auth_password`¶

`basic_auth_username`¶

`bind_ip`¶

`bind_port`¶

`default_check_interval`¶

`development_mode`¶

`external_url`¶

`generic_oauth`¶

`auth_url`¶

`auth_url_params`¶

`client_id`¶

`client_secret`¶

`display_name`¶

`scope`¶

`token_url`¶

`github_auth`¶

`api_url`¶

`auth_url`¶

`authorize`¶

`client_id`¶

`client_secret`¶

`token_url`¶

`log_db_queries`¶

`old_resource_grace_period`¶

`peer_url`¶

`postgresql`¶

`address`¶

`database`¶

`role`¶

`name`¶

`password`¶

`postgresql_database`¶

`resource_cache_cleanup_interval`¶

`riemann`¶

`host`¶

`port`¶

`service_prefix`¶

`tags`¶

`tls_bind_port`¶

`tls_cert`¶

`tls_key`¶

`uaa_auth`¶

`auth_url`¶

`cf_api_url`¶

`cf_ca_cert`¶

`cf_spaces`¶

`client_id`¶

`client_secret`¶

`token_url`¶

`yeller`¶

`api_key`¶

`environment_name`¶