atc job from concourse/1.1.0
The ATC (Air Traffic Controller) provides UI and API access. It is responsible for scheduling builds and detecting versions of your resources.
Github source:
3a9a5e6e
or
master branch
Properties¶
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
8080
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.
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
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.
publicly_viewable
¶
Allow viewing of pipelines as an anonymous user. Destructive operations
still require auth, and the output of builds will only be visible if
their job is configured with public: true
.
This is useful for open-source projects, or as a convenience to make monitoring your pipeline status easier.
- Default
false
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
retention
¶
container
¶
failure_duration
¶The duration to keep a failed step’s containers before expiring them.
- Default
1h
success_duration
¶The duration to keep a succeeded step’s containers before expiring them.
- Default
5m
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
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
(fromatc_ctl.erb
)
Packages¶
Packages are compiled and placed onto corresponding
instances during the deployment process. Packages will be
placed into /var/vcap/packages/
directory.