https://github.com/kestra-io/terraform-provider-kestra

https://github.com/kestra-io/terraform-provider-kestra

kestra terraform terraform-provider

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kestra-io/terraform-provider-kestra
• Owner: kestra-io
• License: apache-2.0
• Created: 2021-04-01T18:37:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-26T09:15:54.000Z (19 days ago)
• Last Synced: 2024-10-27T06:49:15.088Z (18 days ago)
• Topics: kestra, terraform, terraform-provider
• Language: Go
• Homepage: https://kestra.io/docs/terraform/
• Size: 287 KB
• Stars: 16
• Watchers: 7
• Forks: 10
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  





    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.

![Kestra orchestrator](https://kestra.io/video.gif)

## Documentation

* The official Kestra documentation can be found under [kestra.io/docs](https://kestra.io/docs)

* Kestra Terraform provider documentation can be found [here](https://kestra.io/docs/terraform/).

## License

Apache 2.0 © [Kestra Technologies](https://kestra.io)

## Stay up to date

We release new versions every month. Give the [main repository](https://github.com/kestra-io/kestra) a star to stay up to date with the latest releases and get notified about future updates.

![Star the repo](https://kestra.io/star.gif)

## 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:

```hcl

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](https://registry.terraform.io/providers/kestra-io/kestra/latest/docs).

## Developing the Provider

If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#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.

```sh

$ make testacc

```

### Requirements

- [Terraform](https://www.terraform.io/downloads.html) >= 0.13.x

- [Go](https://golang.org/doc/install) >= 1.16

### Building The Provider

1. Clone the repository

1. Enter the repository directory

1. Build the provider using the Go `install` command:

```sh

$ go install

```

### Adding Dependencies

This provider uses [Go modules](https://github.com/golang/go/wiki/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`.