From fc8d2663cdfaafb92087a4f423c5c67cfb8e6e6f Mon Sep 17 00:00:00 2001 From: Henrique Santos <118177985+hcsa73@users.noreply.github.com> Date: Fri, 27 Oct 2023 15:49:05 +0100 Subject: [PATCH] Update docs (#113) * Update docs * Update docs --------- Co-authored-by: Henrique Santos --- docs/index.md | 3 --- templates/index.md.tmpl | 2 +- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 46e2e4ca..9a0bf3cc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -68,8 +68,6 @@ To configure it, follow this steps: - You can create your own RSA key-pair or have the Portal generate one for you. -**Disclaimer:** as of now, creation of a service account key in the Portal is only available in DEV and QA environments. You can use this flow in these environments by setting the fields `token_custom_endpoint` and `jwks_custom_endpoint` to the corresponding endpoints in the provider block. - 2. Save the content of the service account key and the corresponding private key by copying them or saving them in a file. **Hint:** If you have generated the RSA key-pair using the Portal, you can save the private key in a PEM encoded file by downloading the service account key as a PEM file and using `openssl storeutl -keys > private.key` to extract the private key from the service account key. @@ -110,7 +108,6 @@ Using this flow is less secure since the token is long-lived. You can provide th 3. Setting it in the credentials file (see above) - ## Schema ### Optional diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index e5925a42..23b59e75 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -68,7 +68,7 @@ The expected format of the service account key is a **json** with the following } ``` -3. Configure the service account key and private key for authentication in the SDK: +3. Configure the service account key and private key for authentication in the SDK by following one of the alternatives below: - setting the fiels in the provider block: `service_account_key` or `service_account_key_path`, `private_key` or `private_key_path` - setting environment variables: `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH` - setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH` in the credentials file (see above)