feat(instance): support ip mobility (#2086)

* feat(instance_ip): add type attribute

* add prefix and update doc

* update doc and add routed_ip_enabled to data sources

* support multiple IPs per instance

* lint

* lint doc

* add tests and fix issues to make them pass

* record tests

* remove extra test

* update doc link

* update cassettes

* update tests

* fix test and always set public_ip

* empty commit

Author: Codelax

docs/data-sources/instance_ip.md

@@ -41,6 +41,8 @@ In addition to all above arguments, the following attributes are exported:
 
 ~> **Important:** Instance IPs' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
 
+- `type` - The type of the IP
 - `address` - The IP address.
+- `prefix` - The IP Prefix.
 - `reverse` - The reverse dns attached to this IP
 - `organization_id` - The organization ID the IP is associated with.

docs/data-sources/instance_server.md

@@ -61,7 +61,9 @@ attached to the server.
 
 - `enable_ipv6` - Determines if IPv6 is enabled for the server.
 
-- `enable_dynamic_ip` - True is dynamic IP in enable on the server.
+- `enable_dynamic_ip` - True if dynamic IP in enable on the server.
+
+- `routed_ip_enabled` - True if the server support routed ip only.
 
 - `state` - The state of the server. Possible values are: `started`, `stopped` or `standby`.
 
@@ -80,7 +82,11 @@ attached to the server.
 
 - `private_ip` - The Scaleway internal IP address of the server.
 
-- `public_ip` - The public IPv4 address of the server.
+- `public_ip` - The public IP address of the server.
+
+- `public_ips` - The list of public IPs of the server
+    - `id` - The ID of the IP
+    - `address` - The address of the IP
 
 - `ipv6_address` - The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )
 

docs/data-sources/instance_servers.md

@@ -44,8 +44,12 @@ In addition to all above arguments, the following attributes are exported:
         ~> **Important:** Instance servers' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
 
     - `tags` - The tags associated with the server.
-    - `public_ip` - The public IPv4 address of the server.
+    - `public_ip` - The public IP address of the server.
     - `private_ip` - The Scaleway internal IP address of the server.
+    - `public_ips` - The list of public IPs of the server
+        - `id` - The ID of the IP
+        - `address` - The address of the IP
+    - `prefix` - The public IP prefix of the server.
     - `state` - The state of the server. Possible values are: `started`, `stopped` or `standby`.
     - `zone` - The [zone](../guides/regions_and_zones.md#zones) in which the server is.
     - `name` - The name of the server.
@@ -57,6 +61,7 @@ In addition to all above arguments, the following attributes are exported:
     - `ipv6_address` - The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )
     - `ipv6_gateway` - The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )
     - `ipv6_prefix_length` - The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )
