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

Update docs (#352)

Browse source
This commit is contained in:
Vicente Pinto 2024-05-03 15:11:28 +01:00 • committed by GitHub
parent 035efbd309
commit 49b585923b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -38,7 +38,7 @@ When setting up authentication, the provider will always try to use the key flow
2. Environment variable, e.g. by setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` 2. Environment variable, e.g. by setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH`
3. Credentials file 3. Credentials file
The SDK will check the credentials file located in the path defined by the `STACKIT_CREDENTIALS_PATH` env var, if specified, The provider will check the credentials file located in the path defined by the `STACKIT_CREDENTIALS_PATH` env var, if specified,
or in `$HOME/.stackit/credentials.json` as a fallback. or in `$HOME/.stackit/credentials.json` as a fallback.
The credentials file should be a json and each credential should be set using the name of the respective environment variable, as stated below in each flow. Example: The credentials file should be a json and each credential should be set using the name of the respective environment variable, as stated below in each flow. Example:
@ -89,7 +89,7 @@ To configure the key flow, follow this steps:
} }
``` ```
3. Configure the service account key for authentication in the SDK by following one of the alternatives below: 3. Configure the service account key for authentication in the provider by following one of the alternatives below:
- setting the fiels in the provider block: `service_account_key` or `service_account_key_path` - setting the fiels in the provider block: `service_account_key` or `service_account_key_path`
- setting the environment variable: `STACKIT_SERVICE_ACCOUNT_KEY_PATH` - setting the environment variable: `STACKIT_SERVICE_ACCOUNT_KEY_PATH`

4
docs/index.md
View file

@ -45,7 +45,7 @@ When setting up authentication, the provider will always try to use the key flow
2. Environment variable, e.g. by setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` 2. Environment variable, e.g. by setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH`
3. Credentials file 3. Credentials file
The SDK will check the credentials file located in the path defined by the `STACKIT_CREDENTIALS_PATH` env var, if specified, The provider will check the credentials file located in the path defined by the `STACKIT_CREDENTIALS_PATH` env var, if specified,
or in `$HOME/.stackit/credentials.json` as a fallback. or in `$HOME/.stackit/credentials.json` as a fallback.
The credentials should be set using the same name as the environment variables. Example: The credentials should be set using the same name as the environment variables. Example:
@ -94,7 +94,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 by following one of the alternatives below: 3. Configure the service account key and private key for authentication in the provider 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 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 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) - setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH` in the credentials file (see above)

2
docs/resources/ske_cluster.md
View file

@ -16,7 +16,7 @@ SKE Cluster Resource schema. Must have a `region` specified in the provider conf
resource "stackit_ske_cluster" "example" { resource "stackit_ske_cluster" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
name = "example" name = "example"
kubernetes_version = "1.25" kubernetes_version = "x.x"
node_pools = [ node_pools = [
{ {
name = "np-example" name = "np-example"

2
examples/resources/stackit_ske_cluster/resource.tf
View file

@ -1,7 +1,7 @@
resource "stackit_ske_cluster" "example" { resource "stackit_ske_cluster" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
name = "example" name = "example"
kubernetes_version = "1.25" kubernetes_version = "x.x"
node_pools = [ node_pools = [
{ {
name = "np-example" name = "np-example"

4
templates/index.md.tmpl
View file

@ -19,7 +19,7 @@ When setting up authentication, the provider will always try to use the key flow
2. Environment variable, e.g. by setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` 2. Environment variable, e.g. by setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH`
3. Credentials file 3. Credentials file
The SDK will check the credentials file located in the path defined by the `STACKIT_CREDENTIALS_PATH` env var, if specified, The provider will check the credentials file located in the path defined by the `STACKIT_CREDENTIALS_PATH` env var, if specified,
or in `$HOME/.stackit/credentials.json` as a fallback. or in `$HOME/.stackit/credentials.json` as a fallback.
The credentials should be set using the same name as the environment variables. Example: The credentials should be set using the same name as the environment variables. Example:
@ -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 by following one of the alternatives below: 3. Configure the service account key and private key for authentication in the provider 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 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 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) - setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH` in the credentials file (see above)