Concourse Pipeline Resource
Interact with concourse pipelines from concourse.
Installing
This resource is only compatible with Concourse versions 0.74.0 and higher
as no BOSH release is provided. Use this resource by adding the following to
the resource_types
section of a pipeline config:
---
resource_types:
- name: concourse-pipeline
type: docker-image
source:
repository: robdimsdale/concourse-pipeline-resource
tag: latest-final
See concourse docs for more details
on adding resource_types
to a pipeline config.
Using tag: latest-final
will pull the latest final release, which can be
found on the
releases page
To avoid automatically upgrading, use a fixed tag instead e.g. tag: v0.6.3
The docker image is robdimsdale/concourse-pipeline-resource
; the images are
available on
dockerhub.
The rootfs of the docker image is available with each release on the
releases page.
The docker image is semantically versioned; these versions correspond to the git tags
in this repository.
Source Configuration
-
target
: Optional. URL of your concourse instance e.g. https://my-concourse.com
.
If not specified, the resource defaults to the ATC_EXTERNAL_URL
environment variable,
meaning it will always target the same concourse that created the container.
-
username
: Required. Basic auth username for logging in to Concourse.
Basic Auth must be enabled on the Concourse installation.
-
password
: Required. Basic auth password for logging in to Concourse.
Basic Auth must be enabled on the Concourse installation.
-
insecure
: Optional. Connect to Concourse insecurely - i.e. skip SSL validation.
Defaults to false if not provided.
Example Pipeline Configuration
Check
---
resources:
- name: my-pipelines
type: concourse-pipeline
source:
target: https://my-concourse.com
username: some-user
password: some-password
In
Resource configuration as above for Check, with the following job configuration:
---
jobs:
- name: download-my-pipelines
plan:
- get: my-pipelines
Out - static
Resource configuration as above for Check, with the following job configuration:
---
jobs:
- name: set-my-pipelines
plan:
- put: my-pipelines
params:
pipelines:
- name: my-pipeline
config_file: path/to/config/file
vars_files:
- path/to/optional/vars/file/1
- path/to/optional/vars/file/2
Out - dynamic
Resource configuration as above for Check, with the following job configuration:
---
jobs:
- name: set-my-pipelines
plan:
- put: my-pipelines
params:
pipelines_file: path/to/pipelines/file
Behavior
check
: Check for changes to the pipelines.
Return the versions of all pipelines.
in
: Get the configuration of the pipelines
Get the config for each pipeline; write it to the local working directory (e.g.
/tmp/build/get
) with the filename derived from the pipeline name.
For example, if there are two pipelines foo
and bar
the config for the
first will be written to foo.yml
and the second to bar.yml
.
out
: Set the configuration of the pipelines
Set the configuration for each pipeline provided in the params
section.
Configuration can be either static or dynamic. Static configuration has the configuration fixed in the pipeline config file, whereas dynamic configuration reads the pipeline configuration from the provided file.
Either static or dynamic configuration must be selected; using both is not allowed.
Parameters - static
pipelines
: Required. Array of pipelines to configure.
Must be non-nil and non-empty. The structure of the pipeline
object is as follows:
-
name
: Required. Name of pipeline to be configured.
Equivalent of -p my-pipeline-name
in fly set-pipeline
command.
-
config_file
: Required. Location of config file.
Equivalent of -c some-config-file.yml
in fly set-pipeline
command.
-
vars_files
: Optional. Array of strings corresponding to files
containing variables to be interpolated via {{ }}
in config_file
.
Equivalent of -l some-vars-file.yml
in fly set-pipeline
command.
Parameters - dynamic
-
pipelines_file
: Required. Path to dynamic configuration file. The contents of this file should look as follows:
---
pipelines:
- name: my-pipeline
config_file: path/to/config/file
vars_files:
- path/to/optional/vars/file/1
- path/to/optional/vars/file/2
This is the same structure as Static configuration above, but in a file. See that section to determine which fields are optional and which are required.
Developing
Prerequisites
A valid install of golang >= 1.5 is required.
Dependencies
Dependencies are vendored in the vendor
directory, according to the
golang 1.5 vendor experiment.
If using golang 1.6, no action is required.
If using golang 1.5 run the following command:
export GO15VENDOREXPERIMENT=1
Updating dependencies
Install gvt and make sure it is available
in your $PATH, e.g.:
go get -u github.com/FiloSottile/gvt
To add a new dependency:
gvt fetch
To update an existing dependency to a specific version:
gvt delete <import_path>
gvt fetch -revision <revision_number> <import_path>
Running the tests
Install the ginkgo executable with:
go get -u github.com/onsi/ginkgo/ginkgo
The tests require a concourse API server to test against, and a valid
basic auth username/password for that concourse deployment.
Run the tests with the following command:
TARGET=https://my-concourse.com \
USERNAME=my-basic-auth-user \
PASSWORD=my-basic-auth-password \
./bin/test
Contributing
Please make all pull requests to the develop
branch, and
ensure the tests pass locally.
Project management
The CI for this project can be found at https://concourse.robdimsdale.com/pipelines/concourse-pipeline-resource
and the scripts can be found in the
robdimsdale-ci repository.
The roadmap is captured in Pivotal Tracker.