fix: fix README.md (#42)
## Description
<!-- **Please link some issue here describing what you are trying to achieve.**
In case there is no issue present for your PR, please consider creating one.
At least please give us some description what you are trying to achieve and why your change is needed. -->
relates to #1234
## Checklist
- [ ] Issue was linked above
- [ ] Code format was applied: `make fmt`
- [ ] Examples were added / adjusted (see `examples/` directory)
- [x] Docs are up-to-date: `make generate-docs` (will be checked by CI)
- [ ] Unit tests got implemented or updated
- [ ] Acceptance tests got implemented or updated (see e.g. [here](f5f99d1709/stackit/internal/services/dns/dns_acc_test.go))
- [x] Unit tests are passing: `make test` (will be checked by CI)
- [x] No linter issues: `make lint` (will be checked by CI)
Reviewed-on: #42
Reviewed-by: Andre_Harms <andre.harms@stackit.cloud>
This commit is contained in:
parent
9dbf36dd35
commit
b737875c68
1 changed files with 10 additions and 9 deletions
19
README.md
19
README.md
|
|
@ -1,15 +1,14 @@
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<br>
|
|
||||||
<img src=".github/images/stackit-logo.svg" alt="STACKIT logo" width="50%"/>
|
<img src=".github/images/stackit-logo.svg" alt="STACKIT logo" width="50%"/>
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# STACKIT Terraform Provider (PRIVATE PREVIEW)
|
# STACKIT Terraform Provider <br />(PRIVATE PREVIEW)
|
||||||
|
|
||||||
[](https://registry.terraform.io/providers/stackitcloud/stackit/latest)  [](https://www.apache.org/licenses/LICENSE-2.0)
|
[](https://registry.terraform.io/providers/stackitcloud/stackit/latest)  [](https://www.apache.org/licenses/LICENSE-2.0)
|
||||||
|
|
||||||
This project is the official [Terraform Provider](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs) for [STACKIT](https://www.stackit.de/en/), which allows you to manage STACKIT resources through Terraform.
|
This project is the **NOT** official [Terraform Provider](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs) for [STACKIT](https://www.stackit.de/en/)!
|
||||||
|
|
||||||
|
This a **private preview only**, which allows you to manage STACKIT resources through Terraform.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
|
|
@ -18,20 +17,22 @@ To install the [STACKIT Terraform Provider](https://registry.terraform.io/provid
|
||||||
```hcl
|
```hcl
|
||||||
terraform {
|
terraform {
|
||||||
required_providers {
|
required_providers {
|
||||||
stackit = {
|
stackitprivatepreview = {
|
||||||
source = "stackitcloud/stackit"
|
source = "tfregistry.sysops.stackit.rocks/mhenselin/stackitprivatepreview"
|
||||||
version = "X.X.X"
|
version = "= 0.0.5-alpha"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
provider "stackit" {
|
provider "stackitprivatepreview" {
|
||||||
# Configuration options
|
# Configuration options
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Check one of the examples in the [examples](examples/) folder.
|
Check one of the examples in the [examples](examples/) folder.
|
||||||
|
|
||||||
|
<big font-size="3rem">TODO: revise the following sections</big>
|
||||||
|
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
To authenticate, you will need a [service account](https://docs.stackit.cloud/platform/access-and-identity/service-accounts/). Create it in the [STACKIT Portal](https://portal.stackit.cloud/) and assign the necessary permissions to it, e.g. `project.owner`. There are multiple ways to authenticate:
|
To authenticate, you will need a [service account](https://docs.stackit.cloud/platform/access-and-identity/service-accounts/). Create it in the [STACKIT Portal](https://portal.stackit.cloud/) and assign the necessary permissions to it, e.g. `project.owner`. There are multiple ways to authenticate:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue