From 2d9d130d0e174b6bfe3838128f4a17b4a87827fb Mon Sep 17 00:00:00 2001 From: "Marcel S. Henselin" Date: Tue, 10 Feb 2026 13:46:12 +0100 Subject: [PATCH] fix: fix README.md --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 018f615e..ab79f28e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@
-
STACKIT logo -
-
-# STACKIT Terraform Provider (PRIVATE PREVIEW) +# STACKIT Terraform Provider
(PRIVATE PREVIEW) [![GitHub Release](https://img.shields.io/github/v/release/stackitcloud/terraform-provider-stackit)](https://registry.terraform.io/providers/stackitcloud/stackit/latest) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/stackitcloud/terraform-provider-stackit) [![GitHub License](https://img.shields.io/github/license/stackitcloud/terraform-provider-stackit)](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 @@ -18,20 +17,22 @@ To install the [STACKIT Terraform Provider](https://registry.terraform.io/provid ```hcl terraform { required_providers { - stackit = { - source = "stackitcloud/stackit" - version = "X.X.X" + stackitprivatepreview = { + source = "tfregistry.sysops.stackit.rocks/mhenselin/stackitprivatepreview" + version = "= 0.0.5-alpha" } } } -provider "stackit" { +provider "stackitprivatepreview" { # Configuration options } ``` Check one of the examples in the [examples](examples/) folder. +TODO: revise the following sections + ## 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: -- 2.49.1