This repository is a template for a Terraform provider. It is intended as a starting point for creating Terraform providers, containing:
- A resource, and a data source (
internal/provider/
), - Examples (
examples/
) and generated documentation (docs/
), - Miscellaneous meta files.
These files contain boilerplate code that you will need to edit to create your own Terraform provider. A full guide to creating Terraform providers can be found at Writing Custom Providers.
Please see the GitHub template repository documentation for how to create a new repository from this template on GitHub.
Once you've written your provider, you'll want to publish it on the Terraform Registry so that others can use it.
- Authlete account
- Terraform >= 0.13.x
- Go >= 1.15
- Clone the repository
- Enter the repository directory
- Build the provider using the make
install
command:
$ go mod tidy
$ make install
This provider support managing the services and its configuration from terraform script.
The provider can also generate random RSA and EC (including Ed25519 and X235519) keys that will reside only on Authlete side.
If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).
To compile the provider, run go install
. This will build the provider and put the provider binary in the $GOPATH/bin
directory.
To generate or update documentation, run go generate
.
In order to run the full suite of Acceptance tests, run make testacc
.
Note: Acceptance tests create real resources, and often cost money to run.
$ export AUTHLETE_API_SERVER="https://fapidev-api.authlete.net"
$ export AUTHLETE_SO_SECRET="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
$ export AUTHLETE_SO_KEY="XXXXXXXXXXXXXX"
$ make testacc