feat(ipam): add support for ip reverse dns (#2377)

* feat(ipam): add support for ip reverse dns

* fix

* lint

Author: yfodil

docs/resources/ipam_ip.md

@@ -98,6 +98,9 @@ In addition to all arguments above, the following attributes are exported:
     - `type` - The type of resource the IP is attached to.
     - `name` - The name of the resource the IP is attached to.
     - `mac_address` - The MAC Address of the resource the IP is attached to.
+- `reverses` - The reverses DNS for this IP.
+    - `hostname` The reverse domain name.
+    - `address` The IP corresponding to the hostname.
 - `created_at` - Date and time of IP's creation (RFC 3339 format).
 - `updated_at` - Date and time of IP's last update (RFC 3339 format).
 - `zone` - The zone of the IP.

docs/resources/ipam_ip_reverse_dns.md

@@ -0,0 +1,73 @@
+---
+subcategory: "IPAM"
+page_title: "Scaleway: scaleway_ipam_ip_reverse_dns"
+---
+
+# Resource: scaleway_ipam_ip_reverse_dns
+
+Manages Scaleway IPAM IP Reverse DNS.
+
+## Example Usage
+
+```terraform
+resource "scaleway_instance_ip" "ip01" {
+  type = "routed_ipv6"
+}
+
+resource "scaleway_instance_server" "srv01" {
+  name   = "tf-tests-instance-server-ips"
+  ip_ids = [scaleway_instance_ip.ip01.id]
+  image  = "ubuntu_jammy"
+  type   = "PRO2-XXS"
+  state  = "stopped"
+}
+
+data "scaleway_ipam_ip" "ipam01" {
+  resource {
+    id   = scaleway_instance_server.srv01.id
+    type = "instance_server"
+  }
+  type = "ipv6"
+}
+
+resource "scaleway_domain_record" "tf_AAAA" {
+  dns_zone = "example.com"
+  name     = ""
+  type     = "AAAA"
+  data     = cidrhost(data.scaleway_ipam_ip.ipam01.address_cidr, 42)
+  ttl      = 3600
+  priority = 1
+}
+
+resource "scaleway_ipam_ip_reverse_dns" "base" {
+  ipam_ip_id = data.scaleway_ipam_ip.ipam01.id
+
+  hostname   = "example.com"
+  address    = cidrhost(data.scaleway_ipam_ip.ipam01.address_cidr, 42)
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+- `ipam_ip_id` - (Required) The IPAM IP ID.
+- `hostname` - (Required) The reverse domain name.
+- `address` - (Required) The IP corresponding to the hostname.
+- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) of the IP reverse DNS.
+
+## Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+- `id` - The ID of the IPAM IP for which the DNS reverse is configured.
+
+~> **Important:** IPAM IPs' IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111
+
+## Import
+
+IPAM IP reverse DNS can be imported using the `{region}/{id}`, e.g.
+
+```bash
+$ terraform import scaleway_ipam_ip_reverse_dns.main fr-par/11111111-1111-1111-1111-111111111111
+```

docs/resources/vpc_public_gateway_ip_reverse_dns.md

@@ -33,7 +33,7 @@ resource "scaleway_vpc_public_gateway_ip_reverse_dns" "main" {
 The following arguments are supported:
 
 - `gateway_ip_id` - (Required) The public gateway IP ID
-- `reverse` - (Optional) The reverse domain name for this IP address
+- `reverse` - (Required) The reverse domain name for this IP address
 - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the IP should be reserved.
 
 ## Attributes Reference
@@ -50,5 +50,5 @@ In addition to all arguments above, the following attributes are exported:
 Public gateway IPs reverse DNS can be imported using the `{zone}/{id}`, e.g.
 
 ```bash
-$ terraform import scaleway_vpc_public_gateway_ip_reverse_dns.reverse.main fr-par-1/11111111-1111-1111-1111-111111111111
+$ terraform import scaleway_vpc_public_gateway_ip_reverse_dns.reverse fr-par-1/11111111-1111-1111-1111-111111111111
 ```

go.mod

@@ -16,7 +16,7 @@ require (
 	github.com/nats-io/jwt/v2 v2.5.3
 	github.com/nats-io/nats.go v1.31.0
 	github.com/robfig/cron/v3 v3.0.1
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240109155607-70eec6dc9637
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240111155519-dc916e73b792
 	github.com/stretchr/testify v1.8.4
 )
 

go.sum

@@ -186,8 +186,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.22.0.20240109155607-70eec6dc9637 h1:F/EUOngL9fqQsi3JHn8S6n8oJasOCFk5J/76D+n3s2g=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240109155607-70eec6dc9637/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240111155519-dc916e73b792 h1:BzcfWlk1hgYSoASs21qalFTORNwK3fK8x5f4PcsOp/I=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22.0.20240111155519-dc916e73b792/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
 github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
 github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
 github.com/skeema/knownhosts v1.2.1 h1:SHWdIUa82uGZz+F+47k8SY4QhhI291cXCpopT1lK2AQ=

scaleway/helpers_ipam.go

@@ -3,13 +3,18 @@ package scaleway
 import (
 	"net"
 	"strings"
+	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	ipam "github.com/scaleway/scaleway-sdk-go/api/ipam/v1"
 	"github.com/scaleway/scaleway-sdk-go/scw"
 	"github.com/scaleway/scaleway-sdk-go/validation"
 )
 
+const (
+	defaultIPAMIPReverseDNSTimeout = 10 * time.Minute
+)
+
 // ipamAPIWithRegion returns a new ipam API and the region
 func ipamAPIWithRegion(d *schema.ResourceData, m interface{}) (*ipam.API, scw.Region, error) {
 	meta := m.(*Meta)
@@ -93,6 +98,25 @@ func flattenIPResource(resource *ipam.Resource) interface{} {
 	}
 }
 
+func flattenIPReverse(reverse *ipam.Reverse) interface{} {
+	if reverse == nil {
+		return nil
+	}
+
+	return map[string]interface{}{
+		"hostname": reverse.Hostname,
+		"address":  flattenIPPtr(reverse.Address),
+	}
+}
+
+func flattenIPReverses(reverses []*ipam.Reverse) interface{} {
+	rawReverses := make([]interface{}, 0, len(reverses))
+	for _, reverse := range reverses {
+		rawReverses = append(rawReverses, flattenIPReverse(reverse))
+	}
+	return rawReverses
+}
+
 func checkSubnetIDInFlattenedSubnets(subnetID string, flattenedSubnets interface{}) bool {
 	for _, subnet := range flattenedSubnets.([]map[string]interface{}) {
 		if subnet["id"].(string) == subnetID {

scaleway/helpers_vpcgw.go

@@ -2,7 +2,6 @@ package scaleway
 
 import (
 	"context"
-	"errors"
 	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -93,30 +92,14 @@ func waitForDHCPEntries(ctx context.Context, api *vpcgw.API, zone scw.Zone, gate
 	return dhcpEntries, err
 }
 
-func isGatewayReverseDNSResolveError(err error) bool {
-	invalidArgError := &scw.InvalidArgumentsError{}
-
-	if !errors.As(err, &invalidArgError) {
-		return false
-	}
-
-	for _, fields := range invalidArgError.Details {
-		if fields.ArgumentName == "reverse" {
-			return true
-		}
-	}
-
-	return false
-}
-
 func retryUpdateGatewayReverseDNS(ctx context.Context, api *vpcgw.API, req *vpcgw.UpdateIPRequest, timeout time.Duration) error {
 	timeoutChannel := time.After(timeout)
 
 	for {
 		select {
 		case <-time.After(defaultVPCGatewayRetry):
 			_, err := api.UpdateIP(req, scw.WithContext(ctx))
-			if err != nil && isGatewayReverseDNSResolveError(err) {
+			if err != nil && isIPReverseDNSResolveError(err) {
 				continue
 			}
 			return err

scaleway/provider.go

@@ -136,6 +136,7 @@ func Provider(config *ProviderConfig) plugin.ProviderFunc {
 				"scaleway_iot_route":                           resourceScalewayIotRoute(),
 				"scaleway_iot_network":                         resourceScalewayIotNetwork(),
 				"scaleway_ipam_ip":                             resourceScalewayIPAMIP(),
+				"scaleway_ipam_ip_reverse_dns":                 resourceScalewayIPAMIPReverseDNS(),
 				"scaleway_job_definition":                      resourceScalewayJobDefinition(),
 				"scaleway_k8s_cluster":                         resourceScalewayK8SCluster(),
 				"scaleway_k8s_pool":                            resourceScalewayK8SPool(),

scaleway/resource_ipam_ip.go

@@ -107,6 +107,25 @@ func resourceScalewayIPAMIP() *schema.Resource {
 					},
 				},
 			},
+			"reverses": {
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "The reverses DNS for this IP",
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"hostname": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The reverse domain name",
+						},
+						"address": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The IP corresponding to the hostname",
+						},
+					},
+				},
+			},
 			"created_at": {
 				Type:        schema.TypeString,
 				Computed:    true,
@@ -229,6 +248,7 @@ func resourceScalewayIPAMIPRead(ctx context.Context, d *schema.ResourceData, met
 	if len(res.Tags) > 0 {
 		_ = d.Set("tags", res.Tags)
 	}
+	_ = d.Set("reverses", flattenIPReverses(res.Reverses))
 
 	return nil
 }