https://github.com/temporalio/terraform-provider-temporalcloud
Terraform provider for Temporal Cloud
https://github.com/temporalio/terraform-provider-temporalcloud
Last synced: about 1 month ago
JSON representation
Terraform provider for Temporal Cloud
- Host: GitHub
- URL: https://github.com/temporalio/terraform-provider-temporalcloud
- Owner: temporalio
- License: mpl-2.0
- Created: 2023-08-03T17:12:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-12T21:29:54.000Z (about 1 month ago)
- Last Synced: 2025-03-12T22:22:32.572Z (about 1 month ago)
- Language: Go
- Size: 13.2 MB
- Stars: 14
- Watchers: 14
- Forks: 13
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-temporal - `temporalio/terraform-provider-temporalcloud` - Terraform Provider for Temporal Cloud (Tools / Terraform Providers)
README
# Temporal Cloud Terraform Provider
Interact with [Temporal Cloud](https://temporal.io/cloud) resources.
[registry.terraform.io/providers/temporalio/temporalcloud](https://registry.terraform.io/providers/temporalio/temporalcloud/latest)
[Documentation](https://registry.terraform.io/providers/temporalio/temporalcloud/latest/docs)
## Contributing
### Requirements
- [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.0
- [Go](https://golang.org/doc/install) >= 1.19
- [Temporal SDK](https://github.com/temporalio/sdk-go) >= 1.26.0
### Building
1. Clone the repository
1. Enter the repository directory
1. Build the provider using the Go `install` command:
```shell
go install
```
### Documenting
[docs/](docs/) are defined in code (see `MarkdownDescription`) and are generated by:
```shell
go install
# edit code
# format and generate docs
gofmt -s -w .
go generate ./...
```
### Developing
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.
In order to run the full suite of Acceptance tests, run `make testacc`.
*Note:* Acceptance tests create real resources, and often cost money to run.
```shell
make testacc
```
### 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:
```shell
go get github.com/author/dependency
go mod tidy
```
Then commit the changes to `go.mod` and `go.sum`.
### Testing with Terraform
In order to test your code you need an api key for temporal cloud. Docs on how to generate this is here:
https://github.com/temporalio/tcld/tree/release/apikeys#api-key-management-preview
Then you need to make the provider binary available to `terraform` itself.
```
go build -o terraform-provider-temporalcloud
mkdir -p ~/.terraform.d/plugins/temporal.io/provider-temporalcloud/temporalcloud/1.0.0/darwin_arm64/
mv terraform-provider-temporalcloud ~/.terraform.d/plugins/temporal.io/provider-temporalcloud/temporalcloud/1.0.0/darwin_arm64
```
Finally, your terraform configuration files need to know about this provider.
```
provider "temporalcloud" {
api_key = ""
}
terraform {
required_providers {
temporalcloud = {
version = "~> 1.0.0"
source = "temporal.io/provider-temporalcloud/temporalcloud"
}
}
}
```
Now you can start testing your provider with `terraform`!