fix(LB): schema type and add migration type (#1428)

Author: Monitob

docs/data-sources/lb.md

@@ -1,7 +1,7 @@
 ---
 page_title: "Scaleway: scaleway_lb"
 description: |-
-  Gets information about a Load Balancer.
+Gets information about a Load Balancer.
 ---
 
 # scaleway_lb
@@ -25,21 +25,21 @@ data "scaleway_lb" "by_id" {
 ## Argument Reference
 
 - `name` - (Optional) The IP address.
-  Only one of `name` and `lb_id` should be specified.
-
-- `lb_id` - (Optional) The ID.
-  Only one of `ip_address` and `lb_id` should be specified.
 
-- `zone` - (Optional) (Defaults to [provider](../index.md#zone) `region`) The [region](../guides/regions_and_zones.md#zones) in which the LB exists.
-
-- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the LB is associated with.
+- `ip_id` - (Optional) The load balancer IP ID.
 
 ## Attributes Reference
 
 In addition to all arguments above, the following attributes are exported:
 
 - `id` - The ID of the load-balancer.
-- `ip_address` -  The load-balancer public IP Address
-- `organization_id` - The organization ID the load-balancer is associated with.
-- `tags` - (Optional) The tags associated with the load-balancers.
-- `type` - (Required) The type of the load-balancer.
+
+- `ip_address` - The load-balancer public IP Address.
+
+- `type` - The type of the load-balancer.
+
+- `tags` - The tags associated with the load-balancers.
+
+- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the LB is associated with.
+
+- `zone` -  (Defaults to [provider](../index.md#zone) `region`) The [region](../guides/regions_and_zones.md#zones) in which the LB exists.

docs/resources/lb.md

@@ -14,13 +14,13 @@ For more information, see [the documentation](https://developers.scaleway.com/en
 ### Basic
 
 ```hcl
-resource "scaleway_lb_ip" "ip" {
+resource "scaleway_lb_ip" "main" {
   zone = "fr-par-1"
 }
 
 resource "scaleway_lb" "base" {
-  ip_id  = scaleway_lb_ip.ip.id
-  zone   = scaleway_lb_ip.ip.zone
+  ip_id  = scaleway_lb_ip.main.id
+  zone   = scaleway_lb_ip.main.zone
   type   = "LB-S"
 }
 ```
@@ -70,22 +70,22 @@ resource "scaleway_instance_server" "main" {
 }
 
 ### IP for LB IP
-resource scaleway_lb_ip ip01 {
+resource scaleway_lb_ip main {
 }
 
 ### Scaleway Private Network
-resource scaleway_vpc_private_network "static" {
+resource scaleway_vpc_private_network "main" {
     name = "private network with static config"
 }
 
 ### Scaleway Load Balancer
-resource scaleway_lb lb01 {
-    ip_id = scaleway_lb_ip.ip01.id
-    name = "test-lb-with-private-network-configs"
+resource scaleway_lb main {
+    ip_id = scaleway_lb_ip.main.id
+    name = "MyTest"
     type = "LB-S"
 
     private_network {
-        private_network_id = scaleway_vpc_private_network.static.id
+        private_network_id = scaleway_vpc_private_network.main.id
         static_config = ["172.16.0.100", "172.16.0.101"]
     }
 
@@ -102,13 +102,11 @@ resource scaleway_lb lb01 {
 
 The following arguments are supported:
 
-- `ip_id` - (Required) The ID of the associated IP. See below.
-
-~> **Important:** Updates to `ip_id` will recreate the load-balancer.
+- `ip_id` - (Required) The ID of the associated LB IP. See below.
 
-- `type` - (Required) The type of the load-balancer.
+~> **Important:** Updates to `ip_id` will not recreate the load-balancer.
 
-~> **Important:** Updates to `type` will recreate the load-balancer.
+- `type` - (Required) The type of the load-balancer. Please check the [migration section](#migration) to upgrade the type
 
 - `name` - (Optional) The name of the load-balancer.
 
@@ -130,6 +128,14 @@ In addition to all arguments above, the following attributes are exported:
 
 ~> **Important:** `release_ip` will not be supported. This prevents the destruction of the IP from releasing a LBs.
 The `resource_lb_ip` will be the only resource that handles those IPs.
+
+## Migration
+
+In order to migrate to other types you can check the migration up or down via our CLI `scw lb lb-types list`.
+this change will not recreate your Load Balancer.
+
+Please check our [documentation](https://developers.scaleway.com/en/products/lb/zoned_api/#post-355592) for further details
+
 ## IP ID
 
 Since v1.15.0, `ip_id` is a required field. This means that now a separate `scaleway_lb_ip` is required.
@@ -139,7 +145,7 @@ When upgrading to v1.15.0, you will need to create a new `scaleway_lb_ip` resour
 For instance, if you had the following:
 
 ```hcl
-resource "scaleway_lb" "base" {
+resource "scaleway_lb" "main" {
   zone = "fr-par-1"
   type   = "LB-S"
 }
@@ -148,11 +154,11 @@ resource "scaleway_lb" "base" {
 You will need to update it to:
 
 ```hcl
-resource "scaleway_lb_ip" "ip" {
+resource "scaleway_lb_ip" "main" {
 }
 
-resource "scaleway_lb" "base" {
-  ip_id  = scaleway_lb_ip.ip.id
+resource "scaleway_lb" "main" {
+  ip_id  = scaleway_lb_ip.main.id
   zone = "fr-par-1"
   type   = "LB-S"
   release_ip = false
@@ -162,29 +168,31 @@ resource "scaleway_lb" "base" {
 ## Private Network with static config
 
 ```hcl
-resource scaleway_lb_ip ip01 {
+resource scaleway_lb_ip main {
 }
 
-resource scaleway_vpc_private_network pnLB01 {
-    name = "pn-with-lb-static"
+resource scaleway_vpc_private_network main {
+    name = "MyTest"
 }
 
-resource scaleway_lb lb01 {
-    ip_id = scaleway_lb_ip.ip01.id
-    name = "test-lb-with-pn-static-2"
+resource scaleway_lb main {
+    ip_id = scaleway_lb_ip.main.id
+    name = "MyTest"
     type = "LB-S"
     release_ip = false
     private_network {
-        private_network_id = scaleway_vpc_private_network.pnLB01.id
+        private_network_id = scaleway_vpc_private_network.main.id
         static_config = ["172.16.0.100", "172.16.0.101"]
     }
 }
 ```
 
-~> **Important:** Updates to `private_network` will recreate the attachment.
+## Attributes Reference
 
 - `private_network_id` - (Required) The ID of the Private Network to associate.
 
+- ~> **Important:** Updates to `private_network` will recreate the attachment.
+
 - `static_config` - (Optional) Define two local ip address of your choice for each load balancer instance. See below.
 
 - `dhcp_config` - (Optional) Set to true if you want to let DHCP assign IP addresses. See below.
@@ -193,32 +201,13 @@ resource scaleway_lb lb01 {
 
 - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the private network was created.
 
-## Attributes Reference
-
-In addition to all arguments above, the following attributes are exported:
-
-- `status` -  The Private Network attachment status
-
-And before running `terraform apply` you will need to import the IP with:
-
-```bash
-$ terraform import scaleway_lb_ip.ip fr-par/11111111-1111-1111-1111-111111111111
-```
-
-The IP ID can either be found in the console, or you can run:
-
-```bash
-$ terraform state show scaleway_lb.base
-```
-
-and look for `ip_id`.
 
 ## Import
 
 Load-Balancer can be imported using the `{zone}/{id}`, e.g.
 
 ```bash
-$ terraform import scaleway_lb.lb01 fr-par-1/11111111-1111-1111-1111-111111111111
+$ terraform import scaleway_lb.main fr-par-1/11111111-1111-1111-1111-111111111111
 ```
 
 Be aware that you will also need to import the `scaleway_lb_ip` resource.

scaleway/resource_lb.go

@@ -48,7 +48,6 @@ func resourceScalewayLb() *schema.Resource {
 			"type": {
 				Type:             schema.TypeString,
 				Required:         true,
-				ForceNew:         true,
 				DiffSuppressFunc: diffSuppressFuncIgnoreCase,
 				Description:      "The type of load-balancer you want to create",
 			},
@@ -66,6 +65,7 @@ func resourceScalewayLb() *schema.Resource {
 				ForceNew:         true,
 				Description:      "The load-balance public IP ID",
 				DiffSuppressFunc: diffSuppressFuncLocality,
+				ValidateFunc:     validationUUIDorUUIDWithLocality(),
 			},
 			"ip_address": {
 				Type:        schema.TypeString,
@@ -229,6 +229,25 @@ func resourceScalewayLbUpdate(ctx context.Context, d *schema.ResourceData, meta
 		return diag.FromErr(err)
 	}
 
+	if d.HasChange("type") {
+		lbType := d.Get("type").(string)
+		migrateReq := &lbSDK.ZonedAPIMigrateLBRequest{
+			Zone: zone,
+			LBID: ID,
+			Type: lbType,
+		}
+
+		lb, err := lbAPI.MigrateLB(migrateReq, scw.WithContext(ctx))
+		if err != nil {
+			diag.FromErr(fmt.Errorf("couldn't migrate load balancer on type: %s. error: %w", lb.Type, err))
+		}
+
+		_, err = waitForLB(ctx, lbAPI, zone, lb.ID, d.Timeout(schema.TimeoutUpdate))
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	}
+
 	if d.HasChanges("name", "tags") {
 		req := &lbSDK.ZonedAPIUpdateLBRequest{
 			Zone: zone,

scaleway/resource_lb_test.go

@@ -61,6 +61,117 @@ func testSweepLB(_ string) error {
 	})
 }
 
+func TestAccScalewayLbLb_Migrate(t *testing.T) {
+	tt := NewTestTools(t)
+	defer tt.Cleanup()
+
+	lbID := ""
+
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy:      testAccCheckScalewayLbDestroy(tt),
+		Steps: []resource.TestStep{
+			{
+				Config: `
+					### IP for LB IP
+					resource scaleway_lb_ip main {
+					}
+
+					resource scaleway_lb main {
+						ip_id = scaleway_lb_ip.main.id
+						name = "test-lb-migration"
+						type = "LB-S"
+						tags = ["basic", "tag2"]
+					}
+				`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayLbExists(tt, "scaleway_lb.main"),
+					func(s *terraform.State) error {
+						rs, ok := s.RootModule().Resources["scaleway_lb.main"]
+						if !ok {
+							return fmt.Errorf("resource not found: %s", "scaleway_lb.main")
+						}
+						lbID = rs.Primary.ID
+						return nil
+					},
+					resource.TestCheckResourceAttr("scaleway_lb.main", "type", "LB-S"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "name", "test-lb-migration"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "tags.#", "2"),
+				),
+			},
+			{
+				Config: `
+					### IP for LB IP
+					resource scaleway_lb_ip main {
+					}
+
+					resource scaleway_lb main {
+						ip_id = scaleway_lb_ip.main.id
+						name = "test-lb-migrate-lb-gp-m"
+						type = "LB-GP-M"
+						tags = ["migration"]
+					}
+				`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayLbExists(tt, "scaleway_lb.main"),
+					func(s *terraform.State) error {
+						rs, ok := s.RootModule().Resources["scaleway_lb.main"]
+						if !ok {
+							return fmt.Errorf("resource not found: %s", "scaleway_lb.main")
+						}
+						if rs.Primary.ID != lbID {
+							return fmt.Errorf("LB id has changed")
+						}
+						return nil
+					},
+					resource.TestCheckResourceAttr("scaleway_lb.main", "type", "LB-GP-M"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "name", "test-lb-migrate-lb-gp-m"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "tags.#", "1"),
+				),
+			},
+			{
+				Config: `
+					### IP for LB IP
+					resource scaleway_lb_ip main {
+					}
+
+					resource scaleway_lb main {
+						ip_id = scaleway_lb_ip.main.id
+						name = "test-lb-migrate-lb-gp-m"
+						type = "LB-GP-M"
+					}
+				`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayLbExists(tt, "scaleway_lb.main"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "type", "LB-GP-M"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "name", "test-lb-migrate-lb-gp-m"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "tags.#", "0"),
+				),
+			},
+			{
+				Config: `
+					### IP for LB IP
+					resource scaleway_lb_ip main {
+					}
+
+					resource scaleway_lb main {
+						ip_id = scaleway_lb_ip.main.id
+						name = "test-lb-migrate-down"
+						type = "LB-S"
+					}
+				`,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckScalewayLbExists(tt, "scaleway_lb.main"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "type", "LB-S"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "name", "test-lb-migrate-down"),
+					resource.TestCheckResourceAttr("scaleway_lb.main", "tags.#", "0"),
+				),
+			},
+		},
+	})
+}
+
 func TestAccScalewayLbLb_WithIP(t *testing.T) {
 	tt := NewTestTools(t)
 	defer tt.Cleanup()