stackit-dev-tools/terraform-provider-stackitprivatepreview
2
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Update docs (#113)

Browse source 
* Update docs

* Update docs

---------

Co-authored-by: Henrique Santos <henrique.santos@freiheit.com>
This commit is contained in:
Henrique Santos 2023-10-27 15:49:05 +01:00 • committed by GitHub
parent 8f5850cdf1
commit fc8d2663cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 1 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/index.md
View file

@ -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 <path/to/sa_key_pem_file> > 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 generated by tfplugindocs -->
## Schema
### Optional

2
templates/index.md.tmpl
View file

@ -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)