feat(k8s): type change should migrate cluster when possible (#2115)

Author: Mia-Cross

docs/resources/k8s_cluster.md

@@ -210,7 +210,13 @@ The following arguments are supported:
 
 - `name` - (Required) The name for the Kubernetes cluster.
 
-- `type` - (Optional) The type of Kubernetes cluster. Possible values are: `kapsule` or `multicloud`.
+- `type` - (Optional) The type of Kubernetes cluster. Possible values are:
+
+    - for mutualized clusters: `kapsule` or `multicloud`
+
+    - for dedicated Kapsule clusters: `kapsule-dedicated-4`, `kapsule-dedicated-8` or `kapsule-dedicated-16`.
+
+    - for dedicated Kosmos clusters: `multicloud-dedicated-4`, `multicloud-dedicated-8` or `multicloud-dedicated-16`.
 
 - `description` - (Optional) A description for the Kubernetes cluster.
 

go.mod

@@ -16,7 +16,7 @@ require (
 	github.com/nats-io/jwt/v2 v2.5.0
 	github.com/nats-io/nats.go v1.28.0
 	github.com/robfig/cron/v3 v3.0.1
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.20.0.20230821160755-82a4aa87ba70
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.20.0.20230901111648-9e540fe63734
 	github.com/stretchr/testify v1.8.4
 )
 

go.sum

@@ -173,8 +173,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
 github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.20.0.20230821160755-82a4aa87ba70 h1:k8EwAXHaONvKu7l55pnC4EoY/XpNyM0/5J/+Bruw2PU=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.20.0.20230821160755-82a4aa87ba70/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.20.0.20230901111648-9e540fe63734 h1:KAxCqrhRP6DAclE0uzBcwUJtAfkdUfEA75rhUFKj4cU=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.20.0.20230901111648-9e540fe63734/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
 github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
 github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/skeema/knownhosts v1.1.0 h1:Wvr9V0MxhjRbl3f9nMnKnFfiWTJmtECJ9Njkea3ysW0=

scaleway/helpers.go

@@ -19,6 +19,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 	"github.com/scaleway/scaleway-sdk-go/namegenerator"
 	"github.com/scaleway/scaleway-sdk-go/scw"
 )
@@ -1101,3 +1102,38 @@ func sliceContainsString(slice []string, str string) bool {
 	}
 	return false
 }
+
+// testAccCheckScalewayResourceIDPersisted checks that the ID of the resource is the same throughout tests of migration or mutation
+// It can be used to check that no ForceNew has been done
+func testAccCheckScalewayResourceIDPersisted(resourceName string, resourceID *string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		rs, ok := s.RootModule().Resources[resourceName]
+		if !ok {
+			return fmt.Errorf("resource was not found: %s", resourceName)
+		}
+		if *resourceID != "" && *resourceID != rs.Primary.ID {
+			return fmt.Errorf("resource ID changed when it should have persisted")
+		}
+		*resourceID = rs.Primary.ID
+		return nil
+	}
+}
+
+// testAccCheckScalewayResourceIDChanged checks that the ID of the resource has indeed changed, in case of ForceNew for example.
+// It will fail if resourceID is empty so be sure to use testAccCheckScalewayResourceIDPersisted first in a test suite.
+func testAccCheckScalewayResourceIDChanged(resourceName string, resourceID *string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		if resourceID == nil || *resourceID == "" {
+			return fmt.Errorf("resourceID was not set")
+		}
+		rs, ok := s.RootModule().Resources[resourceName]
+		if !ok {
+			return fmt.Errorf("resource was not found: %s", resourceName)
+		}
+		if *resourceID == rs.Primary.ID {
+			return fmt.Errorf("resource ID persisted when it should have changed")
+		}
+		*resourceID = rs.Primary.ID
+		return nil
+	}
+}

scaleway/resource_k8s_cluster.go

