ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/docs/registry/providers/publishing.html.md

6.8 KiB
Raw Blame History

layout page_title sidebar_current description
registry Terraform Registry - Publishing Providers docs-registry-provider-publishing Publishing Providers to the Terraform Registry

Publishing Providers

-> Publishing Beta
Welcome! Thanks for your interest participating in our Providers in the Registry beta! Paired with Terraform 0.13, our vision is to make it easier than ever to discover, distribute, and maintain your provider(s). We welcome any feedback you have throughout the process and encourage you to reach out if you have any questions or issues by emailing terraform-registry-beta@hashicorp.com.

Preparing your Provider

Writing a Provider

Providers published to the Terraform Registry are written and built in the same way as other Terraform Providers. For guidance on how to write a provider, see Writing Custom Providers.

The provider repository on GitHub must match the pattern terraform-provider-{NAME}, and the repository must be public.

Licensing a Verified Provider

All Terraform Verified providers must contain one of the following open source licenses. This requirement does not apply to Community providers:

  • CDDL 1.0, 2.0
  • CPL 1.0
  • Eclipse Public License (EPL) 1.0
  • MPL 1.0, 1.1, 2.0
  • APSL 2.0
  • Ruby's Licensing
  • AFL 2.1, 3.0
  • Apache License 2.0
  • Artistic License 1.0, 2.0
  • Apache Software License (ASL) 1.1
  • Boost Software License
  • BSD, BSD 3-clause, "BSD-new"
  • CC-BY
  • Microsoft Public License (MS-PL)
  • MIT

Documenting your Provider

Your provider should contain an overview document (index.md), as well as a doc for each resource and data-source. See Documenting Providers for details about how to ensure your provider documentation renders properly on the Terraform Registry.

-> In order to test how documents will render in the Terraform Registry, you can use the Terraform Registry Doc Preview Tool.

Creating a GitHub Release

Publishing a provider requires at least one version be available on GitHub Releases. The tag must be a valid Semantic Version preceded with a v (for example, v1.2.3).

Terraform CLI and the Terraform Registry follow the Semantic Versioning specification when detecting a valid version, sorting versions, solving version constraints, and choosing the latest version. Prerelease versions are supported (available if explicitly defined but not chosen automatically) with a hyphen (-) delimiter, such as v1.2.3-pre.

We have a list of recommend OS / architecture combinations for which we suggest most providers create binaries.

~> Important: Avoid modifying or replacing an already-released version of a Provider, as this will cause checksum errors for users when attempting to download the plugin. Instead, if changes are necessary, please release as a new version.

Using GoReleaser locally

GoReleaser is a tool for building Go projects for multiple platforms, creating a checksums file, and signing the release. It can also upload your release to GitHub Releases.

  1. Install GoReleaser using the installation instructions.
  2. Copy the .goreleaser.yml file from the hashicorp/scaffolding provider repository.
  3. Cache the password for your GPG private key with gpg --armor --detach-sign (see note below).
  4. Set your GITHUB_TOKEN to a Personal Access Token that has the public_repo scope.
  5. Tag your version with git tag v1.2.3.
  6. Build, sign, and upload your release with goreleaser release --rm-dist.

-> GoReleaser does not support signing binaries with a GPG key that requires a passphrase. Some systems may cache your GPG passphrase for a few minutes. If you are unable to cache the passphrase for GoReleaser, please use the manual release preparation process below, or remove the signature step from GoReleaser and sign it prior to moving the GitHub release from draft to published.

Manually Preparing a Release

If for some reason you're not able to use GoReleaser to build, sign, and upload your release, you can create the required assets by following these steps, or encode them into a Makefile or shell script.

The release must meet the following criteria:

  • There are 1 or more zip files containing the built provider binary for a single architecture
    • The binary name is terraform-provider-{NAME}_v{VERSION}
    • The archive name is terraform-provider-{NAME}_{VERSION}_{OS}_{ARCH}.zip
  • There is a terraform-provider-{NAME}_{VERSION}_SHA256SUMS file, which contains a sha256 sum for each zip file in the release.
    • shasum -a 256 *.zip > terraform-provider-{NAME}_{VERSION}_SHA256SUMS
  • There is a terraform-provider-{NAME}_{VERSION}_SHA256SUMS.sig file, which is a valid GPG signature of the terraform-provider-{NAME}_{VERSION}_SHA256SUMS file using the keypair.
    • gpg --detach-sign terraform-provider-{NAME}_{VERSION}_SHA256SUMS
  • Release is finalized (not a private draft).

Publishing to the Registry

Creating a Terraform Registry Account

Before publishing a provider, you must first authenticate to the Terraform Registry with a GitHub account. The account must have admin permissions on the provider repository to create the required webhooks for publishing future provider versions.

Click Sign-In to authenticate to the Terraform Registry with your GitHub user account.

Adding Your GPG Signing Key

All provider releases are required to be signed, thus you must provide HashiCorp with the public key for the GPG keypair that you will be signing releases with. The Terraform Registry will validate that the release is signed with this key when publishing each version, and Terraform will verify this during terraform init.

To export your public key in ASCII-armor format, use the following command:

$ gpg --armor --export "{Key ID or email address}"

Individuals

If you would like to publish a provider under your username (not a GitHub organization), you can add your GPG key to the Terraform Registry by visiting User Settings > Signing Keys.

Organizations

In order to publish a provider under a GitHub organization, your public key must be added to the Terraform Registry by a HashiCorp employee. You can email it to terraform-registry@hashicorp.com, or your HashiCorp contact person (if you have one).

Publishing Your provider

In the top-right navigation, select Publish > Provider to begin the publishing process. Follow the prompts to select the organization and repository you would like to publish.