chore(docs): add environment variables support for secret and token (#47

)
CleverCloud · Nov 23, 2023 · b1e10bb · b1e10bb
1 parent 2d3062d
commit b1e10bb
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Terraform Provider Hashicups
+# Terraform Clever Cloud Provider
 
-This repo is a companion repo to the [Call APIs with Terraform Providers](https://learn.hashicorp.com/collections/terraform/providers) Learn collection.
+The Clever Cloud Provider allows Terraform to manage Clever Cloud resources.
 
 ## Build provider
 

diff --git a/docs/index.md b/docs/index.md
@@ -3,12 +3,12 @@
 page_title: "clevercloud Provider"
 subcategory: ""
 description: |-
-  CleverCloud provider allow you to interract with CleverCloud platform.
+  CleverCloud provider allow you to interact with CleverCloud platform.
 ---
 
 # clevercloud Provider
 
-CleverCloud provider allow you to interract with CleverCloud platform.
+CleverCloud provider allow you to interact with CleverCloud platform.
 
 
 
@@ -22,5 +22,5 @@ CleverCloud provider allow you to interract with CleverCloud platform.
 ### Optional
 
 - `endpoint` (String) CleverCloud API endpoint, default to https://api.clever-cloud.com
-- `secret` (String, Sensitive) CleverCloud OAuth1 secret, can be took from clever-tools after login
-- `token` (String, Sensitive) CleverCloud OAuth1 token, can be took from clever-tools after login
+- `secret` (String, Sensitive) CleverCloud OAuth1 secret, can be took from clever-tools after login. This parameter can also be provided via CC_OAUTH_SECRET environment variable.
+- `token` (String, Sensitive) CleverCloud OAuth1 token, can be took from clever-tools after login. This parameter can also be provided via CC_OAUTH_TOKEN environment variable.
diff --git a/pkg/provider/impl/provider_schema.go b/pkg/provider/impl/provider_schema.go
@@ -35,12 +35,12 @@ func (p *Provider) Schema(_ context.Context, req provider.SchemaRequest, res *pr
 			"token": schema.StringAttribute{
 				Optional:            true, // can be read from ~/.config by client
 				Sensitive:           true,
-				MarkdownDescription: "CleverCloud OAuth1 token, can be took from clever-tools after login",
+				MarkdownDescription: "CleverCloud OAuth1 token, can be took from clever-tools after login. This parameter can also be provided via CC_OAUTH_TOKEN environment variable.",
 			},
 			"secret": schema.StringAttribute{
 				Optional:            true, // // can be read from ~/.config by client
 				Sensitive:           true,
-				MarkdownDescription: "CleverCloud OAuth1 secret, can be took from clever-tools after login",
+				MarkdownDescription: "CleverCloud OAuth1 secret, can be took from clever-tools after login. This parameter can also be provided via CC_OAUTH_SECRET environment variable.",
 			},
 			"organisation": schema.StringAttribute{
 				Sensitive:           true,