Resources are listed under the
resources: key in the pipeline configuration. Each configured resource consists of the following fields:
Required. The name of the resource. This should be short and simple. This name will be referenced by build plans of jobs in the pipeline.
Optional. The name of a Material Design icon to show next to the resource name in the web UI. For example,
Optional. The location of the resource. This varies by resource type, and is a black box to Concourse; it is blindly passed to the resource at runtime.
git as an example, the source may contain the repo URI, the branch of the repo to track, and a private key to use when pushing/pulling.
By convention, documentation for each resource type's configuration is in each implementation's
You can find the source for the resource types provided with Concourse at the Concourse GitHub organization.
Resources can also be temporarily pinned to a version via the API and web UI. However this functionality is disabled if the resource is pinned via configuration, and if a pipeline is configured to have a version pinned while also pinned in the web UI, the configuration takes precedence and will clear out the temporary pin.
1m. The interval on which to check for new versions of the resource. Acceptable interval options are defined by the time.ParseDuration function.
. A list of tags to determine which workers the checks will be performed on. You'll want to specify this if the source is internal to a worker's network, for example. See also
tags step modifier.
false. If set to
true, the metadata for each version of the resource will be viewable by unauthenticated users (assuming the pipeline has been exposed).
Resource metadata should never contain credentials or secret information, but this is off by default just to be safe in case users don't want to show things like commit messages and authors to the public.
Note: even when set to
false, the versions identifiers will be visible. In addition, if a resource is fetched in a build whose job is marked
public, metadata will be visible in the build output.
Optional. If specified, web hooks can be sent to trigger an immediate check of the resource, specifying this value as a primitive form of authentication via query params.
After configuring this value, you would then configure your hook sender with the following painfully long path appended to your external URL:
Note that the request payload sent to this API endpoint is entirely ignored. You should configure the resource as if you're not using web hooks, as the resource config is still the "source of truth."