https://github.com/epilot-dev/terraform-provider-epilot-portal
Terraform provider for epilot portals
https://github.com/epilot-dev/terraform-provider-epilot-portal
Last synced: 5 months ago
JSON representation
Terraform provider for epilot portals
- Host: GitHub
- URL: https://github.com/epilot-dev/terraform-provider-epilot-portal
- Owner: epilot-dev
- Created: 2025-07-13T22:02:38.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-01-23T00:39:28.000Z (5 months ago)
- Last Synced: 2026-01-23T17:43:36.351Z (5 months ago)
- Language: Go
- Size: 791 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# epilot-portal
Terraform Provider for the *epilot-portal* API.
## 🏗 **Welcome to your new Terraform Provider!** 🏗
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- [ ] 🛠 Add resources and datasources to your SDK by [annotating your OAS](https://www.speakeasy.com/docs/customize-terraform/terraform-extensions#map-api-entities-to-terraform-resources)
- [ ] ♻️ Refine your terraform provider quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
- [ ] 🎁 Publish your terraform provider to hashicorp registry by [configuring automatic publishing](https://www.speakeasy.com/docs/terraform-publishing)
- [ ] ✨ When ready to productionize, delete this section from the README
## Summary
Portal API: Backend for epilot portals - End Customer Portal & Installer Portal
## Table of Contents
* [epilot-portal](#epilot-portal)
* [🏗 **Welcome to your new Terraform Provider!** 🏗](#welcome-to-your-new-terraform-provider)
* [Installation](#installation)
* [Authentication](#authentication)
* [Available Resources and Data Sources](#available-resources-and-data-sources)
* [Testing the provider locally](#testing-the-provider-locally)
* [Development](#development)
* [Contributions](#contributions)
## Installation
To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.
```hcl
terraform {
required_providers {
epilot-portal = {
source = "epilot-dev/epilot-portal"
version = "0.26.3"
}
}
}
provider "epilot-portal" {
server_url = "..." # Optional
}
```
## Authentication
This provider supports authentication configuration via provider configuration.
Available configuration:
| Provider Attribute | Description |
|---|---|
| `either_auth` | Portal or Epilot Bearer Token. |
| `epilot_auth` | Epilot Bearer Token. |
| `portal_auth` | Portal Cognito Token. |
## Available Resources and Data Sources
### Resources
* [epilot-portal_portal_config](docs/resources/portal_config.md)
* [epilot-portal_portal_page](docs/resources/portal_page.md)
### Data Sources
* [epilot-portal_portal_config](docs/data-sources/portal_config.md)
* [epilot-portal_portal_page](docs/data-sources/portal_page.md)
## 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-portal`
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-portal" = ""
}
# 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 {}
}
```
# Development
## Contributions
While we value open-source contributions to this terraform provider, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=epilot-portal&utm_campaign=terraform)