@@ -41,7 +41,6 @@ func resourceScalewayK8SCluster() *schema.Resource {
 			"type": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				ForceNew:    true,
 				Computed:    true,
 				Description: "The type of cluster",
 			},
@@ -274,6 +273,33 @@ func resourceScalewayK8SCluster() *schema.Resource {
 				}
 				return nil
 			},
+			func(ctx context.Context, diff *schema.ResourceDiff, i interface{}) error {
+				if diff.HasChange("type") && diff.Id() != "" {
+					k8sAPI, region, clusterID, err := k8sAPIWithRegionAndID(i, diff.Id())
+					if err != nil {
+						return err
+					}
+					possibleTypes, err := k8sAPI.ListClusterAvailableTypes(&k8s.ListClusterAvailableTypesRequest{
+						Region:    region,
+						ClusterID: clusterID,
+					}, scw.WithContext(ctx))
+					if err != nil {
+						return err
+					}
+
+					planned := diff.Get("type")
+					for _, possibleType := range possibleTypes.ClusterTypes {
+						if possibleType.Name == planned {
+							return nil
+						}
+					}
+					err = diff.ForceNew("type")
+					if err != nil {
+						return err
+					}
+				}
+				return nil
+			},
 		),
 	}
 }
@@ -551,6 +577,25 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat
 		return diag.FromErr(err)
 	}
 
+	if d.HasChange("type") {
+		_, err = waitK8SCluster(ctx, k8sAPI, region, clusterID, defaultK8SClusterTimeout)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+		_, err = k8sAPI.SetClusterType(&k8s.SetClusterTypeRequest{
+			Region:    region,
+			ClusterID: clusterID,
+			Type:      d.Get("type").(string),
+		}, scw.WithContext(ctx))
+		if err != nil {
+			return diag.FromErr(err)
+		}
+		_, err = waitK8SCluster(ctx, k8sAPI, region, clusterID, defaultK8SClusterTimeout)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	}
+
 	canUpgrade := false
 
 	////

scaleway/resource_k8s_cluster_test.go

@@ -452,6 +452,88 @@ func TestAccScalewayK8SCluster_Multicloud(t *testing.T) {
 	})
 }
 
