From b1e10bb86b26e3a6115c2612ad59186de97b080f Mon Sep 17 00:00:00 2001 From: Julien WITTOUCK Date: Thu, 23 Nov 2023 15:42:00 +0100 Subject: [PATCH] chore(docs): add environment variables support for secret and token (#47) --- README.md | 4 ++-- docs/index.md | 8 ++++---- pkg/provider/impl/provider_schema.go | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 87af1b6..36356c8 100644 --- 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 index 040cee0..a46c1f3 100644 --- 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 index 09d76e3..2b0ae8e 100644 --- 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,