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

Fix formatting of the beta configuration guide (#422)

Browse source 
* Fix formatting of the beta configuration guide

* Fix note formatting

* Fix headings in the vault secrets guide
This commit is contained in:
Diogo Ferrão 2024-06-25 10:25:00 +01:00 • committed by GitHub
parent 610b65f1cc
commit 3e2e8e3a45
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 20 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/guides/opting_into_beta_resources.md
View file

@ -3,17 +3,17 @@ page_title: "Configuring Beta Resources in the STACKIT Terraform Provider"
---
# Configuring Beta Resources in the STACKIT Terraform Provider
### Overview
## Overview
This guide explains how to opt into beta resources within the STACKIT Terraform provider. Beta resources are new services and features from STACKIT that are still in development and might not yet have a stable API.
Opting into beta functionality allows users to experiment with new features and services before their official release, without compromising the stability of other resources and the provider itself. However, it's important to remember that beta resources may not be as stable as fully released counterparts, so use them with caution and provide feedback to help improve these services.
### The Process of Opting into the Beta
## The Process of Opting into the Beta
To use beta resources in the STACKIT Terraform provider, you have two options:
#### Option 1: Provider Configuration
### Option 1: Provider Configuration
Set the `enable_beta_resources` option in the provider configuration. This is a boolean attribute that can be either `true` or `false`.
@ -24,7 +24,7 @@ provider "stackit" {
}
```
#### Option 2: Environment Variable
### Option 2: Environment Variable
Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or `"false"`. Other values will be ignored and will produce a warning.
@ -32,12 +32,8 @@ Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or `
export STACKIT_TF_ENABLE_BETA_RESOURCES=true
```
> **Note**: **The environment variable takes precedence over the provider configuration option.**
>
> This means that if the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable is set to a valid value (`"true"` or `"false"`), it will override the `enable_beta_resources` option specified in the provider configuration.
-> The environment variable takes precedence over the provider configuration option. This means that if the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable is set to a valid value (`"true"` or `"false"`), it will override the `enable_beta_resources` option specified in the provider configuration.
### Listing Beta Resources
## Listing Beta Resources
Currently, there are no beta resources available. This section will be updated as new beta services are introduced.
> **Tip**: Check back regularly or refer to the [STACKIT provider documentation](#) for the latest updates on beta resources.
Currently, there are no beta resources available. This section will be updated as new beta services are introduced.

6
docs/guides/vault_secrets_manager.md
View file

@ -3,11 +3,11 @@ page_title: "Using Vault Provider with STACKIT Secrets Manager"
---
# Using Vault Provider with STACKIT Secrets Manager
### Overview
## Overview
This guide outlines the process of utilizing the HashiCorp Vault provider alongside the STACKIT provider to write secrets in the STACKIT Secrets Manager. The guide focuses on secrets from STACKIT Cloud resources but can be adapted for any secret.
### Steps
## Steps
1. **Configure STACKIT Provider**
@ -78,6 +78,6 @@ This guide outlines the process of utilizing the HashiCorp Vault provider alongs
}
```
### Note
## Note
This example can be adapted for various resources within the provider as well as any other Secret the user wants to set in the Secrets Manager instance. Adapting this examples means replacing the Argus Monitoring Grafana password with the appropriate value.

18
templates/guides/opting_into_beta_resources.md.tmpl
View file

@ -3,17 +3,17 @@ page_title: "Configuring Beta Resources in the STACKIT Terraform Provider"
---
# Configuring Beta Resources in the STACKIT Terraform Provider
### Overview
## Overview
This guide explains how to opt into beta resources within the STACKIT Terraform provider. Beta resources are new services and features from STACKIT that are still in development and might not yet have a stable API.
Opting into beta functionality allows users to experiment with new features and services before their official release, without compromising the stability of other resources and the provider itself. However, it's important to remember that beta resources may not be as stable as fully released counterparts, so use them with caution and provide feedback to help improve these services.
### The Process of Opting into the Beta
## The Process of Opting into the Beta
To use beta resources in the STACKIT Terraform provider, you have two options:
#### Option 1: Provider Configuration
### Option 1: Provider Configuration
Set the `enable_beta_resources` option in the provider configuration. This is a boolean attribute that can be either `true` or `false`.
@ -24,7 +24,7 @@ provider "stackit" {
}
```
#### Option 2: Environment Variable
### Option 2: Environment Variable
Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or `"false"`. Other values will be ignored and will produce a warning.
@ -32,12 +32,8 @@ Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or `
export STACKIT_TF_ENABLE_BETA_RESOURCES=true
```
> **Note**: **The environment variable takes precedence over the provider configuration option.**
>
> This means that if the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable is set to a valid value (`"true"` or `"false"`), it will override the `enable_beta_resources` option specified in the provider configuration.
-> The environment variable takes precedence over the provider configuration option. This means that if the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable is set to a valid value (`"true"` or `"false"`), it will override the `enable_beta_resources` option specified in the provider configuration.
### Listing Beta Resources
## Listing Beta Resources
Currently, there are no beta resources available. This section will be updated as new beta services are introduced.
> **Tip**: Check back regularly or refer to the [STACKIT provider documentation](#) for the latest updates on beta resources.
Currently, there are no beta resources available. This section will be updated as new beta services are introduced.

6
templates/guides/vault_secrets_manager.md.tmpl
View file

@ -3,11 +3,11 @@ page_title: "Using Vault Provider with STACKIT Secrets Manager"
---
# Using Vault Provider with STACKIT Secrets Manager
### Overview
## Overview
This guide outlines the process of utilizing the HashiCorp Vault provider alongside the STACKIT provider to write secrets in the STACKIT Secrets Manager. The guide focuses on secrets from STACKIT Cloud resources but can be adapted for any secret.
### Steps
## Steps
1. **Configure STACKIT Provider**
@ -78,6 +78,6 @@ This guide outlines the process of utilizing the HashiCorp Vault provider alongs
}
```
### Note
## Note
This example can be adapted for various resources within the provider as well as any other Secret the user wants to set in the Secrets Manager instance. Adapting this examples means replacing the Argus Monitoring Grafana password with the appropriate value.