https://github.com/epilot-dev/terraform-provider-epilot-workflow
Terraform provider for epilot workflow definition API
https://github.com/epilot-dev/terraform-provider-epilot-workflow
Last synced: 2 months ago
JSON representation
Terraform provider for epilot workflow definition API
- Host: GitHub
- URL: https://github.com/epilot-dev/terraform-provider-epilot-workflow
- Owner: epilot-dev
- Created: 2024-06-06T13:41:23.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-01T12:51:49.000Z (2 months ago)
- Last Synced: 2026-04-01T14:52:04.491Z (2 months ago)
- Language: Go
- Size: 972 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# epilot-workflow
To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.
```hcl
terraform {
required_providers {
epilot-workflow = {
source = "epilot-dev/epilot-workflow"
version = "0.8.2"
}
}
}
provider "epilot-workflow" {
# Configuration options go below
}
```
### Testing the provider locally
Should you want to validate a change locally, the `--debug` flag allows you to execute the provider against a terraform instance locally.
This also allows for debuggers (e.g. delve) to be attached to the provider.
### Example
```sh
go run main.go --debug
# Copy the TF_REATTACH_PROVIDERS env var
# In a new terminal
cd examples/your-example
TF_REATTACH_PROVIDERS=... terraform init
TF_REATTACH_PROVIDERS=... terraform apply
```
## Installation
To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.
```hcl
terraform {
required_providers {
epilot-workflow = {
source = "epilot-dev/epilot-workflow"
version = "0.29.0"
}
}
}
provider "epilot-workflow" {
bearer_auth = "" # Required
server_url = "..." # Optional
}
```
## Testing the provider locally
#### Local Provider
Should you want to validate a change locally, the `--debug` flag allows you to execute the provider against a terraform instance locally.
This also allows for debuggers (e.g. delve) to be attached to the provider.
```sh
go run main.go --debug
# Copy the TF_REATTACH_PROVIDERS env var
# In a new terminal
cd examples/your-example
TF_REATTACH_PROVIDERS=... terraform init
TF_REATTACH_PROVIDERS=... terraform apply
```
#### Compiled Provider
Terraform allows you to use local provider builds by setting a `dev_overrides` block in a configuration file called `.terraformrc`. This block overrides all other configured installation methods.
1. Execute `go build` to construct a binary called `terraform-provider-epilot-workflow`
2. Ensure that the `.terraformrc` file is configured with a `dev_overrides` section such that your local copy of terraform can see the provider binary
Terraform searches for the `.terraformrc` file in your home directory and applies any configuration settings you set.
```
provider_installation {
dev_overrides {
"registry.terraform.io/epilot-dev/epilot-workflow" = ""
}
# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
```
## Authentication
This provider supports authentication configuration via provider configuration.
Available configuration:
| Provider Attribute | Description |
|---|---|
| `bearer_auth` | HTTP Bearer. |
## Available Resources and Data Sources
### Resources
* [epilot-workflow_closing_reason](docs/resources/closing_reason.md)
* [epilot-workflow_flow_template](docs/resources/flow_template.md)
* [epilot-workflow_workflow_definition](docs/resources/workflow_definition.md)
### Data Sources
* [epilot-workflow_closing_reason](docs/data-sources/closing_reason.md)
* [epilot-workflow_flow_template](docs/data-sources/flow_template.md)
* [epilot-workflow_workflow_definition](docs/data-sources/workflow_definition.md)
## Summary
Workflows Definitions: Service for Workflow Definitions for different processes inside of an Organization
## Table of Contents
* [epilot-workflow](#epilot-workflow)
* [Installation](#installation)
* [Testing the provider locally](#testing-the-provider-locally)
* [Authentication](#authentication)
* [Available Resources and Data Sources](#available-resources-and-data-sources)
Terraform allows you to use local provider builds by setting a `dev_overrides` block in a configuration file called `.terraformrc`. This block overrides all other configured installation methods.
Terraform searches for the `.terraformrc` file in your home directory and applies any configuration settings you set.
```
provider_installation {
dev_overrides {
"registry.terraform.io/epilot-dev/epilot-workflow" = ""
}
# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
```
Your `` may vary depending on how your Go environment variables are configured. Execute `go env GOBIN` to set it, then set the `` to the value returned. If nothing is returned, set it to the default location, `$HOME/go/bin`.
Note: To use the dev_overrides, please ensure you run `go build` in this folder. You must have a binary available for terraform to find.
### Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)