+func TestAccScalewayK8SCluster_TypeChange(t *testing.T) {
+	tt := NewTestTools(t)
+	defer tt.Cleanup()
+
+	latestK8SVersion := testAccScalewayK8SClusterGetLatestK8SVersion(tt)
+
+	clusterID := ""
+
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheck(t)
+		},
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy:      testAccCheckScalewayK8SClusterDestroy(tt),
+		Steps: []resource.TestStep{
+			{
+				// 1 : Start with a mutualized Kapsule cluster
+				Config: testAccCheckScalewayK8SClusterTypeChange("kapsule", "cilium", latestK8SVersion),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayK8SClusterExists(tt, "scaleway_k8s_cluster.type-change"),
+					resource.TestCheckResourceAttr("scaleway_k8s_cluster.type-change", "type", "kapsule"),
+					testAccCheckScalewayResourceIDPersisted("scaleway_k8s_cluster.type-change", &clusterID),
+				),
+			},
+			{
+				// 2 : Upgrade to a dedicated Kapsule --> should migrate
+				Config: testAccCheckScalewayK8SClusterTypeChange("kapsule-dedicated-4", "cilium", latestK8SVersion), // + testAccCheckScalewayK8SClusterTypeChangeCopy(latestK8SVersion),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayK8SClusterExists(tt, "scaleway_k8s_cluster.type-change"),
+					resource.TestCheckResourceAttr("scaleway_k8s_cluster.type-change", "type", "kapsule-dedicated-4"),
+					testAccCheckScalewayResourceIDPersisted("scaleway_k8s_cluster.type-change", &clusterID),
+				),
+			},
+			{
+				// 3 : Upgrade to an even bigger dedicated Kapsule --> should migrate
+				Config: testAccCheckScalewayK8SClusterTypeChange("kapsule-dedicated-16", "cilium", latestK8SVersion), // + testAccCheckScalewayK8SClusterTypeChangeCopy(latestK8SVersion),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayK8SClusterExists(tt, "scaleway_k8s_cluster.type-change"),
+					resource.TestCheckResourceAttr("scaleway_k8s_cluster.type-change", "type", "kapsule-dedicated-16"),
+					testAccCheckScalewayResourceIDPersisted("scaleway_k8s_cluster.type-change", &clusterID),
+				),
+			},
+			{
+				// 4 : Downgrade to a smaller dedicated Kapsule --> should recreate
+				Config: testAccCheckScalewayK8SClusterTypeChange("kapsule-dedicated-8", "cilium", latestK8SVersion), // + testAccCheckScalewayK8SClusterTypeChangeCopy(latestK8SVersion),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayK8SClusterExists(tt, "scaleway_k8s_cluster.type-change"),
+					resource.TestCheckResourceAttr("scaleway_k8s_cluster.type-change", "type", "kapsule-dedicated-8"),
+					testAccCheckScalewayResourceIDChanged("scaleway_k8s_cluster.type-change", &clusterID),
+				),
+			},
+			{
+				// 5 : Change to a dedicated Kosmos --> should recreate
+				Config: testAccCheckScalewayK8SClusterTypeChange("multicloud-dedicated-4", "kilo", latestK8SVersion), // + testAccCheckScalewayK8SClusterTypeChangeCopy(latestK8SVersion),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayK8SClusterExists(tt, "scaleway_k8s_cluster.type-change"),
+					resource.TestCheckResourceAttr("scaleway_k8s_cluster.type-change", "type", "multicloud-dedicated-4"),
+					testAccCheckScalewayResourceIDChanged("scaleway_k8s_cluster.type-change", &clusterID),
+				),
+			},
+			{
+				// 6 : Upgrade to a bigger dedicated Kosmos --> should migrate
+				Config: testAccCheckScalewayK8SClusterTypeChange("multicloud-dedicated-8", "kilo", latestK8SVersion), // + testAccCheckScalewayK8SClusterTypeChangeCopy(latestK8SVersion),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayK8SClusterExists(tt, "scaleway_k8s_cluster.type-change"),
+					resource.TestCheckResourceAttr("scaleway_k8s_cluster.type-change", "type", "multicloud-dedicated-8"),
+					testAccCheckScalewayResourceIDPersisted("scaleway_k8s_cluster.type-change", &clusterID),
+				),
+			},
+			{
+				// 7 : Downgrade to a mutualized Kosmos --> should recreate
+				Config: testAccCheckScalewayK8SClusterTypeChange("multicloud", "kilo", latestK8SVersion), // + testAccCheckScalewayK8SClusterTypeChangeCopy(latestK8SVersion),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayK8SClusterExists(tt, "scaleway_k8s_cluster.type-change"),
+					resource.TestCheckResourceAttr("scaleway_k8s_cluster.type-change", "type", "multicloud"),
+					testAccCheckScalewayResourceIDChanged("scaleway_k8s_cluster.type-change", &clusterID),
+				),
+			},
+		},
+	})
+}
+
 func testAccCheckScalewayK8SClusterDestroy(tt *TestTools) resource.TestCheckFunc {
 	return func(state *terraform.State) error {
 		for _, rs := range state.RootModule().Resources {
@@ -734,3 +816,15 @@ resource "scaleway_k8s_pool" "multicloud" {
 }
 `, version)
 }
+
+func testAccCheckScalewayK8SClusterTypeChange(clusterType, cni, version string) string {
+	return fmt.Sprintf(`
+resource "scaleway_k8s_cluster" "type-change" {
+	type = "%s"
+	cni = "%s"
+	version = "%s"
+	name = "test-type-change"
+	tags = [ "terraform-test", "scaleway_k8s_cluster", "type-change" ]
+	delete_additional_resources = true
+}`, clusterType, cni, version)
+}