feat(redis): read cluster's private IPs

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

Author: Mia-Cross

docs/resources/redis_cluster.md

@@ -195,6 +195,10 @@ the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
     - `endpoint_id` - The ID of the endpoint.
     - `zone` - The zone of the Private Network.
 
+- `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.
+
 - `created_at` - The date and time of creation of the Redis™ cluster.
 - `updated_at` - The date and time of the last update of the Redis™ cluster.
 - `certificate` - The PEM of the certificate used by redis, only when `tls_enabled` is true

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/testdata/data-source-ipam-ips-redis-cluster.cassette.yaml

@@ -11,6 +11,7 @@ import (
 	"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"
+	ipamAPI "github.com/scaleway/scaleway-sdk-go/api/ipam/v1"
 	"github.com/scaleway/scaleway-sdk-go/api/redis/v1"
 	"github.com/scaleway/scaleway-sdk-go/scw"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/cdf"
@@ -19,6 +20,7 @@ import (
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/locality"
 	"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"
 )
@@ -193,6 +195,25 @@ func ResourceCluster() *schema.Resource {
 					},
 				},
 			},
+			"private_ips": {
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "List of private IP addresses associated with the resource",
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"id": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The ID of the IP address resource",
+						},
+						"address": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The private IP address",
+						},
+					},
+				},
+			},
 			"certificate": {
 				Type:        schema.TypeString,
 				Computed:    true,
@@ -344,11 +365,46 @@ func ResourceClusterRead(ctx context.Context, d *schema.ResourceData, m interfac
 	}
 
 	// set endpoints
+	var allPrivateIPs []map[string]interface{}
+
 	pnI, pnExists := flattenPrivateNetwork(cluster.Endpoints)
 	if pnExists {
 		_ = d.Set("private_network", pnI)
+
+		privateNetworkIDs := []string(nil)
+
+		for _, endpoint := range cluster.Endpoints {
+			if endpoint.PrivateNetwork != nil {
+				privateNetworkIDs = append(privateNetworkIDs, endpoint.PrivateNetwork.ID)
+			}
+		}
+
+		resourceType := ipamAPI.ResourceTypeRedisCluster
+
+		region, err := zone.Region()
+		if err != nil {
+			return diag.FromErr(err)
+		}
+
+		for _, privateNetworkID := range privateNetworkIDs {
+			opts := &ipam.GetResourcePrivateIPsOptions{
+				ResourceType:     &resourceType,
+				PrivateNetworkID: &privateNetworkID,
+				ResourceID:       &cluster.ID,
+			}
+
+			privateIPs, err := ipam.GetResourcePrivateIPs(ctx, m, region, opts)
+			if err != nil {
+				return diag.FromErr(err)
+			}
+
+			if privateIPs != nil {
+				allPrivateIPs = append(allPrivateIPs, privateIPs...)
+			}
+		}
 	}
 
+	_ = d.Set("private_ips", allPrivateIPs)
 	_ = d.Set("public_network", flattenPublicNetwork(cluster.Endpoints))
 
 	if cluster.TLSEnabled {

internal/services/redis/cluster.go

@@ -216,6 +216,12 @@ func TestAccCluster_MigrateClusterSizeWithIPAMEndpoint(t *testing.T) {
 					resource.TestCheckResourceAttr("scaleway_redis_cluster.main", "tls_enabled", "true"),
 					resource.TestCheckResourceAttrPair("scaleway_redis_cluster.main", "private_network.0.id", "scaleway_vpc_private_network.private_network", "id"),
 					acctest.CheckResourceIDChanged("scaleway_redis_cluster.main", &clusterID),
+					resource.TestCheckResourceAttrSet("scaleway_redis_cluster.main", "private_ips.0.id"),
+					resource.TestCheckResourceAttrSet("scaleway_redis_cluster.main", "private_ips.0.address"),
+					resource.TestCheckResourceAttrSet("scaleway_redis_cluster.main", "private_ips.1.id"),
+					resource.TestCheckResourceAttrSet("scaleway_redis_cluster.main", "private_ips.1.address"),
+					resource.TestCheckResourceAttrSet("scaleway_redis_cluster.main", "private_ips.2.id"),
+					resource.TestCheckResourceAttrSet("scaleway_redis_cluster.main", "private_ips.2.address"),
 				),
 			},
 		},