docs(README): Added section about installing local provider binary
This commit is contained in:
parent
ec291c6447
commit
a39300ce56
1 changed files with 22 additions and 0 deletions
22
README.md
22
README.md
|
|
@ -56,6 +56,28 @@ Note: Adjust the path based on your OS and architecture (e.g., `linux_amd64`, `d
|
|||
|
||||
### Provider Configuration
|
||||
|
||||
As the provider is currently not officially registered for public download, terraform must be configured to use a locally built version.
|
||||
|
||||
To generate the binary run `go install .` from the repository root. This installs the provider binary to `$HOME/go/bin` and means that `terraform init` is not necessary.
|
||||
|
||||
You will also need a `~/.terraformrc` file with the following contents. `<home>` should refer to your `$HOME` directory.
|
||||
|
||||
```hcl
|
||||
provider_installation {
|
||||
|
||||
dev_overrides {
|
||||
"local/edge-connect" = "<home>/go/bin"
|
||||
}
|
||||
|
||||
# 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 {}
|
||||
}
|
||||
```
|
||||
|
||||
You can then reference the local provider in your `.tf` files as follows:
|
||||
|
||||
```hcl
|
||||
provider "edge-connect" {
|
||||
base_url = "https://edp.buildth.ing"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue