[3.1.4] Service Tags support added

Author: vasiliyskysql

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [3.1.4] - 2025-07-17
+### Features
+- service `tags` support added.
+
 ## [3.1.3] - 2024-07-25
 ### Package Updates
 - upgraded go 1.19 => 1.21

examples/azure-private-link/main.tf

@@ -30,7 +30,13 @@ resource "skysql_service" "this" {
   version                   = data.skysql_versions.this.versions[0].name
   endpoint_mechanism        = "privateconnect"
   endpoint_allowed_accounts = [data.azurerm_subscription.current.subscription_id]
-  wait_for_creation         = true
+  tags = {
+    "name"           = var.skysql_service_name
+    "environment"    = "demo"
+    "connectivity"   = "private-link"
+    "cloud-provider" = "azure"
+  }
+  wait_for_creation = true
   # The following line will be required when tearing down the skysql service
   # deletion_protection = false
 }

examples/global-replication/main.tf

@@ -33,6 +33,12 @@ resource "skysql_service" "primary" {
   storage        = 100
   ssl_enabled    = true
   version        = local.sky_versions_filtered[0].name
+  tags = {
+    "name"        = "my-primary-service"
+    "environment" = "production"
+    "role"        = "primary"
+    "replication" = "enabled"
+  }
   # The service create is an asynchronous operation.
   # if you want to wait for the service to be created set wait_for_creation to true
   wait_for_creation = true
@@ -54,6 +60,12 @@ resource "skysql_service" "replica" {
   version             = local.sky_versions_filtered[0].name
   primary_host        = skysql_service.primary.id
   replication_enabled = true
+  tags = {
+    "name"        = "my-replica-service"
+    "environment" = "production"
+    "role"        = "replica"
+    "replication" = "enabled"
+  }
   # The service create is an asynchronous operation.
   # if you want to wait for the service to be created set wait_for_creation to true
   wait_for_creation = true

examples/main.tf

@@ -35,6 +35,12 @@ resource "skysql_service" "default" {
       "comment" : "localhost"
     }
   ]
+  tags = {
+    "name"        = "myservice"
+    "environment" = "development"
+    "team"        = "engineering"
+    "project"     = "demo"
+  }
   wait_for_creation = true
 }
 

examples/private-service-connect/main.tf

@@ -21,7 +21,13 @@ resource "skysql_service" "this" {
   version                   = data.skysql_versions.this.versions[0].name
   endpoint_mechanism        = "privateconnect"
   endpoint_allowed_accounts = [data.google_project.this.number]
-  wait_for_creation         = true
+  tags = {
+    "name"           = var.skysql_service_name
+    "environment"    = "demo"
+    "connectivity"   = "private-service-connect"
+    "cloud-provider" = "gcp"
+  }
+  wait_for_creation = true
   # The following line will be required when tearing down the skysql service
   # deletion_protection = false
 }

examples/privateconnect/main.tf

@@ -21,10 +21,16 @@ resource "skysql_service" "this" {
   version                   = data.skysql_versions.this.versions[0].name
   endpoint_mechanism        = "privateconnect"
   endpoint_allowed_accounts = [data.aws_caller_identity.this.account_id]
-  wait_for_creation         = true
-  volume_type               = "gp3"
-  volume_iops               = 3000
-  volume_throughput         = 125
+  tags = {
+    "name"           = var.skysql_service_name
+    "environment"    = "demo"
+    "connectivity"   = "privateconnect"
+    "cloud-provider" = "aws"
+  }
+  wait_for_creation = true
+  volume_type       = "gp3"
+  volume_iops       = 3000
+  volume_throughput = 125
   # The following line will be required when tearing down the skysql service
   # deletion_protection = false
 }

examples/resources/skysql_service.tf

@@ -15,6 +15,13 @@ resource "skysql_service" "default" {
   volume_type       = "gp3"
   volume_iops       = 3000
   volume_throughput = 125
+  # Tags for organizing and managing services
+  tags = {
+    "name"        = "myservice"
+    "environment" = "production"
+    "team"        = "backend"
+    "cost-center" = "engineering"
+  }
   # The service create is an asynchronous operation.
   # if you want to wait for the service to be created set wait_for_creation to true
   wait_for_creation = true

internal/provider/service_resource.go

@@ -98,6 +98,7 @@ type ServiceResourceModel struct {
 	MaxscaleSize       types.String   `tfsdk:"maxscale_size"`
 	FQDN               types.String   `tfsdk:"fqdn"`
 	AvailabilityZone   types.String   `tfsdk:"availability_zone"`
+	Tags               types.Map      `tfsdk:"tags"`
 }
 
 // ServiceResourceNamedPortModel is an endpoint port
@@ -403,6 +404,12 @@ var serviceResourceSchemaV0 = schema.Schema{
 				stringplanmodifier.RequiresReplace(),
 			},
 		},
