[3.1.4] Service Tags support added

vasiliyskysql · vasiliyskysql · commit e416d85c45f3 · 2025-07-21T12:17:20.000-05:00
diff --git a/CHANGELOG.md b/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
diff --git a/docs/data-sources/skysql_availability_zones.md b/docs/data-sources/skysql_availability_zones.md
@@ -1,5 +1,5 @@
 ---
-page_title: "skysql_availability_zones Data Source - terraform-provider-skysql-beta"
+page_title: "skysql_availability_zones Data Source - terraform-provider-beta"
 subcategory: ""
 description: |-
   Retrieve the list of availability_zones.
diff --git a/docs/data-sources/skysql_credentials.md b/docs/data-sources/skysql_credentials.md
@@ -1,5 +1,5 @@
 ---
-page_title: "skysql_credentials Data Source - terraform-provider-skysql-beta"
+page_title: "skysql_credentials Data Source - terraform-provider-beta"
 subcategory: ""
 description: |-
   Returnes a default credentials for a SkySQL service
diff --git a/docs/data-sources/skysql_projects.md b/docs/data-sources/skysql_projects.md
@@ -1,5 +1,5 @@
 ---
-page_title: "skysql_projects Data Source - terraform-provider-skysql-beta"
+page_title: "skysql_projects Data Source - terraform-provider-beta"
 subcategory: ""
 description: |-
   Retrieve the list of projects. Project is a way of grouping the services.
diff --git a/docs/data-sources/skysql_service.md b/docs/data-sources/skysql_service.md
@@ -1,5 +1,5 @@
 ---
-page_title: "skysql_service Data Source - terraform-provider-skysql-beta"
+page_title: "skysql_service Data Source - terraform-provider-beta"
 subcategory: ""
 description: |-
   Returns an full SkySQL service details
diff --git a/docs/data-sources/skysql_versions.md b/docs/data-sources/skysql_versions.md
@@ -1,5 +1,5 @@
 ---
-page_title: "skysql_versions Data Source - terraform-provider-skysql-beta"
+page_title: "skysql_versions Data Source - terraform-provider-beta"
 subcategory: ""
 description: |-
   SkySQL server versions
diff --git a/docs/index.md b/docs/index.md
@@ -4,7 +4,7 @@ description: |-
    The SkySQL Terraform Provider allows database services in SkySQL to be managed using Terraform.
 ---
 
-# SKYSQL-BETA Provider
+# BETA Provider
 
 The provider allows configuring any SkySQL DB topology using the Terraform's declarative language.
 
@@ -22,7 +22,7 @@ Use the navigation to the left to read about the available resources.
 
 ### Automated Installation (Recommended)
 
