78dcc66e5e
* Add template * Generate docs --------- Co-authored-by: Henrique Santos <henrique.santos@freiheit.com>
36 lines
2.1 KiB
Markdown
36 lines
2.1 KiB
Markdown
# STACKIT Provider
|
|
|
|
The STACKIT provider is the official Terraform provider to integrate all the resources developed by STACKIT.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
provider "stackit" {
|
|
region = "eu01"
|
|
}
|
|
```
|
|
|
|
## 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
|
|
|
|
### Optional
|
|
|
|
- `argus_custom_endpoint` (String) Custom endpoint for the Argus service
|
|
- `credentials_path` (String) Path of JSON from where the credentials are read. Takes precedence over the env var `STACKIT_CREDENTIALS_PATH`. Default value is `~/.stackit/credentials.json`.
|
|
- `dns_custom_endpoint` (String) Custom endpoint for the DNS service
|
|
- `logme_custom_endpoint` (String) Custom endpoint for the LogMe service
|
|
- `mariadb_custom_endpoint` (String) Custom endpoint for the MariaDB service
|
|
- `opensearch_custom_endpoint` (String) Custom endpoint for the OpenSearch service
|
|
- `postgresflex_custom_endpoint` (String) Custom endpoint for the PostgresFlex service
|
|
- `postgresql_custom_endpoint` (String) Custom endpoint for the PostgreSQL service
|
|
- `rabbitmq_custom_endpoint` (String) Custom endpoint for the RabbitMQ service
|
|
- `redis_custom_endpoint` (String)
|
|
- `region` (String) Region will be used as the default location for regional services. Not all services require a region, some are global
|
|
- `resourcemanager_custom_endpoint` (String) Custom endpoint for the Resource Manager service
|
|
- `service_account_email` (String) Service account email. It can also be set using the environment variable STACKIT_SERVICE_ACCOUNT_EMAIL
|
|
- `service_account_token` (String) Token used for authentication. If set, the token flow will be used to authenticate all operations.
|
|
- `ske_custom_endpoint` (String) Custom endpoint for the Kubernetes Engine (SKE) service
|