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

Add disclaimer to key flow doc (#73)

Browse source 
* Add disclaimer to key flow doc

* Fix wrong options
This commit is contained in:
Vicente Pinto 2023-10-10 09:54:21 +01:00 • committed by GitHub
parent 590d169c68
commit 9ec45e6be8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -34,6 +34,7 @@ When setting up authentication, the provider will always try to use the key flow
## Key flow
To use the key flow, you need to have a service account key and an RSA key-pair.
To configure it, follow this steps:
The following instructions assume that you have created a service account and assigned it the necessary permissions, e.g. project.owner.
@ -42,6 +43,8 @@ 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.

2
templates/index.md.tmpl
View file

@ -42,6 +42,8 @@ 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.