The Terraform Okta provider is a plugin for Terraform that allows for the full lifecycle management of Okta resources. This provider is maintained internally by the Okta development team.
All the resources and data sources has one or more examples to give you an idea of how to use this provider to build your own Okta infrastructure. Provider's official documentation is located in the official terraform registry, or here in form of raw markdown files.
The sections below will guide you through the requirements, upgrading, getting started, building with and contributing to the Okta Terraform Provider.
If you have been using version 3.x of the Okta Terraform Provider, please upgrade to the latest version to take advantage of all the new features, fixes, and functionality. Please refer to this Upgrade Guide for guidance on how to upgrade to version 4.x. Also, please check our Releases page for more details on major, minor, and patch updates.
If you wish to work on the provider, you'll first need Go installed on your machine (please check the requirements before proceeding).
Note: This project uses Go Modules making it safe to work with it outside
your existing GOPATH. The instructions that follow assume a directory in your
home directory outside the standard GOPATH (i.e $HOME/development/terraform-providers/).
Clone repository to: $HOME/development/terraform-providers/
$ mkdir -p $HOME/development/terraform-providers/; cd $HOME/development/terraform-providers/
$ git clone git@github.com:okta/terraform-provider-okta.git
...Enter the provider directory and run make tools. This will install the needed tools for the provider.
$ make toolsTo compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin
directory.
$ make build
...
$ $GOPATH/bin/terraform-provider-okta
...In order to test the provider, you can run make test.
$ make testIn order to run the full suite of Acceptance tests, run make testacc.
Note: Acceptance tests create real resources, and often cost money to run. Please read Running an Acceptance Test in the contribution guidelines for more information on usage.
$ make testaccTo use a released provider in your Terraform environment,
run terraform init and Terraform will automatically install the
provider. To specify a particular provider version when installing released providers, see
the Terraform documentation on provider versioning
.
To instead use a custom-built provider in your Terraform environment (e.g. the provider binary from the build
instructions above), follow the instructions
to install it as a plugin. After placing the
custom-built provider into your plugins' directory, run terraform init to initialize it.
For either installation method, documentation about the provider specific configuration options can be found on the provider's website.
Terraform is the work of thousands of contributors. We really appreciate your help!
We have these minimum requirements for source code contributions.
Bug fix pull requests must include:
Pull requests with new resources and data sources must include:
- Signed Okta Individual Contributor License Agreement emailed to
CLA@okta.com - Implemented with the Terraform Plugin Framework (not Terraform Plugin SDKv2 )
- Make Okta API calls with the okta-sdk-golang v3 client
- Include Terraform Plugin Acceptance Tests
Please see the contribution guidelines for additional information about making contributions to the Okta Terraform Provider.
Issues on GitHub are intended to be related to the bugs or feature requests with provider codebase. See Plugin SDK Community and Discuss forum for a list of community resources to ask questions about Terraform.