epilot-custom-variable

Developer-friendly & type-safe Terraform SDK specifically catered to leverage epilot-custom-variable 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
• ♻️ Refine your terraform provider quickly by iterating locally with the Speakeasy CLI
• 🎁 Publish your terraform provider to hashicorp registry by configuring automatic publishing
• ✨ When ready to productionize, delete this section from the README

Summary

Template Variables API: API to provide variables for email and document templates.

Table of Contents

• epilot-custom-variable
  • 🏗 Welcome to your new Terraform Provider! 🏗
  • Installation
  • Available Resources and Data Sources
  • Testing the provider locally
• Development
  • Contributions

Installation

To install this provider, copy and paste this code into your Terraform configuration. Then, run terraform init.

terraform {
  required_providers {
    epilot-custom-variable = {
      source  = "epilot-dev/epilot-custom-variable"
      version = "1.2.0"
    }
  }
}

provider "epilot-custom-variable" {
  # Configuration options
}

Available Resources and Data Sources

Resources

• epilot-custom-variable_custom_variable

Data Sources

• epilot-custom-variable_custom_variable

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.

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-custom-variable
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-custom-variable" = "<PATH>"
  }

  # 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