stackit-dev-tools/terraform-provider-stackitprivatepreview
3
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

feat(observability): add send_resolved field (#935)

Browse source 
relates to STACKITTPR-283
This commit is contained in:
Ruben Hönle 2025-09-12 17:28:50 +02:00 • committed by GitHub
parent b1e97e92f9
commit 4b46119433
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 110 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

12
stackit/internal/services/observability/instance/datasource.go
View file

@ -220,6 +220,10 @@ func (d *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques
Description: "The sender email address. Must be a valid email address",
Computed: true,
},
"send_resolved": schema.BoolAttribute{
Description: "Whether to notify about resolved alerts.",
Computed: true,
},
"smart_host": schema.StringAttribute{
Description: "The SMTP host through which emails are sent.",
Computed: true,
@ -252,6 +256,10 @@ func (d *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques
Description: "Priority of the alert. " + utils.FormatPossibleValues([]string{"P1", "P2", "P3", "P4", "P5"}...),
Computed: true,
},
"send_resolved": schema.BoolAttribute{
Description: "Whether to notify about resolved alerts.",
Computed: true,
},
},
},
},
@ -273,6 +281,10 @@ func (d *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques
Description: "Google Chat webhooks require special handling, set this to true if the webhook is for Google Chat.",
Computed: true,
},
"send_resolved": schema.BoolAttribute{
Description: "Whether to notify about resolved alerts.",
Computed: true,
},
},
},
},

84
stackit/internal/services/observability/instance/resource.go
View file

