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

Add template for provider main page (#17)

Browse source 
* Add template

* Generate docs

---------

Co-authored-by: Henrique Santos <henrique.santos@freiheit.com>
This commit is contained in:
Henrique Santos 2023-09-11 17:58:17 +01:00 • committed by GitHub
parent 52d7b3c040
commit 78dcc66e5e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/index.md
View file

@ -1,20 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit Provider"
subcategory: ""
description: |-
---
# stackit Provider
# STACKIT Provider
The STACKIT provider is the official Terraform provider to integrate all the resources developed by STACKIT.
# Authentication
Currently, only the *token flow* is supported. The Terraform provider will first try to find a token in the `STACKIT_SERVICE_ACCOUNT_TOKEN` env var. If not present, it 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. If the token is found, all the requests are authenticated using that token.
## Example Usage
```terraform
@ -23,6 +10,10 @@ provider "stackit" {
}
```
## Authentication
Currently, only the *token flow* is supported. The Terraform provider will first try to find a token in the `STACKIT_SERVICE_ACCOUNT_TOKEN` env var. If not present, it 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. If the token is found, all the requests are authenticated using that token.
<!-- schema generated by tfplugindocs -->
## Schema

13
templates/index.md.tmpl Normal file
View file

@ -0,0 +1,13 @@
# {{ .ProviderShortName | upper }} Provider
The STACKIT provider is the official Terraform provider to integrate all the resources developed by STACKIT.
## Example Usage
{{ tffile "examples/provider/provider.tf" }}
## Authentication
Currently, only the *token flow* is supported. The Terraform provider will first try to find a token in the `STACKIT_SERVICE_ACCOUNT_TOKEN` env var. If not present, it 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. If the token is found, all the requests are authenticated using that token.
{{ .SchemaMarkdown | trimspace }}