feat(instance): migrate server when changing type (#2044)

* feat(instance): migrate server when changing type

* check local volume size during plan

* add 'replace_on_type_change' option

* lint

* update doc

Author: Codelax

docs/resources/instance_server.md

@@ -169,7 +169,10 @@ The following arguments are supported:
 
 - `type` - (Required) The commercial type of the server.
 You find all the available types on the [pricing page](https://www.scaleway.com/en/pricing/).
-Updates to this field will recreate a new resource.
+Updates to this field will migrate the server, local storage constraint must be respected. [More info](https://www.scaleway.com/en/docs/compute/instances/api-cli/migrating-instances/).
+Use `replace_on_type_change` to trigger replacement instead of migration.
+
+~> **Important:** If `type` change and migration occurs, the server will be stopped and changed backed to its original state. It will be started again if it was running.
 
 - `image` - (Optional) The UUID or the label of the base image used by the server. You can use [this endpoint](https://api-marketplace.scaleway.com/images?page=1&per_page=100)
 to find either the right `label` or the right local image `ID` for a given `type`. Optional when creating an instance with an existing root volume.
@@ -227,6 +230,8 @@ attached to the server. Updates to this field will trigger a stop/start of the s
 
 - `boot_type` - The boot Type of the server. Possible values are: `local`, `bootscript` or `rescue`.
 
+- `replace_on_type_change` - (Defaults to false) If true, the server will be replaced if `type` is changed. Otherwise, the server will migrate.
+
 - `bootscript_id` - The ID of the bootscript to use  (set boot_type to `bootscript`).
 
 - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the server should be created.

go.mod

@@ -16,7 +16,7 @@ require (
 	github.com/nats-io/jwt/v2 v2.4.1
 	github.com/nats-io/nats.go v1.27.1
 	github.com/robfig/cron/v3 v3.0.1
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.18.0.20230707094537-b73e88c770db
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.18.0.20230710160943-efc922e1f661
 	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.18.0.20230707094537-b73e88c770db h1:6clfb6rrE1ZVHlwoFTJmnf8OSR1EbuH7vQ0S0kzR0cA=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.18.0.20230707094537-b73e88c770db/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.18.0.20230710160943-efc922e1f661 h1:/FNBbwxEzMriXGudqXTGOg0nIeNO+0xpqXChZk6auBE=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.18.0.20230710160943-efc922e1f661/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/resource_instance_server.go

@@ -11,6 +11,7 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/customdiff"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 	"github.com/scaleway/scaleway-sdk-go/api/instance/v1"
@@ -54,10 +55,15 @@ func resourceScalewayInstanceServer() *schema.Resource {
 			"type": {
 				Type:             schema.TypeString,
 				Required:         true,
-				ForceNew:         true,
 				Description:      "The instance type of the server", // TODO: link to scaleway pricing in the doc
 				DiffSuppressFunc: diffSuppressFuncIgnoreCase,
 			},
+			"replace_on_type_change": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+				Description: "Delete and re-create server if type change",
+			},
 			"tags": {
 				Type: schema.TypeList,
 				Elem: &schema.Schema{
@@ -271,10 +277,13 @@ func resourceScalewayInstanceServer() *schema.Resource {
 			"organization_id": organizationIDSchema(),
 			"project_id":      projectIDSchema(),
 		},
-		CustomizeDiff: customizeDiffLocalityCheck(
-			"placement_group_id",
-			"additional_volume_ids.#",
-			"ip_id",
+		CustomizeDiff: customdiff.All(
+			customizeDiffLocalityCheck(
+				"placement_group_id",
+				"additional_volume_ids.#",
+				"ip_id",
+			),
+			customDiffInstanceServerType,
 		),
 	}
 }
@@ -943,6 +952,13 @@ func resourceScalewayInstanceServerUpdate(ctx context.Context, d *schema.Resourc
 		return diag.FromErr(err)
 	}
 
+	if d.HasChange("type") {
+		err := resourceScalewayInstanceServerMigrate(ctx, d, instanceAPI, zone, id)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	}
+
 	return append(warnings, resourceScalewayInstanceServerRead(ctx, d, meta)...)
 }
 
@@ -1018,3 +1034,94 @@ func resourceScalewayInstanceServerDelete(ctx context.Context, d *schema.Resourc
 
 	return nil
 }
+
+func instanceServerCanMigrate(api *instance.API, server *instance.Server, requestedType string) error {
+	var localVolumeSize scw.Size
+
+	for _, volume := range server.Volumes {
+		if volume.VolumeType == instance.VolumeServerVolumeTypeLSSD {
+			localVolumeSize += volume.Size
+		}
+	}
+
+	serverType, err := api.GetServerType(&instance.GetServerTypeRequest{
+		Zone: server.Zone,
+		Name: requestedType,
+	})
+	if err != nil {
+		return err
+	}
+
+	if serverType.VolumesConstraint != nil &&
+		(localVolumeSize > serverType.VolumesConstraint.MaxSize) ||
+		(localVolumeSize < serverType.VolumesConstraint.MinSize) {
+		return fmt.Errorf("local volume total size does not respect type constraint, expected beteween (%dGB, %dGB), got %sGB",
+			serverType.VolumesConstraint.MinSize/scw.GB,
+			serverType.VolumesConstraint.MaxSize/scw.GB,
+			localVolumeSize/scw.GB)
+	}
+
+	return nil
+}
+
+func customDiffInstanceServerType(_ context.Context, diff *schema.ResourceDiff, meta interface{}) error {
+	if !diff.HasChange("type") || diff.Id() == "" {
+		return nil
+	}
+
+	if diff.Get("replace_on_type_change").(bool) {
+		return diff.ForceNew("type")
+	}
+
+	instanceAPI, zone, id, err := instanceAPIWithZoneAndID(meta, diff.Id())
+	if err != nil {
+		return err
+	}
+
+	_, newValue := diff.GetChange("type")
+	newType := newValue.(string)
+
+	resp, err := instanceAPI.GetServer(&instance.GetServerRequest{
+		Zone:     zone,
+		ServerID: id,
+	})
+	if err != nil {
+		return fmt.Errorf("failed to check server type change: %w", err)
+	}
+
+	err = instanceServerCanMigrate(instanceAPI, resp.Server, newType)
+	if err != nil {
+		return fmt.Errorf("cannot change server type: %w", err)
+	}
+
+	return nil
+}
+
+func resourceScalewayInstanceServerMigrate(ctx context.Context, d *schema.ResourceData, instanceAPI *instance.API, zone scw.Zone, id string) error {
+	server, err := waitForInstanceServer(ctx, instanceAPI, zone, id, d.Timeout(schema.TimeoutUpdate))
+	if err != nil {
+		return fmt.Errorf("failed to wait for server before changing server type: %w", err)
+	}
+	beginningState := server.State
+
+	err = reachState(ctx, instanceAPI, zone, id, instance.ServerStateStopped)
+	if err != nil {
+		return fmt.Errorf("failed to stop server before changing server type: %w", err)
+	}
+
+	_, err = instanceAPI.UpdateServer(&instance.UpdateServerRequest{
+		Zone:           zone,
+		ServerID:       id,
+		CommercialType: expandStringPtr(d.Get("type")),
+	})
+	if err != nil {
+		return fmt.Errorf("failed to change server type server")
+	}
+
+	err = reachState(ctx, instanceAPI, zone, id, beginningState)
+	if err != nil {
+		return fmt.Errorf("failed to start server after changing server type: %w", err)
+	}
+
+	return nil
+}

scaleway/resource_instance_server_test.go

@@ -2,6 +2,7 @@ package scaleway
 
 import (
 	"fmt"
+	"regexp"
 	"strings"
 	"testing"
 
@@ -335,6 +336,7 @@ func TestAccScalewayInstanceServer_Basic(t *testing.T) {
 					  name  = "test"
 					  image = "${data.scaleway_marketplace_image.ubuntu.id}"
 					  type  = "DEV1-S"
+					  replace_on_type_change  = true
 					
 					  tags = [ "terraform-test", "scaleway_instance_server", "basic" ]
 					}`,
@@ -1316,3 +1318,89 @@ func TestAccScalewayInstanceServer_PrivateNetwork(t *testing.T) {
 		},
 	})
 }
+
+func TestAccScalewayInstanceServer_Migrate(t *testing.T) {
+	tt := NewTestTools(t)
+	defer tt.Cleanup()
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy:      testAccCheckScalewayInstanceServerDestroy(tt),
+		Steps: []resource.TestStep{
+			{
+				Config: `
+					resource "scaleway_instance_server" "main" {
+						image = "ubuntu_jammy"
+						type  = "PRO2-XXS"
+						
+					}`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayInstancePrivateNICsExists(tt, "scaleway_instance_server.main"),
+					resource.TestCheckResourceAttr("scaleway_instance_server.main", "type", "PRO2-XXS"),
+				),
+			},
+			{
+				Config: `
+					resource "scaleway_instance_server" "main" {
+						image = "ubuntu_jammy"
+						type  = "PRO2-XS"
+						
+					}`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayInstancePrivateNICsExists(tt, "scaleway_instance_server.main"),
+					resource.TestCheckResourceAttr("scaleway_instance_server.main", "type", "PRO2-XS"),
+				),
+			},
+			{
+				Config: `
+					resource "scaleway_instance_server" "main" {
+						image = "ubuntu_jammy"
+						type  = "PRO2-XXS"
+						
+					}`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayInstancePrivateNICsExists(tt, "scaleway_instance_server.main"),
+					resource.TestCheckResourceAttr("scaleway_instance_server.main", "type", "PRO2-XXS"),
+				),
+			},
+		},
+	})
+}
+
+func TestAccScalewayInstanceServer_MigrateInvalidLocalVolumeSize(t *testing.T) {
+	tt := NewTestTools(t)
+	defer tt.Cleanup()
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy:      testAccCheckScalewayInstanceServerDestroy(tt),
+		Steps: []resource.TestStep{
+			{
+				Config: `
+					resource "scaleway_instance_server" "main" {
+						image = "ubuntu_jammy"
+						type  = "DEV1-L"
+						
+					}`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayInstancePrivateNICsExists(tt, "scaleway_instance_server.main"),
+					resource.TestCheckResourceAttr("scaleway_instance_server.main", "type", "DEV1-L"),
+				),
+			},
+			{
+				Config: `
+					resource "scaleway_instance_server" "main" {
+						image = "ubuntu_jammy"
+						type  = "DEV1-S"
+						
+					}`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayInstancePrivateNICsExists(tt, "scaleway_instance_server.main"),
+					resource.TestCheckResourceAttr("scaleway_instance_server.main", "type", "DEV1-S"),
+				),
+				ExpectError: regexp.MustCompile("cannot change server type"),
+				PlanOnly:    true,
+			},
+		},
+	})
+}