https://github.com/epilot-dev/terraform-provider-epilot-taxonomy
https://github.com/epilot-dev/terraform-provider-epilot-taxonomy
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/epilot-dev/terraform-provider-epilot-taxonomy
- Owner: epilot-dev
- Created: 2024-02-02T14:38:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T00:08:43.000Z (about 2 years ago)
- Last Synced: 2024-04-13T23:01:44.937Z (about 2 years ago)
- Language: Go
- Size: 136 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.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-taxonomy = {
source = "epilot-dev/epilot-taxonomy"
version = "0.10.0"
}
}
}
provider "epilot-taxonomy" {
# 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-taxonomy`
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-taxonomy" = ""
}
# 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 |
|---|---|
| `epilot_auth` | Authorization header with epilot OAuth2 bearer token. |
| `epilot_org` | Overrides the target organization to allow shared tenantaccess. |
## Available Resources and Data Sources
### Resources
* [epilot-taxonomy_taxonomy_classification](docs/resources/taxonomy_classification.md)
### Data Sources
* [epilot-taxonomy_taxonomy_classification](docs/data-sources/taxonomy_classification.md)
## Summary
Entity API: Flexible data layer for epilot Entities.
Use this API configure and access your business objects like Contacts, Opportunities and Products.
[Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities)
## Table of Contents
* [Installation](#installation)
* [Testing the provider locally](#testing-the-provider-locally)
* [Authentication](#authentication)
* [Available Resources and Data Sources](#available-resources-and-data-sources)
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)