README.md

Terraform Provider for Codefresh

This is the official Terraform Provider for Codefresh.

Terraform Registry: registry.terraform.io/providers/codefresh-io/codefresh

Requirements

• Terraform 1.x.x

Download the Provider

Download and extract terraform-provider-codefresh from releases

Using the Provider

In versions.tf:

terraform {
  required_providers {
    codefresh = {
      version = "x.y.z" # Optional but recommended; replace with latest semantic version
      source = "codefresh-io/codefresh"
    }
  }
}

Building the Provider Locally

make install

Provider Documentation

The documentation is generated using tfplugindocs.

See: CONTRIBUTING.md

To configure Codefresh provider:

provider "codefresh" {
  api_url = "<MY API URL>" # Default value - https://g.codefresh.io/api
  token = "<MY API TOKEN>" # If token isn't set the provider expects the $CODEFRESH_API_KEY env variable
}

Get an API key from Codefresh and set the following scopes:

• Environments-V2
• Pipeline
• Project
• Repos
• Step-Type
• Step-Types
• View

export CODEFRESH_API_KEY='xyz'

Testing the Provider

NOTE: Acceptance tests create real resources, including admin resources (accounts, users) so make sure that CODEFRESH_API_KEY is set to an account that you are ok with being modified.

make testacc

Contributors

Acknowledgements

This provider was initialized by LightStep.

License

Copyright 2023 Codefresh.

The Codefresh Provider is available under MPL2.0 license.