diff --git a/README.md b/README.md index 22ddc320..cabc7eef 100644 --- a/README.md +++ b/README.md @@ -37,30 +37,27 @@ terraform { required_providers { instaclustr = { source = "instaclustr/instaclustr" - version = "1.9.9" + version = ">= 1.0.0, < 2.0.0" } } } -provider "instaclustr" { - # Configuration options -} ``` For further details on Provider installation, and installation on older versions of terraform please see the [Terraform installation guide](https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin). ## Authentication -This provider requires an API Key in order to provision Instaclustr resources. To create an API key, please log into the [Instaclustr Console](https://console.instaclustr.com) or signup for an account [here](https://console.instaclustr.com/user/signup) if you don't have one. Navigate to `Account` -> `API Keys` page, locate the `Provisioning` role and click `Generate Key`. This username and API key combination should be placed into the provider configuration: +This provider requires an API Key in order to provision Instaclustr resources. To create an API key, please log into the [Instaclustr Console](https://console.instaclustr.com) or signup for an account [here](https://console.instaclustr.com/user/signup) if you don't have one. Navigate to `Account Settings` -> `API Keys` page, locate the `Provisioning` role and click `Generate Key`. This username and API key combination should be placed into the provider configuration: ``` provider "instaclustr" { - username = "" - api_key = "" + username= "" + api_key = var.api_key } ``` -If you wish to keep secrets in the ENV instead of stored in your terraform file use the following method: +In order to keep the `api_key` variable secret in the ENV, instead of stored in your terraform file like the `username`, use the following method: In console export the desired variable: @@ -74,13 +71,6 @@ variable "api_key" { } ``` -In the provider block use the variable: -``` -provider "instaclustr" { - username= "" - api_key = var.api_key -} -``` When running terraform plan/apply, pipe in the variables as follows: ```terraform apply -var= "api_key=$api_key"```