Event-Driven Declarative Orchestrator

     

Get started with Kestra in 4 minutes.

Kestra Terraform Provider

This repository defines Kestra resources so that they can be deployed using Infrastructure as Code with Terraform.

Important

Kestra Terraform provider 0.24.x is only compatible with Kestra 0.24.x and above. Additionally, if you want to terraform Kestra 0.24.x you need to use Kestra Terraform provider 0.24.x

Documentation

• The official Kestra documentation can be found under kestra.io/docs
• Kestra Terraform provider documentation can be found here.

Using the provider

This Terraform Provider is available to install automatically via terraform init. It is recommended to setup the following Terraform configuration to pin the major version:

terraform {
  required_providers  {
    source = "kestra-io/kestra"
    version = "~> X.Y" # where X.Y is the current major version and minor version
  }
}

Additional documentation, including available resources and their arguments/attributes can be found on the Terraform documentation website.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and need a Kestra cluster.

$ make testacc

Requirements

• Terraform >= 0.13.x
• Go >= 1.16

Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go install command:

$ go install

Start tests in local

The full test suite requires to start the full docker-compose-ci.yml and have access to Kestra EE docker image:

1. read and do requirements of init-tests-env.sh
2. init test environment

$ ./init-tests-env.sh

3. run tests

$ TF_ACC=1 KESTRA_URL=http://127.0.0.1:8088 KESTRA_USERNAME=root@root.com KESTRA_PASSWORD='Root!1234' go test -v -cover ./internal/provider/

Test coverage

To display generate a test coverage file in local you can add -coverprofile to your test command:

go test -v -coverprofile=test-coverage-result.out ./internal/...

and then to display it:

# in browser
$ go tool cover -html=test-coverage-result.out

# in terminal
$ go tool cover -func=test-coverage-result.out

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Stay up to date

We release new versions every month. Give the main repository a star to stay up to date with the latest releases and get notified about future updates.

License

Apache 2.0 © Kestra Technologies