+    - `routed_ip_enabled` - True if the server support routed ip only.
     - `enable_dynamic_ip` - If true a dynamic IP will be attached to the server.
     - `image` - The UUID or the label of the base image used by the server.
     - `placement_group_id` - The [placement group](https://developers.scaleway.com/en/products/instance/api/#placement-groups-d8f653) the server is attached to.

docs/resources/instance_ip.md

@@ -17,6 +17,10 @@ resource "scaleway_instance_ip" "server_ip" {}
 
 The following arguments are supported:
 
+- `type` - (Defaults to `nat`) The type of the IP (`nat`, `routed_ipv4`, `routed_ipv6`), more information in [the documentation](https://www.scaleway.com/en/docs/compute/instances/api-cli/using-routed-ips/)
+
+~> **Important:** An IP can migrate from `nat` to `routed_ipv4` but cannot be converted back
+
 - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the IP should be reserved.
 - `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the IP is associated with.
 
@@ -29,6 +33,7 @@ In addition to all above arguments, the following attributes are exported:
 ~> **Important:** Instance IPs' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
 
 - `address` - The IP address.
+- `prefix` - The IP Prefix.
 - `reverse` - The reverse dns attached to this IP
 - `organization_id` - The organization ID the IP is associated with.
 - `tags` - The tags associated with the IP.

docs/resources/instance_server.md

@@ -212,10 +212,16 @@ attached to the server. Updates to this field will trigger a stop/start of the s
 
 - `enable_ipv6` - (Defaults to `false`) Determines if IPv6 is enabled for the server.
 
-- `ip_id` = (Optional) The ID of the reserved IP that is attached to the server.
+- `ip_id` - (Optional) The ID of the reserved IP that is attached to the server.
+
+- `ip_ids` - (Optional) List of ID of reserved IPs that are attached to the server. Cannot be used with `ip_id`.
 
 - `enable_dynamic_ip` - (Defaults to `false`) If true a dynamic IP will be attached to the server.
 
+- `routed_ip_enabled` - (Defaults to `false`) If true, the server will support routed ips only. Changing it to true will migrate the server and its IP to routed type.
+
+~> **Important:** Enabling routed ip will restart the server
+
 - `state` - (Defaults to `started`) The state of the server. Possible values are: `started`, `stopped` or `standby`.
 
 - `user_data` - (Optional) The user data associated with the server.
@@ -232,7 +238,7 @@ attached to the server. Updates to this field will trigger a stop/start of the s
 
 - `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`).
+- `bootscript_id` (Deprecated) - 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.
 
@@ -265,7 +271,10 @@ In addition to all above arguments, the following attributes are exported:
 - `root_volume`
     - `volume_id` - The volume ID of the root volume of the server.
 - `private_ip` - The Scaleway internal IP address of the server.
-- `public_ip` - The public IPv4 address of the server.
+- `public_ip` - The public IP address of the server.
+- `public_ips` - The list of public IPs of the server.
+    - `id` - The ID of the IP
+    - `address` - The address of the IP
 - `ipv6_address` - The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )
 - `ipv6_gateway` - The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )
 - `ipv6_prefix_length` - The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )

scaleway/data_source_instance_servers.go

@@ -41,6 +41,22 @@ func dataSourceScalewayInstanceServers() *schema.Resource {
 							Computed: true,
 							Type:     schema.TypeString,
 						},
+						"public_ips": {
+							Type:     schema.TypeList,
+							Computed: true,
+							Elem: &schema.Resource{
+								Schema: map[string]*schema.Schema{
+									"id": {
+										Type:     schema.TypeString,
+										Computed: true,
+									},
+									"address": {
+										Type:     schema.TypeString,
+										Computed: true,
+									},
+								},
+							},
+						},
 						"private_ip": {
 							Computed: true,
 							Type:     schema.TypeString,
@@ -108,6 +124,10 @@ func dataSourceScalewayInstanceServers() *schema.Resource {
 							Computed: true,
 							Type:     schema.TypeInt,
 						},
+						"routed_ip_enabled": {
+							Computed: true,
+							Type:     schema.TypeBool,
+						},
 						"zone":            zoneSchema(),
 						"organization_id": organizationIDSchema(),
 						"project_id":      projectIDSchema(),
@@ -145,6 +165,9 @@ func dataSourceScalewayInstanceServersRead(ctx context.Context, d *schema.Resour
 		if server.PublicIP != nil {
 			rawServer["public_ip"] = server.PublicIP.Address.String()
 		}
+		if server.PublicIPs != nil {
+			rawServer["public_ips"] = flattenServerPublicIPs(server.Zone, server.PublicIPs)
+		}
 		if server.PrivateIP != nil {
 			rawServer["private_ip"] = *server.PrivateIP
 		}
@@ -165,6 +188,7 @@ func dataSourceScalewayInstanceServersRead(ctx context.Context, d *schema.Resour
 		rawServer["security_group_id"] = newZonedID(zone, server.SecurityGroup.ID).String()
 		rawServer["enable_ipv6"] = server.EnableIPv6
 		rawServer["enable_dynamic_ip"] = server.DynamicIPRequired
+		rawServer["routed_ip_enabled"] = server.RoutedIPEnabled
 		rawServer["organization_id"] = server.Organization
 		rawServer["project_id"] = server.Project
 		if server.Image != nil {

scaleway/helpers_instance.go

@@ -38,6 +38,9 @@ const (
 	defaultInstanceSnapshotWaitTimeout = 1 * time.Hour
 
 	defaultInstanceImageTimeout = 1 * time.Hour
+
+	// netIPNil define the nil string return by (*net.IP).String()
+	netIPNil = "<nil>"
 )
 
 // instanceAPIWithZone returns a new instance API and the zone for a Create request
@@ -624,3 +627,26 @@ func retryUpdateReverseDNS(ctx context.Context, instanceAPI *instance.API, req *
 		}
 	}
 }
+
+func flattenServerPublicIPs(zone scw.Zone, ips []*instance.ServerIP) []interface{} {
+	flattenedIPs := make([]interface{}, len(ips))
+
+	for i, ip := range ips {
+		flattenedIPs[i] = map[string]interface{}{
+			"id":      newZonedIDString(zone, ip.ID),
+			"address": ip.Address.String(),
+		}
+	}
+
+	return flattenedIPs
+}
+
+func flattenServerIPIDs(ips []*instance.ServerIP) []interface{} {
+	ipIDs := make([]interface{}, len(ips))
+
+	for i, ip := range ips {
+		ipIDs[i] = ip.ID
+	}
+
+	return ipIDs
+}

scaleway/helpers_k8s.go

@@ -156,10 +156,10 @@ func convertNodes(res *k8s.ListNodesResponse) []map[string]interface{} {
 		n := make(map[string]interface{})
 		n["name"] = node.Name
 		n["status"] = node.Status.String()
-		if node.PublicIPV4 != nil && node.PublicIPV4.String() != "<nil>" {
+		if node.PublicIPV4 != nil && node.PublicIPV4.String() != netIPNil {
 			n["public_ip"] = node.PublicIPV4.String()
 		}
-		if node.PublicIPV6 != nil && node.PublicIPV6.String() != "<nil>" {
+		if node.PublicIPV6 != nil && node.PublicIPV6.String() != netIPNil {
 			n["public_ip_v6"] = node.PublicIPV6.String()
 		}
 		result = append(result, n)

scaleway/resource_instance_ip.go

@@ -28,6 +28,17 @@ func resourceScalewayInstanceIP() *schema.Resource {
 				Computed:    true,
 				Description: "The IP address",
 			},
+			"prefix": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The IP prefix",
+			},
+			"type": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Optional:    true,
+				Description: "The type of instance IP",
+			},
 			"reverse": {
 				Type:        schema.TypeString,
 				Computed:    true,
@@ -50,6 +61,23 @@ func resourceScalewayInstanceIP() *schema.Resource {
 			"organization_id": organizationIDSchema(),
 			"project_id":      projectIDSchema(),
 		},
+		CustomizeDiff: func(ctx context.Context, diff *schema.ResourceDiff, i interface{}) error {
+			// The only allowed change is
+			// nat -> routed_ipv4
+			if diff.HasChange("type") {
+				before, after := diff.GetChange("type")
+				oldType := instance.IPType(before.(string))
+				newType := instance.IPType(after.(string))
+
+				if oldType == "nat" && newType == "routed_ipv4" {
+					return nil
+				}
+
+				return diff.ForceNew("type")
+			}
+
+			return nil
+		},
 	}
 }
 
@@ -61,6 +89,7 @@ func resourceScalewayInstanceIPCreate(ctx context.Context, d *schema.ResourceDat
 	iprequest := &instance.CreateIPRequest{
 		Zone:    zone,
 		Project: expandStringPtr(d.Get("project_id")),
+		Type:    instance.IPType(d.Get("type").(string)),
 	}
 	tags := expandStrings(d.Get("tags"))
 	if len(tags) > 0 {
@@ -103,6 +132,10 @@ func resourceScalewayInstanceIPUpdate(ctx context.Context, d *schema.ResourceDat
 		req.Tags = expandUpdatedStringsPtr(d.Get("tags"))
 	}
 
+	if d.HasChange("type") {
+		req.Type = instance.IPType(d.Get("type").(string))
+	}
+
 	_, err = instanceAPI.UpdateIP(req, scw.WithContext(ctx))
 	if err != nil {
 		return diag.FromErr(err)
@@ -130,11 +163,25 @@ func resourceScalewayInstanceIPRead(ctx context.Context, d *schema.ResourceData,
 		return diag.FromErr(err)
 	}
 
-	_ = d.Set("address", res.IP.Address.String())
+	address := res.IP.Address.String()
+	prefix := res.IP.Prefix.String()
+	if prefix == netIPNil {
+		ipnet := scw.IPNet{}
+		_ = (&ipnet).UnmarshalJSON([]byte("\"" + res.IP.Address.String() + "\""))
+		prefix = ipnet.String()
+	}
+	if address == netIPNil {
+		address = res.IP.Prefix.IP.String()
+	}
+
+	_ = d.Set("address", address)
+	_ = d.Set("prefix", prefix)
 	_ = d.Set("zone", zone)
 	_ = d.Set("organization_id", res.IP.Organization)
 	_ = d.Set("project_id", res.IP.Project)
 	_ = d.Set("reverse", res.IP.Reverse)
+	_ = d.Set("type", res.IP.Type)
+
 	if len(res.IP.Tags) > 0 {
 		_ = d.Set("tags", flattenSliceString(res.IP.Tags))
 	}