feat(rdb): read instance's private IPs

Co-authored-by: Yacine FODIL <[email protected]>

Author: Mia-Cross

docs/resources/rdb_instance.md

@@ -238,6 +238,9 @@ are of the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-1111111111
     - `port` - Port in the Private Network.
     - `name` - Name of the endpoint.
     - `hostname` - Hostname of the endpoint.
+- `private_ip` - The list of private IPv4 addresses associated with the resource.
+    - `id` - The ID of the IPv4 address resource.
+    - `address` - The private IPv4 address.
 - `certificate` - Certificate of the Database Instance.
 - `organization_id` - The organization ID the Database Instance is associated with.
 

internal/services/ipam/helpers.go

@@ -1,6 +1,8 @@
 package ipam
 
 import (
+	"context"
+	"fmt"
 	"net"
 	"time"
 
@@ -65,3 +67,63 @@ func diffSuppressFuncStandaloneIPandCIDR(_, oldValue, newValue string, _ *schema
 
 	return false
 }
+
+type GetResourcePrivateIPsOptions struct {
+	ResourceType     *ipam.ResourceType
+	ResourceID       *string
+	ResourceName     *string
+	PrivateNetworkID *string
+}
+
+// GetResourcePrivateIPs fetches the private IP addresses of a resource in a private network.
+func GetResourcePrivateIPs(ctx context.Context, m interface{}, region scw.Region, opts *GetResourcePrivateIPsOptions) ([]map[string]interface{}, error) {
+	ipamAPI := ipam.NewAPI(meta.ExtractScwClient(m))
+
+	req := &ipam.ListIPsRequest{
+		Region: region,
+	}
+
+	if opts != nil {
+		if opts.PrivateNetworkID != nil {
+			req.PrivateNetworkID = opts.PrivateNetworkID
+		}
+
+		if opts.ResourceID != nil {
+			req.ResourceID = opts.ResourceID
+		}
+
+		if opts.ResourceName != nil {
+			req.ResourceName = opts.ResourceName
+		}
+
+		if opts.ResourceType != nil {
+			req.ResourceType = *opts.ResourceType
+		}
+	}
+
+	resp, err := ipamAPI.ListIPs(req, scw.WithContext(ctx))
+	if err != nil {
+		return nil, fmt.Errorf("error fetching IPs from IPAM: %w", err)
+	}
+
+	if len(resp.IPs) == 0 {
+		return nil, nil
+	}
+
+	ipList := make([]map[string]interface{}, 0, len(resp.IPs))
+
+	for _, ip := range resp.IPs {
+		ipNet := ip.Address
+		if ipNet.IP == nil {
+			continue
+		}
+
+		ipMap := map[string]interface{}{
+			"id":      regional.NewIDString(region, ip.ID),
+			"address": ipNet.IP.String(),
+		}
+		ipList = append(ipList, ipMap)
+	}
+
+	return ipList, nil
+}

internal/services/ipam/ip_data_source_test.go

@@ -151,8 +151,6 @@ func TestAccDataSourceIPAMIP_RDB(t *testing.T) {
 						user_name = "my_initial_user"
 						password = "thiZ_is_v&ry_s3cret"
 						tags = [ "terraform-test", "scaleway_rdb_instance", "volume", "rdb_pn" ]
-						volume_type = "bssd"
-						volume_size_in_gb = 10
 						private_network {
 							pn_id = "${scaleway_vpc_private_network.main.id}"
 							enable_ipam = true

internal/services/ipam/testdata/data-source-ipamiprdb.cassette.yaml

@@ -10,6 +10,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
+	ipamAPI "github.com/scaleway/scaleway-sdk-go/api/ipam/v1"
 	"github.com/scaleway/scaleway-sdk-go/api/rdb/v1"
 	"github.com/scaleway/scaleway-sdk-go/scw"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/cdf"
@@ -18,6 +19,7 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/locality/regional"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/locality/zonal"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/services/account"
+	"github.com/scaleway/terraform-provider-scaleway/v2/internal/services/ipam"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/types"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/verify"
 )
@@ -322,6 +324,25 @@ func ResourceInstance() *schema.Resource {
 				Optional:    true,
 				Description: "Enable or disable encryption at rest for the database instance",
 			},
+			"private_ips": {
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "List of private IPv4 addresses associated with the resource",
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"id": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The ID of the IPv4 address resource",
+						},
+						"address": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The private IPv4 address",
+						},
+					},
+				},
+			},
 			// Common
 			"region":          regional.Schema(),
 			"organization_id": account.OrganizationIDSchema(),
@@ -640,10 +661,36 @@ func ResourceRdbInstanceRead(ctx context.Context, d *schema.ResourceData, m inte
 	_ = d.Set("logs_policy", flattenInstanceLogsPolicy(res.LogsPolicy))
 
 	// set endpoints
+	var privateIPs []map[string]interface{}
+
 	if pnI, pnExist := flattenPrivateNetwork(res.Endpoints); pnExist {
 		_ = d.Set("private_network", pnI)
+
+		for _, endpoint := range res.Endpoints {
+			if endpoint.PrivateNetwork == nil {
+				continue
+			}
+
+			if endpoint.PrivateNetwork.ProvisioningMode == rdb.EndpointPrivateNetworkDetailsProvisioningModeIpam {
+				resourceType := ipamAPI.ResourceTypeRdbInstance
+				opts := &ipam.GetResourcePrivateIPsOptions{
+					ResourceID:       &res.ID,
+					ResourceType:     &resourceType,
+					PrivateNetworkID: &res.Endpoints[0].PrivateNetwork.PrivateNetworkID,
+				}
+
+				endpointPrivateIPs, err := ipam.GetResourcePrivateIPs(ctx, m, region, opts)
+				if err != nil {
+					return diag.FromErr(err)
+				}
+
+				privateIPs = append(privateIPs, endpointPrivateIPs...)
+			}
+		}
 	}
 
+	_ = d.Set("private_ips", privateIPs)
+
 	if lbI, lbExists := flattenLoadBalancer(res.Endpoints); lbExists {
 		_ = d.Set("load_balancer", lbI)
 	}

internal/services/rdb/instance.go

@@ -990,6 +990,8 @@ func TestAccInstance_Endpoints(t *testing.T) {
 					resource.TestCheckResourceAttr("scaleway_rdb_instance.test_endpoints", "load_balancer.#", "0"),
 					resource.TestCheckResourceAttr("scaleway_rdb_instance.test_endpoints", "endpoint_ip", ""),    // Deprecated attribute, might be deleted later
 					resource.TestCheckResourceAttr("scaleway_rdb_instance.test_endpoints", "endpoint_port", "0"), // Deprecated attribute, might be deleted later
+					resource.TestCheckResourceAttrSet("scaleway_rdb_instance.test_endpoints", "private_ips.0.id"),
+					resource.TestCheckResourceAttrSet("scaleway_rdb_instance.test_endpoints", "private_ips.0.address"),
 				),
 			},
 			{