+		"tags": schema.MapAttribute{
+			Optional:    true,
+			Computed:    true,
+			ElementType: types.StringType,
+			Description: "Tags associated with the service",
+		},
 	},
 	Blocks: map[string]schema.Block{
 		"timeouts": timeouts.Block(context.Background(), timeouts.Opts{
@@ -721,6 +728,11 @@ func (r *ServiceResource) readServiceState(ctx context.Context, data *ServiceRes
 	if !(data.MaxscaleNodes.IsUnknown() || data.MaxscaleSize.IsNull()) {
 		data.MaxscaleNodes = types.Int64Value(int64(service.MaxscaleNodes))
 	}
+	if service.Tags != nil {
+		data.Tags, _ = types.MapValueFrom(ctx, types.StringType, service.Tags)
+	} else {
+		data.Tags = types.MapNull(types.StringType)
+	}
 	return nil
 }
 
@@ -783,6 +795,11 @@ func (r *ServiceResource) Update(ctx context.Context, req resource.UpdateRequest
 		return
 	}
 
+	r.updateServiceTags(ctx, plan, state, resp)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
 	err := r.readServiceState(ctx, state)
 	if err != nil {
 		if errors.Is(err, skysql.ErrorServiceNotFound) {
@@ -1035,6 +1052,63 @@ func (r *ServiceResource) updateServicePowerState(ctx context.Context, plan *Ser
 	}
 }
 
+func (r *ServiceResource) updateServiceTags(ctx context.Context, plan *ServiceResourceModel, state *ServiceResourceModel, resp *resource.UpdateResponse) {
+	if !plan.Tags.IsUnknown() {
+		var planTags map[string]string
+		diags := plan.Tags.ElementsAs(ctx, &planTags, false)
+		if diags.HasError() {
+			// Log warning but don't fail the update to protect against state incompatibility
+			tflog.Warn(ctx, "Failed to parse plan tags, skipping tag update", map[string]interface{}{
+				"id":    state.ID.ValueString(),
+				"error": diags.Errors(),
+			})
+			return
+		}
+
+		var stateTags map[string]string
+		diags = state.Tags.ElementsAs(ctx, &stateTags, false)
+		if diags.HasError() {
+			// For backward compatibility, if state tags can't be parsed (e.g., from older provider version),
+			// treat as empty map and continue with the update
+			tflog.Warn(ctx, "Failed to parse state tags, treating as empty", map[string]interface{}{
+				"id":    state.ID.ValueString(),
+				"error": diags.Errors(),
+			})
+			stateTags = make(map[string]string)
+		}
+
+		if !reflect.DeepEqual(planTags, stateTags) {
+			tflog.Info(ctx, "Updating service tags", map[string]interface{}{
+				"id": state.ID.ValueString(),
+			})
+
+			err := r.client.UpdateServiceTags(ctx, state.ID.ValueString(), planTags)
+			if err != nil {
+				if errors.Is(err, skysql.ErrorServiceNotFound) {
+					tflog.Warn(ctx, "SkySQL service not found, removing from state", map[string]interface{}{
+						"id": state.ID.ValueString(),
+					})
+					resp.State.RemoveResource(ctx)
+					return
+				}
+				// Log warning but don't fail the update to protect against tag API errors
+				tflog.Warn(ctx, "Failed to update service tags, continuing with other updates", map[string]interface{}{
+					"id":    state.ID.ValueString(),
+					"error": err.Error(),
+				})
+				return
+			}
+
+			state.Tags = plan.Tags
+			resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
+			if resp.Diagnostics.HasError() {
+				return
+			}
+			r.waitForUpdate(ctx, state, resp)
+		}
+	}
+}
+
 var serviceUpdateWaitStates = []string{"ready", "failed", "stopped"}
 
 func (r *ServiceResource) waitForUpdate(ctx context.Context, state *ServiceResourceModel, resp *resource.UpdateResponse) {