Skip to content

Latest commit

 

History

History
169 lines (123 loc) · 5.16 KB

README.md

File metadata and controls

169 lines (123 loc) · 5.16 KB
Raw

epilot-file

To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`. 
terraform {
  required_providers {
    epilot-file = {
      source  = "epilot-dev/epilot-file"
      version = "0.2.0"
    }
  }
}

provider "epilot-file" {
  # Configuration options
}
### 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

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.

terraform {
  required_providers {
    epilot-file = {
      source  = "epilot-dev/epilot-file"
      version = "0.5.0"
    }
  }
}

provider "epilot-file" {
  # 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.

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-file
  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-file" = "<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 {}
}

Available Resources and Data Sources

Resources

Data Sources

Summary

File API: Upload and manage epilot Files

Table of Contents

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-file" = "<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 {}
}

Your <PATH> may vary depending on how your Go environment variables are configured. Execute go env GOBIN to set it, then set the <PATH> 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