https://github.com/epilot-dev/terraform-provider-epilot-journey
Terraform provider for epilot journey API
https://github.com/epilot-dev/terraform-provider-epilot-journey
api epilot journey sdk
Last synced: 8 months ago
JSON representation
Terraform provider for epilot journey API
- Host: GitHub
- URL: https://github.com/epilot-dev/terraform-provider-epilot-journey
- Owner: epilot-dev
- Created: 2023-03-13T16:42:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-15T00:12:45.000Z (about 1 year ago)
- Last Synced: 2025-03-15T01:21:58.755Z (about 1 year ago)
- Topics: api, epilot, journey, sdk
- Language: Go
- Homepage: https://docs.epilot.io/api/journey/#tag/Journeys-V2
- Size: 735 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
Epilot is the digital foundation for sales, service, network and implementation processes in the context of the energy transition..
## Installation
To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.
```hcl
terraform {
required_providers {
epilot-journey = {
source = "epilot-dev/epilot-journey"
version = "0.9.8"
}
}
}
provider "epilot-journey" {
# Configuration options
}
```
## 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-journey`
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-journey" = ""
}
# 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 {}
}
```
## Summary
Journey API: API to configure journeys
## Table of Contents
* [Installation](#installation)
* [Testing the provider locally](#testing-the-provider-locally)
* [Available Resources and Data Sources](#available-resources-and-data-sources)
## Available Resources and Data Sources
### Resources
* [epilot-journey_journey](docs/resources/journey.md)
### Data Sources
* [epilot-journey_journey](docs/data-sources/journey.md)
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)