-The Terraform Provider for SkySQL listed on the [Terraform Registry](https://registry.terraform.io/providers/skysqlinc/skysql-beta/).
+The Terraform Provider for SkySQL listed on the [Terraform Registry](https://registry.terraform.io/providers/skysqlinc/beta/).
 
 #### Create a Terraform configuration file
 
@@ -34,7 +34,7 @@ Providers listed on the Terraform Registry can be automatically downloaded when
 terraform {
   required_providers {
     skysql = {
-      source = "registry.terraform.io/skysqlinc/skysql-beta"
+      source = "registry.terraform.io/skysqlinc/beta"
     }
   }
 }
@@ -48,7 +48,7 @@ You can use `version` locking and operators to require specific versions of the
 terraform {
   required_providers {
     skysql = {
-      source = "registry.terraform.io/skysqlinc/skysql-beta"
+      source = "registry.terraform.io/skysqlinc/beta"
        version = ">= x.y.z"
     }
   }
@@ -57,7 +57,7 @@ terraform {
 
 ### Manual Installation
 
-The latest release of the provider can be found on [`terraform-provider-skysql-beta/releases`](https://github.com/skysqlinc/terraform-provider-skysql-beta/releases). You can download the appropriate version of the provider for your operating system using a command line shell or a browser.
+The latest release of the provider can be found on [`terraform-provider-beta/releases`](https://github.com/skysqlinc/terraform-provider-beta/releases). You can download the appropriate version of the provider for your operating system using a command line shell or a browser.
 
 This can be useful in environments that do not allow direct access to the Internet.
 
@@ -71,7 +71,7 @@ The following examples use Bash on Linux (x64).
     RELEASE=x.y.z
     OS=linux
     ARCH=amd64
-    wget -q https://github.com/skysqlinc/terraform-provider-skysql-beta/releases/download/${RELEASE}/terraform-provider-skysql-beta_${RELEASE}_{OS}_{ARCH}.zip
+    wget -q https://github.com/skysqlinc/terraform-provider-beta/releases/download/${RELEASE}/terraform-provider-beta_${RELEASE}_{OS}_{ARCH}.zip
     ```
 
 2. Create a directory for the provider.
@@ -83,20 +83,20 @@ The following examples use Bash on Linux (x64).
     > `<registry>/<namespace>/<service>/<version>/<OS_arch>/`
 
     ```console
-    mkdir -p ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/skysql-beta
+    mkdir -p ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/beta
     ```
 
 3. Copy the plugin to a target system and move to the Terraform plugins directory.
 
     ```console
-    mv terraform-provider-skysql-beta_${RELEASE}_${OS}_${ARCH}.zip ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/skysql-beta/
+    mv terraform-provider-beta_${RELEASE}_${OS}_${ARCH}.zip ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/beta/
 
     ```
 
 4. Verify the presence of the plugin in the Terraform plugins directory.
 
     ```console
-    ls ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/skysql-beta/
+    ls ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/beta/
     ```
 
 #### macOS
@@ -113,7 +113,7 @@ The following example uses Bash (default) on macOS (ARM).
 
     ```console
     export RELEASE=x.y.z
-    wget -q https://github.com/skysqlinc/terraform-provider-skysql-beta/releases/download/v${RELEASE}/terraform-provider-skysql-beta_${RELEASE}_darwin_arm64.zip
+    wget -q https://github.com/skysqlinc/terraform-provider-beta/releases/download/v${RELEASE}/terraform-provider-beta_${RELEASE}_darwin_arm64.zip
     ```
 
 3. Create a directory for the provider.
@@ -125,30 +125,30 @@ The following example uses Bash (default) on macOS (ARM).
     > `<registry>/<namespace>/<service>/<version>/<OS_arch>/`
 
     ```console
-    mkdir -p ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/skysql-beta/
+    mkdir -p ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/beta/
     ```
 
 4. Copy the plugin to a target system and move to the Terraform plugins directory.
 
     ```console
-    mv terraform-provider-skysql-beta_${RELEASE}_darwin_arm64.zip ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/skysql-beta/
+    mv terraform-provider-beta_${RELEASE}_darwin_arm64.zip ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/beta/
     ```
 
 5. Verify the presence of the plugin in the Terraform plugins directory.
 
     ```console
-    ls ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/skysql-beta/
+    ls ~/.terraform.d/plugins/registry.terraform.io/skysqlinc/beta/
     ```
 
 ## Configure the Terraform Configuration Files
 
-In order to use the `skysql-beta` terraform provider, you need to configure the provider in your Terraform configuration files.
+In order to use the `beta` terraform provider, you need to configure the provider in your Terraform configuration files.
 
 ```hcl
 terraform {
   required_providers {
     skysql = {
-      source = "registry.terraform.io/skysqlinc/skysql-beta"
+      source = "registry.terraform.io/skysqlinc/beta"
     }
   }
 }
@@ -160,7 +160,7 @@ or you can specify the provider version.
 terraform {
   required_providers {
     skysql = {
-      source = "registry.terraform.io/skysqlinc/skysql-beta"
+      source = "registry.terraform.io/skysqlinc/beta"
       version = ">= x.y.z"
     }
   }
@@ -177,9 +177,9 @@ $ terraform init
 Initializing the backend...
 
 Initializing provider plugins...
-- Finding latest version of skysqlinc/skysql-beta...
-- Installing skysqlinc/skysql-beta x.y.z...
-- Installed skysqlinc/skysql-beta x.y.z (unauthenticated)
+- Finding latest version of skysqlinc/beta...
+- Installing skysqlinc/beta x.y.z...
+- Installed skysqlinc/beta x.y.z (unauthenticated)
 ...
 
 Terraform has been successfully initialized!
@@ -195,7 +195,7 @@ To find the provider version, navigate to the working directory of your Terrafor
 $ terraform version
 Terraform x.y.z
 on darwin_arm64
-+ provider registry.terraform.io/skysqlinc/skysql-beta x.y.z
++ provider registry.terraform.io/skysqlinc/beta x.y.z
 ```
 
 ## Create a new SkySQL service
diff --git a/docs/resources/skysql_allow_list.md b/docs/resources/skysql_allow_list.md
@@ -1,5 +1,5 @@
 ---
-page_title: "skysql_allow_list Resource - terraform-provider-skysql-beta"
+page_title: "skysql_allow_list Resource - terraform-provider-beta"
 subcategory: ""
 description: |-
   Manages the allow list for a service
diff --git a/docs/resources/skysql_autonomous.md b/docs/resources/skysql_autonomous.md
@@ -1,5 +1,5 @@
 ---
-page_title: "skysql_autonomous Resource - terraform-provider-skysql-beta"
+page_title: "skysql_autonomous Resource - terraform-provider-beta"
 subcategory: ""
 description: |-
   Autonomous features enable automatic scaling in response to changes in workload.
diff --git a/docs/resources/skysql_service.md b/docs/resources/skysql_service.md
@@ -1,5 +1,5 @@
 ---
-page_title: "skysql_service Resource - terraform-provider-skysql-beta"
+page_title: "skysql_service Resource - terraform-provider-beta"
 subcategory: ""
 description: |-
   Creates and manages a service in SkySQL
@@ -29,6 +29,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
@@ -65,6 +72,7 @@ resource "skysql_service" "default" {
 - `size` (String) The size of the service. Valid values are: sky-2x4, sky-2x8 etc
 - `ssl_enabled` (Boolean) Whether to enable SSL. Valid values are: true or false
 - `storage` (Number) The storage size in GB. Valid values are: 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000
+- `tags` (Map of String) Tags associated with the service
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 - `version` (String) The software version
 - `volume_iops` (Number) The volume IOPS. This is only applicable for AWS
diff --git a/examples/azure-private-link/main.tf b/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
 }
diff --git a/examples/global-replication/main.tf b/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
diff --git a/examples/main.tf b/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
 }
 
diff --git a/examples/private-service-connect/main.tf b/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
 }
diff --git a/examples/privateconnect/main.tf b/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
 }
diff --git a/examples/resources/skysql_service.tf b/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
diff --git a/internal/provider/service_resource.go b/internal/provider/service_resource.go
diff --git a/internal/provider/service_resource_tags_test.go b/internal/provider/service_resource_tags_test.go
diff --git a/internal/skysql/client.go b/internal/skysql/client.go
diff --git a/internal/skysql/provisioning/service.go b/internal/skysql/provisioning/service.go
diff --git a/internal/skysql/provisioning/update_service_tags.go b/internal/skysql/provisioning/update_service_tags.go