@ -188,6 +188,7 @@ type emailConfigsModel struct {
AuthPassword types.String `tfsdk:"auth_password"`
AuthUsername types.String `tfsdk:"auth_username"`
From types.String `tfsdk:"from"`
SendResolved types.Bool `tfsdk:"send_resolved"`
Smarthost types.String `tfsdk:"smart_host"`
To types.String `tfsdk:"to"`
}
@ -197,36 +198,41 @@ var emailConfigsTypes = map[string]attr.Type{
"auth_password": types.StringType,
"auth_username": types.StringType,
"from": types.StringType,
"send_resolved": types.BoolType,
"smart_host": types.StringType,
"to": types.StringType,
}
// Struct corresponding to Model.AlertConfig.receivers.opsGenieConfigs
type opsgenieConfigsModel struct {
ApiKey types.String `tfsdk:"api_key"`
ApiUrl types.String `tfsdk:"api_url"`
Tags types.String `tfsdk:"tags"`
Priority types.String `tfsdk:"priority"`
ApiKey types.String `tfsdk:"api_key"`
ApiUrl types.String `tfsdk:"api_url"`
Tags types.String `tfsdk:"tags"`
Priority types.String `tfsdk:"priority"`
SendResolved types.Bool `tfsdk:"send_resolved"`
}
var opsgenieConfigsTypes = map[string]attr.Type{
"api_key": types.StringType,
"api_url": types.StringType,
"tags": types.StringType,
"priority": types.StringType,
"api_key": types.StringType,
"api_url": types.StringType,
"tags": types.StringType,
"priority": types.StringType,
"send_resolved": types.BoolType,
}
// Struct corresponding to Model.AlertConfig.receivers.webHooksConfigs
type webHooksConfigsModel struct {
Url types.String `tfsdk:"url"`
MsTeams types.Bool `tfsdk:"ms_teams"`
GoogleChat types.Bool `tfsdk:"google_chat"`
Url types.String `tfsdk:"url"`
MsTeams types.Bool `tfsdk:"ms_teams"`
GoogleChat types.Bool `tfsdk:"google_chat"`
SendResolved types.Bool `tfsdk:"send_resolved"`
}
var webHooksConfigsTypes = map[string]attr.Type{
"url": types.StringType,
"ms_teams": types.BoolType,
"google_chat": types.BoolType,
"url": types.StringType,
"ms_teams": types.BoolType,
"google_chat": types.BoolType,
"send_resolved": types.BoolType,
}
var routeDescriptions = map[string]string{
@ -629,6 +635,10 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
Description: "The sender email address. Must be a valid email address",
Optional: true,
},
"send_resolved": schema.BoolAttribute{
Description: "Whether to notify about resolved alerts.",
Optional: true,
},
"smart_host": schema.StringAttribute{
Description: "The SMTP host through which emails are sent.",
Optional: true,
@ -664,6 +674,10 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
Description: "Priority of the alert. " + utils.FormatPossibleValues("P1", "P2", "P3", "P4", "P5"),
Optional: true,
},
"send_resolved": schema.BoolAttribute{
Description: "Whether to notify about resolved alerts.",
Optional: true,
},
},
},
},
@ -695,6 +709,10 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
Computed: true,
Default: booldefault.StaticBool(false),
},
"send_resolved": schema.BoolAttribute{
Description: "Whether to notify about resolved alerts.",
Optional: true,
},
},
},
},
@ -1490,6 +1508,7 @@ func getMockAlertConfig(ctx context.Context) (alertConfigModel, error) {
mockEmailConfig, diags := types.ObjectValue(emailConfigsTypes, map[string]attr.Value{
"to": types.StringValue("123@gmail.com"),
"smart_host": types.StringValue("smtp.gmail.com:587"),
"send_resolved": types.BoolValue(false),
"from": types.StringValue("xxxx@gmail.com"),
"auth_username": types.StringValue("xxxx@gmail.com"),
"auth_password": types.StringValue("xxxxxxxxx"),
@ -1635,6 +1654,7 @@ func mapReceiversToAttributes(ctx context.Context, respReceivers *[]observabilit
"auth_password": types.StringPointerValue(emailConfig.AuthPassword),
"auth_username": types.StringPointerValue(emailConfig.AuthUsername),
"from": types.StringPointerValue(emailConfig.From),
"send_resolved": types.BoolPointerValue(emailConfig.SendResolved),
"smart_host": types.StringPointerValue(emailConfig.Smarthost),
"to": types.StringPointerValue(emailConfig.To),
}
@ -1650,10 +1670,11 @@ func mapReceiversToAttributes(ctx context.Context, respReceivers *[]observabilit
if receiver.OpsgenieConfigs != nil {
for _, opsgenieConfig := range *receiver.OpsgenieConfigs {
opsGenieConfigMap := map[string]attr.Value{
"api_key": types.StringPointerValue(opsgenieConfig.ApiKey),
"api_url": types.StringPointerValue(opsgenieConfig.ApiUrl),
"tags": types.StringPointerValue(opsgenieConfig.Tags),
"priority": types.StringPointerValue(opsgenieConfig.Priority),
"api_key": types.StringPointerValue(opsgenieConfig.ApiKey),
"api_url": types.StringPointerValue(opsgenieConfig.ApiUrl),
"tags": types.StringPointerValue(opsgenieConfig.Tags),
"priority": types.StringPointerValue(opsgenieConfig.Priority),
"send_resolved": types.BoolPointerValue(opsgenieConfig.SendResolved),
}
opsGenieConfigModel, diags := types.ObjectValue(opsgenieConfigsTypes, opsGenieConfigMap)
if diags.HasError() {
@ -1666,13 +1687,11 @@ func mapReceiversToAttributes(ctx context.Context, respReceivers *[]observabilit
webhooksConfigList := []attr.Value{}
if receiver.WebHookConfigs != nil {
for _, webhookConfig := range *receiver.WebHookConfigs {
msTeamsValue := types.BoolPointerValue(webhookConfig.MsTeams)
googleChatValue := types.BoolPointerValue(webhookConfig.GoogleChat)
webHookConfigsMap := map[string]attr.Value{
"url": types.StringPointerValue(webhookConfig.Url),
"ms_teams": msTeamsValue,
"google_chat": googleChatValue,
"url": types.StringPointerValue(webhookConfig.Url),
"ms_teams": types.BoolPointerValue(webhookConfig.MsTeams),
"google_chat": types.BoolPointerValue(webhookConfig.GoogleChat),
"send_resolved": types.BoolPointerValue(webhookConfig.SendResolved),
}
webHookConfigsModel, diags := types.ObjectValue(webHooksConfigsTypes, webHookConfigsMap)
if diags.HasError() {
@ -1981,6 +2000,7 @@ func toReceiverPayload(ctx context.Context, model *alertConfigModel) (*[]observa
AuthPassword: conversion.StringValueToPointer(emailConfig.AuthPassword),
AuthUsername: conversion.StringValueToPointer(emailConfig.AuthUsername),
From: conversion.StringValueToPointer(emailConfig.From),
SendResolved: conversion.BoolValueToPointer(emailConfig.SendResolved),
Smarthost: conversion.StringValueToPointer(emailConfig.Smarthost),
To: conversion.StringValueToPointer(emailConfig.To),
})
@ -1998,10 +2018,11 @@ func toReceiverPayload(ctx context.Context, model *alertConfigModel) (*[]observa
for i := range opsgenieConfigs {
opsgenieConfig := opsgenieConfigs[i]
payloadOpsGenieConfigs = append(payloadOpsGenieConfigs, observability.CreateAlertConfigReceiverPayloadOpsgenieConfigsInner{
ApiKey: conversion.StringValueToPointer(opsgenieConfig.ApiKey),
ApiUrl: conversion.StringValueToPointer(opsgenieConfig.ApiUrl),
Tags: conversion.StringValueToPointer(opsgenieConfig.Tags),
Priority: conversion.StringValueToPointer(opsgenieConfig.Priority),
ApiKey: conversion.StringValueToPointer(opsgenieConfig.ApiKey),
ApiUrl: conversion.StringValueToPointer(opsgenieConfig.ApiUrl),
Tags: conversion.StringValueToPointer(opsgenieConfig.Tags),
Priority: conversion.StringValueToPointer(opsgenieConfig.Priority),
SendResolved: conversion.BoolValueToPointer(opsgenieConfig.SendResolved),
})
}
receiverPayload.OpsgenieConfigs = &payloadOpsGenieConfigs
@ -2017,9 +2038,10 @@ func toReceiverPayload(ctx context.Context, model *alertConfigModel) (*[]observa
for i := range receiverWebHooksConfigs {
webHooksConfig := receiverWebHooksConfigs[i]
payloadWebHooksConfigs = append(payloadWebHooksConfigs, observability.CreateAlertConfigReceiverPayloadWebHookConfigsInner{
Url: conversion.StringValueToPointer(webHooksConfig.Url),
MsTeams: conversion.BoolValueToPointer(webHooksConfig.MsTeams),
GoogleChat: conversion.BoolValueToPointer(webHooksConfig.GoogleChat),
Url: conversion.StringValueToPointer(webHooksConfig.Url),
MsTeams: conversion.BoolValueToPointer(webHooksConfig.MsTeams),
GoogleChat: conversion.BoolValueToPointer(webHooksConfig.GoogleChat),
SendResolved: conversion.BoolValueToPointer(webHooksConfig.SendResolved),
})
}
receiverPayload.WebHookConfigs = &payloadWebHooksConfigs

51
stackit/internal/services/observability/instance/resource_test.go
View file

@ -24,6 +24,7 @@ func fixtureEmailConfigsModel() basetypes.ListValue {
"auth_password": types.StringValue("password"),
"auth_username": types.StringValue("username"),
"from": types.StringValue("notification@example.com"),
"send_resolved": types.BoolValue(true),
"smart_host": types.StringValue("smtp.example.com"),
"to": types.StringValue("me@example.com"),
}),
@ -33,10 +34,11 @@ func fixtureEmailConfigsModel() basetypes.ListValue {
func fixtureOpsGenieConfigsModel() basetypes.ListValue {
return types.ListValueMust(types.ObjectType{AttrTypes: opsgenieConfigsTypes}, []attr.Value{
types.ObjectValueMust(opsgenieConfigsTypes, map[string]attr.Value{
"api_key": types.StringValue("key"),
"tags": types.StringValue("tag"),
"api_url": types.StringValue("ops.example.com"),
"priority": types.StringValue("P3"),
"api_key": types.StringValue("key"),
"tags": types.StringValue("tag"),
"api_url": types.StringValue("ops.example.com"),
"priority": types.StringValue("P3"),
"send_resolved": types.BoolValue(true),
}),
})
}
@ -44,9 +46,10 @@ func fixtureOpsGenieConfigsModel() basetypes.ListValue {
func fixtureWebHooksConfigsModel() basetypes.ListValue {
return types.ListValueMust(types.ObjectType{AttrTypes: webHooksConfigsTypes}, []attr.Value{
types.ObjectValueMust(webHooksConfigsTypes, map[string]attr.Value{
"url": types.StringValue("http://example.com"),
"ms_teams": types.BoolValue(true),
"google_chat": types.BoolValue(true),
"url": types.StringValue("http://example.com"),
"ms_teams": types.BoolValue(true),
"google_chat": types.BoolValue(true),
"send_resolved": types.BoolValue(true),
}),
})
}
@ -135,6 +138,7 @@ func fixtureEmailConfigsPayload() observability.CreateAlertConfigReceiverPayload
AuthPassword: utils.Ptr("password"),
AuthUsername: utils.Ptr("username"),
From: utils.Ptr("notification@example.com"),
SendResolved: utils.Ptr(true),
Smarthost: utils.Ptr("smtp.example.com"),
To: utils.Ptr("me@example.com"),
}
@ -142,18 +146,20 @@ func fixtureEmailConfigsPayload() observability.CreateAlertConfigReceiverPayload
func fixtureOpsGenieConfigsPayload() observability.CreateAlertConfigReceiverPayloadOpsgenieConfigsInner {
return observability.CreateAlertConfigReceiverPayloadOpsgenieConfigsInner{
ApiKey: utils.Ptr("key"),
Tags: utils.Ptr("tag"),
ApiUrl: utils.Ptr("ops.example.com"),
Priority: utils.Ptr("P3"),
ApiKey: utils.Ptr("key"),
Tags: utils.Ptr("tag"),
ApiUrl: utils.Ptr("ops.example.com"),
Priority: utils.Ptr("P3"),
SendResolved: utils.Ptr(true),
}
}
func fixtureWebHooksConfigsPayload() observability.CreateAlertConfigReceiverPayloadWebHookConfigsInner {
return observability.CreateAlertConfigReceiverPayloadWebHookConfigsInner{
Url: utils.Ptr("http://example.com"),
MsTeams: utils.Ptr(true),
GoogleChat: utils.Ptr(true),
Url: utils.Ptr("http://example.com"),
MsTeams: utils.Ptr(true),
GoogleChat: utils.Ptr(true),
SendResolved: utils.Ptr(true),
}
}
@ -216,6 +222,7 @@ func fixtureEmailConfigsResponse() observability.EmailConfig {
AuthPassword: utils.Ptr("password"),
AuthUsername: utils.Ptr("username"),
From: utils.Ptr("notification@example.com"),
SendResolved: utils.Ptr(true),
Smarthost: utils.Ptr("smtp.example.com"),
To: utils.Ptr("me@example.com"),
}
@ -223,18 +230,20 @@ func fixtureEmailConfigsResponse() observability.EmailConfig {
func fixtureOpsGenieConfigsResponse() observability.OpsgenieConfig {
return observability.OpsgenieConfig{
ApiKey: utils.Ptr("key"),
Tags: utils.Ptr("tag"),
ApiUrl: utils.Ptr("ops.example.com"),
Priority: utils.Ptr("P3"),
ApiKey: utils.Ptr("key"),
Tags: utils.Ptr("tag"),
ApiUrl: utils.Ptr("ops.example.com"),
Priority: utils.Ptr("P3"),
SendResolved: utils.Ptr(true),
}
}
func fixtureWebHooksConfigsResponse() observability.WebHook {
return observability.WebHook{
Url: utils.Ptr("http://example.com"),
MsTeams: utils.Ptr(true),
GoogleChat: utils.Ptr(true),
Url: utils.Ptr("http://example.com"),
MsTeams: utils.Ptr(true),
GoogleChat: utils.Ptr(true),
SendResolved: utils.Ptr(true),
}
}