Custom Concourse Resource to work as duct tape, meaning it can quickly bring things together that have no native or custom resource.
-
id
: Optional Use a custom identifier, if none is specified,ref
is used as the default. -
check
: Required The configuration to define what happens forcheck
.env
: Optional List of key/value pairs that are set as environment variables in the context of the commands.before
: Optional Command to be executed before therun
command. Any output of this command will redirected to StdErr.run
: Required Command to be executed.
-
in
: Required The configuration to define what happens forin
.env
: Optional List of key/value pairs that are set as environment variables in the context of the commands.before
: Optional Command to be executed before therun
command. Any output of this command will redirected to StdErr.run
: Optional Command to be executed. If undefined, it is considered a no-op.
-
out
: Required The configuration to define what happens forout
.env
: Optional List of key/value pairs that are set as environment variables in the context of the commands.before
: Optional Command to be executed before therun
command. Any output of this command will redirected to StdErr.run
: Optional Command to be executed. If undefined, it is considered a no-op.
The following sample shows the main fields that can be used. For example, to define a generic check based on inline shell script, use env
section to feed in variables (i.e. secrets) to the shell script. The code in before
is only executed once for the resource. With each iteration of the Concourse check, the run
section is executed.
resources:
- name: foobar
type: duct-tape-resource
icon: application-variable
check_every: 20m
source:
check:
env:
FOO: ((bar))
SOME: variable
before: |
#!/bin/bash
echo "run something once before the checks"
run: |
#!/bin/bash
date +%Y-%m-%d-%H%M
When Concourse runs the check of the resource, the run
section of the resource configuration will be executed. Each line of the output will treated as a value for the resource result JSON. For example, if the check
run
code prints something
to StdOut, the output JSON will be [{"ref": "something"}]
, with ref
being the default identifier used if none is explicitly provided.
No-op.
No-op.
- Go is required - TBD.
- Docker is required - TBD.
Run the test
Make target to test the project:
make test
Please make all pull requests to the main
branch and ensure tests pass locally.