When omitting the email_config in observabilit_instance the fields for smtpSmarthome and smtpAuthIdentity are still validated

[eBeyond]

Description

When running apply on an stackit_observability_instance it complains about wrongly formatted smtpAuthIdentity and smtpSmarthost. They're both not there, because we're not unsing email for alerting.
In the documentation it's stated that the email_config is optional. As such I would expect that even the configuration for it is obsolete. :)

Steps to reproduce

resource "stackit_observability_instance" "default" {
  project_id = var.project_id
  name       = var.name
  plan_name  = "Observability-Large-EU01"

  alert_config = {
    receivers = [{
      name = local.observability_alert_receiver_google_name
      webhooks_configs = [{
        google_chat   = true
        url           = var.google_chat_webhook_url
        send_resolved = true
      }]
      },
      {
        name = local.observability_alert_receiver_opsgenie_name

        opsgenie_configs = [{
          api_key       = var.opsgenie_api_key
          send_resolved = true
        }]
      }
    ]
    route = {
      receiver        = local.observability_alert_receiver_google_name
      group_by        = ["cluster", "severity"]
      group_interval  = "5m"
      group_wait      = "30s"
      repeat_interval = "4h"
      routes = [
        {
          receiver = local.observability_alert_receiver_opsgenie_name
          matchers = [
            "severity=\"critical\""
          ]

        }
      ]
    }
  }

Actual behavior

When running plan and apply it's showing this:

╷
│ Error: Error updating instance
│ 
│   with module.provider_cluster.stackit_observability_instance.default,
│   on ../../modules/provider_cluster/observability.tf line 6, in resource "stackit_observability_instance" "default":
│    6: resource "stackit_observability_instance" "default" {
│ 
│ Setting alert config: json: cannot unmarshal object into Go struct field Error.errors of type []map[string]string, status code 400, Body: {"message":"Alert config is not
│ valid","errors":{"global":{"smtpSmarthost":["***** is not in the allowed characters: a-zA-Z0-9_./@&?:=%-"],"smtpAuthIdentity":["Enter a valid email address."]}}}
│ 
╵

It's notable that within the plan phase no changes to the alert configuration related to email are shown. This issue only comes up within the apply phase.

Expected behavior

stackit_observability_instance should ignore the settings within the configs if they're not used.

Environment

• OS: macos
• Tofu version (see tofu version): v1.10.7
• Version of the STACKIT Terraform provider: v0.71.0

[marceljk]

Hi @eBeyond,

thank you for reporting this issue!
Unfortunately, I couldn't reproduce it. In the error message I see, that the error occurs during an update.
Can you provide us with the information, what was changed to trigger the Update? This can help us to reproduce it.

Best regards
Marcel from the STACKIT Developer Tools Team

[eBeyond]

Hi Marcel,

I've added the configuration related to opsgenie. But also in advance, if we had added the webhook for google-chat, it was occuring, until we haven't excluded the global in the lifecycle. When using opsgenie the exlclude-global doesn't have any affect any more.
This issue is related to the api giving "****" back for the smtp* Attributes when the alert_config is requested. (even if they aren't used) The returned value from the api is checked by terraform. This seems to be the point where the error arrises. It seems that even if I configure the opsgenie api key in another point than the globals, the globals seems to be used.
From my point, the returned values from the API should be ignored not validated. The values which are in use by the resources (behind the API), shouldn't validated, they should be correct. If the API is returning masked values, there is no way to compare them to new or probably new values, as such they can be safely ignored.

Best regards
Marc