Deprecate stackit_loadbalancer_credential and add new stackit_loadbalancer_observability_credential (#357)

* Copy over old resource files

* Adjustments to the new observability credential resource.go

* Register new resource in the provider

* Add example

* Adapt acc test

* Update docs

* Add deprecation message

* Fix linter

* Add deprecation message to dscription

Author: joaopalet

docs/index.md

@@ -1,6 +1,6 @@
-# STACKIT Provider
+# STACKIT Terraform Provider
 
-The STACKIT provider is the official Terraform provider to integrate all the resources developed by STACKIT.
+The STACKIT Terraform provider is the official Terraform provider to integrate all the resources developed by [STACKIT](https://www.stackit.de/en/).
 
 ## Example Usage
 
@@ -34,14 +34,14 @@ provider "stackit" {
 
 ## Authentication
 
-To authenticate, you will need a [service account](https://docs.stackit.cloud/stackit/en/service-accounts-134415819.html). Create it in the STACKIT Portal an assign it the necessary permissions, e.g. `project.owner`. There are multiple ways to authenticate:
+To authenticate, you will need a [service account](https://docs.stackit.cloud/stackit/en/service-accounts-134415819.html). Create it in the [STACKIT Portal](https://portal.stackit.cloud/) and assign it the necessary permissions, e.g. `project.owner`. There are multiple ways to authenticate:
 
 - Key flow (recommended)
 - Token flow
 
 When setting up authentication, the provider will always try to use the key flow first and search for credentials in several locations, following a specific order:
 
-1. Explicit configuration, e.g. by seting the field `stackit_service_account_key_path` in the provider block (see example below)
+1. Explicit configuration, e.g. by setting the field `stackit_service_account_key_path` in the provider block (see example below)
 2. Environment variable, e.g. by setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH`
 3. Credentials file
 

docs/resources/loadbalancer_credential.md

@@ -4,12 +4,15 @@ page_title: "stackit_loadbalancer_credential Resource - stackit"
 subcategory: ""
 description: |-
   Load balancer credential resource schema. Must have a region specified in the provider configuration.
+  !> The stackit_loadbalancer_credential resource has been deprecated and will be removed after November 13th 2024. Please use stackit_loadbalancer_observability_credential instead, which offers the exact same functionality.
 ---
 
 # stackit_loadbalancer_credential (Resource)
 
 Load balancer credential resource schema. Must have a `region` specified in the provider configuration.
 
+!> The `stackit_loadbalancer_credential` resource has been deprecated and will be removed after November 13th 2024. Please use `stackit_loadbalancer_observability_credential` instead, which offers the exact same functionality.
+
 ## Example Usage
 
 ```terraform

docs/resources/loadbalancer_observability_credential.md

@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stackit_loadbalancer_observability_credential Resource - stackit"
+subcategory: ""
+description: |-
+  Load balancer observability credential resource schema. Must have a region specified in the provider configuration. These contain the username and password for the observability service (e.g. Argus) where the load balancer logs/metrics will be pushed into
+---
+
+# stackit_loadbalancer_observability_credential (Resource)
+
+Load balancer observability credential resource schema. Must have a `region` specified in the provider configuration. These contain the username and password for the observability service (e.g. Argus) where the load balancer logs/metrics will be pushed into
+
+## Example Usage
+
+```terraform
+resource "stackit_loadbalancer_observability_credential" "example" {
+  project_id   = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  display_name = "example-credentials"
+  username     = "example-user"
+  password     = "example-password"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `display_name` (String) Observability credential name.
+- `password` (String) The username for the observability service (e.g. Argus) where the logs/metrics will be pushed into.
+- `project_id` (String) STACKIT project ID to which the load balancer observability credential is associated.
+- `username` (String) The password for the observability service (e.g. Argus) where the logs/metrics will be pushed into.
+
+### Read-Only
+
+- `credentials_ref` (String) The credentials reference is used by the Load Balancer to define which credentials it will use.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`","`credentials_ref`".

examples/resources/stackit_loadbalancer_observability_credential/resource.tf

@@ -0,0 +1,6 @@
+resource "stackit_loadbalancer_observability_credential" "example" {
+  project_id   = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  display_name = "example-credentials"
+  username     = "example-user"
+  password     = "example-password"
+}

stackit/internal/services/loadbalancer/credential/resource.go

@@ -102,10 +102,15 @@ func (r *credentialResource) Schema(_ context.Context, _ resource.SchemaRequest,
 		"display_name":    "Credential name.",
 		"username":        "The username used for the ARGUS instance.",
 		"password":        "The password used for the ARGUS instance.",
+		"deprecation_message": "The `stackit_loadbalancer_credential` resource has been deprecated and will be removed after November 13th 2024. " +
+			"Please use `stackit_loadbalancer_observability_credential` instead, which offers the exact same functionality.",
 	}
 
 	resp.Schema = schema.Schema{
-		Description: descriptions["main"],
+		Description: fmt.Sprintf("%s\n%s", descriptions["main"], descriptions["deprecation_message"]),
+		// Callout block: https://developer.hashicorp.com/terraform/registry/providers/docs#callouts
+		MarkdownDescription: fmt.Sprintf("%s\n\n!> %s", descriptions["main"], descriptions["deprecation_message"]),
+		DeprecationMessage:  descriptions["deprecation_message"],
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				Description: descriptions["id"],

stackit/internal/services/loadbalancer/loadbalancer_acc_test.go

@@ -94,7 +94,7 @@ func configResources(targetPort string) string {
 			}
 		}
 
-		resource "stackit_loadbalancer_credential" "credential" {
+		resource "stackit_loadbalancer_observability_credential" "credential" {
 			project_id   = "%s"
 			display_name = "%s"
 			username     = "%s"
@@ -245,13 +245,13 @@ func TestAccLoadBalancerResource(t *testing.T) {
 
 					// Credential
 					resource.TestCheckResourceAttrPair(
-						"stackit_loadbalancer_credential.credential", "project_id",
+						"stackit_loadbalancer_observability_credential.credential", "project_id",
 						"stackit_loadbalancer.loadbalancer", "project_id",
 					),
-					resource.TestCheckResourceAttrSet("stackit_loadbalancer_credential.credential", "credentials_ref"),
-					resource.TestCheckResourceAttr("stackit_loadbalancer_credential.credential", "display_name", loadBalancerResource["credential_display_name"]),
-					resource.TestCheckResourceAttr("stackit_loadbalancer_credential.credential", "username", loadBalancerResource["credential_username"]),
-					resource.TestCheckResourceAttr("stackit_loadbalancer_credential.credential", "password", loadBalancerResource["credential_password"]),
+					resource.TestCheckResourceAttrSet("stackit_loadbalancer_observability_credential.credential", "credentials_ref"),
+					resource.TestCheckResourceAttr("stackit_loadbalancer_observability_credential.credential", "display_name", loadBalancerResource["credential_display_name"]),
+					resource.TestCheckResourceAttr("stackit_loadbalancer_observability_credential.credential", "username", loadBalancerResource["credential_username"]),
+					resource.TestCheckResourceAttr("stackit_loadbalancer_observability_credential.credential", "password", loadBalancerResource["credential_password"]),
 				),
 			},
 			// Data source
@@ -318,11 +318,11 @@ func TestAccLoadBalancerResource(t *testing.T) {
 				ImportStateVerify: true,
 			},
 			{
-				ResourceName: "stackit_loadbalancer_credential.credential",
+				ResourceName: "stackit_loadbalancer_observability_credential.credential",
 				ImportStateIdFunc: func(s *terraform.State) (string, error) {
-					r, ok := s.RootModule().Resources["stackit_loadbalancer_credential.credential"]
+					r, ok := s.RootModule().Resources["stackit_loadbalancer_observability_credential.credential"]
 					if !ok {
-						return "", fmt.Errorf("couldn't find resource stackit_loadbalancer_credential.credential")
+						return "", fmt.Errorf("couldn't find resource stackit_loadbalancer_observability_credential.credential")
 					}
 					credentialsRef, ok := r.Primary.Attributes["credentials_ref"]
 					if !ok {