orstensemantics/concourse-tfe-resource repository overview

⁠concourse-tfe-resource

Concourse resource for Terraform Cloud and Terraform Enterprise using Hashicorp's go-tfe library⁠.

⁠Usage

resource_types:
  - name: tfe
    type: docker-image
    source:
      repository: orstensemantics/concourse-tfe-resource

⁠Source Configuration

⁠Behaviour

⁠in - Retrieve a run and related information

• Get will wait for the run to enter a final state (policy_soft_failed, planned_and_finished, applied, discarded, errored, canceled, force_canceled)
• Get will not fail based on the final state of the run. If you need to respond to the final state, this will exit with a non-zero status if the run didn't end with a successful apply or a plan with no changes:

$ cat your_run/metadata.json | jq -e '.final_status | IN(["applied","planned_and_finished"], .)'

• If the run requires confirmation to apply and confirm is true, get will apply the run.
  • This is determined by the actions.is-confirmable attribute of the run and not the auto-apply setting of the workspace, so this will apply to runs created by workspace triggers
• Workspace variables, environment variables and state outputs will be retrieved:
  • IMPORTANT - the values returned will be the current ones, even if the provided run ID is not the latest.
  • ./vars will hold a file for each workspace variable, containing the current value of the variable. HCL variables will be in .vars/hcl. Sensitive variables will be empty.
  • ./env_vars will hold a file for each environment variable, containing the current value. Sensitive values will be empty.
  • ./outputs.json will be a JSON file of all of the root level outputs of the current workspace state. Sensitive values will be empty strings unless the sensitive param is true. Suitable for load_var/set_pipeline steps.
  • ./outputs will hold a file for each root level output of the current workspace state. Sensitive values will be empty files unless the sensitive param is true. Since outputs can be complex values, the contents of the file are JSON, so simple string outputs are quoted.
  • ./metadata.json will contain the same metadata values visible in the resource version.

⁠Parameters

⁠out - Push variables and create run

• Any provided variables will be pushed to the workspace
• A run will be queued.

⁠Parameters

⁠Variable Parameters

At least one of value or file must be set for every entry. All others are optional.

⁠Example

    - ...
    - put: my-workspace
      params:
        vars:
          my_workspace_var:
            # if you specify value *and* file, value will take precedence
            value: a value # you can specify a value directly
            file: someoutput/filename # or you can reference a file containing the value
            description: a description # optional 
            sensitive: true # optional, default is false
            hcl: true # optional, default is false
          MY_ENV_VAR:
            value: a value
            file: someoutput/filename
            category: env
        message: Name of Build in Terraform Cloud # optional

⁠Message Variables

The message and apply_message variables support interpolations via drone/envsubst⁠. The table below lists the available variables. Most bash string replacement functions are supported (see the link for more details).