Skip to content

Latest commit

 

History

History
96 lines (72 loc) · 2.93 KB

README.md

File metadata and controls

96 lines (72 loc) · 2.93 KB
Raw

Concourse Fly Resource

A Concourse resource for manipulating fly.

See Docker Hub for tagged image versions available.

Compatibility matrix:

Concourse Version Resource Image Tag
5.x 2.x, latest
4.x 2.x, latest
3.x 1.x
2.x and below NOPE

Resource Type Configuration

resource_types:
- name: fly
  type: docker-image
  source:
    repository: troykinsella/concourse-fly-resource
    tag: latest

Source Configuration

Currently only HTTP basic authentication is supported.

  • url: Optional. The base URL of the concourse instance to contact. (i.e. https://ci.concourse-ci.org). Default: The value of the $ATC_EXTERNAL_URL metadata variable.
  • username: Required. The concourse basic auth username.
  • password: Required. The concourse basic auth password.
  • target: Optional. The name of the target concourse instance. Default: "main".
  • team: Optional. The concourse team to login to. Default: The value of the $BUILD_TEAM_NAME metadata variable.
  • insecure: Optional. Set to true to skip TLS verification.
  • debug: Optional. Set to true to print commands (such as fly login and fly sync) for troubleshooting, including credentials. Default: false.
  • secure_output: Optional. Set to false to show potentially insecure options and echoed fly commands. Default: true.
  • multiline_lines: Optional. Set to true to interpret \ as one line (mostly for big options line).

Example

resources:
- name: fly
  type: fly
  source:
    url: {{concourse_url}}
    username: ((concourse_username))
    password: ((concourse_password))
    team: eh-team

Behaviour

check: No-Op

in: No-Op

out: Execute fly Command

Execute the given fly command along with given options. The fly client is downloaded from the target Concourse instance if not already present. If there is a version mismatch between fly and Concourse, a fly sync is performed. When multiple lines are present in the provided options, fly is executed separately for each line.

Parameters

  • options: Optional. The options to pass to fly.
  • options_file: Optional. A file containing options to pass to fly.

Parameters are passed through to the fly command as follows:

fly -t <target> <options>

Concourse metadata variables are supported in options.

Example

- name: trigger-something
  plan:
  - put: fly
    params:
      options: trigger-job -j some-pipeline/some-job

License

MIT © Troy Kinsella