Skip to content

keyfactor-pub/terraform-provider-keyfactor

Repository files navigation

Keyfactor Terraform Provider

The Terraform provider enables management of Keyfactor resources utilizing HashiCorp Terraform.

Integration status: Production - Ready for use in production environments.

Support for Keyfactor Terraform Provider

Keyfactor Terraform Provider is open source and supported on best effort level for this tool/library/client. This means customers can report Bugs, Feature Requests, Documentation amendment or questions as well as requests for customer information required for setup that needs Keyfactor access to obtain. Such requests do not follow normal SLA commitments for response or resolution. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com/

To report a problem or suggest a new feature, use the Issues tab. If you want to contribute actual bug fixes or proposed enhancements, use the Pull requests tab.

Usage

Compatibility

Keyfactor Command Version Terraform Provider Version
10.x 2.0.x
9.x 1.0.x

Requirements

  • Go 1.18.x (to build the provider plugin)
  • Terraform 1.1.x
  • Keyfactor Command v10.x
    • Keyfactor Command account with permissions to required Keyfactor features (IE certificate)

Local install

From GitHub

  • Download the latest release from the releases page
  • Unzip the release
  • Move the binary to a location in your local Terraform plugins directory (typically $HOME/.terraform.d/plugins or %APPDATA%\terraform.d\plugins on Windows) for more information refer to the Hashicorp documentation
  • Run terraform init to initialize the provider

From Source

Mac OS/Linux

git clone https://github.com/Keyfactor/terraform-provider-keyfactor.git
cd terraform-provider-keyfactor
make install

Windows

git clone https://github.com/Keyfactor/terraform-provider-keyfactor.git
cd terraform-provider-keyfactor
go build -o %APPDATA%\terraform.d\plugins\keyfactor.com\keyfactor\keyfactor\1.0.3\terraform-provider-keyfactor.exe

Contributing

The Keyfactor Terraform Provider is an open source project. To contribute, see the contribution guidelines. Issues may also be reported.