fix(rdb): update endpoints handling (#2308)

* fix(rdb): update endpoints handling

* record conflicting cassettes

* update doc with examples

* update conflicting cassettes

Author: Mia-Cross

docs/resources/rdb_instance.md

@@ -24,25 +24,6 @@ resource "scaleway_rdb_instance" "main" {
 }
 ```
 
-### Example With IPAM
-
-```hcl
-resource "scaleway_vpc_private_network" "pn" {}
-
-resource "scaleway_rdb_instance" "main" {
-  name           = "test-rdb"
-  node_type      = "DB-DEV-S"
-  engine         = "PostgreSQL-11"
-  is_ha_cluster  = true
-  disable_backup = true
-  user_name      = "my_initial_user"
-  password       = "thiZ_is_v&ry_s3cret"
-  private_network {
-    pn_id = scaleway_vpc_private_network.pn.id
-  }
-}
-```
-
 ### Example with Settings
 
 ```hcl
@@ -79,38 +60,57 @@ resource "scaleway_rdb_instance" "main" {
 }
 ```
 
-### Example with custom private network
+### Examples of endpoints configuration
+
+RDB Instances can have a maximum of 1 public endpoint and 1 private endpoint. It can have both, or none.
+
+#### 1 static private network endpoint
 
 ```hcl
-# VPC PRIVATE NETWORK
 resource "scaleway_vpc_private_network" "pn" {
-  name = "my_private_network"
   ipv4_subnet {
     subnet = "172.16.20.0/22"
   }
 }
 
-# RDB INSTANCE CONNECTED ON A CUSTOM PRIVATE NETWORK
 resource "scaleway_rdb_instance" "main" {
-  name              = "test-rdb"
   node_type         = "db-dev-s"
   engine            = "PostgreSQL-11"
-  is_ha_cluster     = false
-  disable_backup    = true
-  user_name         = "my_initial_user"
-  password          = "thiZ_is_v&ry_s3cret"
-  region            = "fr-par"
-  tags              = ["terraform-test", "scaleway_rdb_instance", "volume", "rdb_pn"]
-  volume_type       = "bssd"
-  volume_size_in_gb = 10
   private_network {
-    ip_net = "172.16.20.4/22" # IP address within a given IP network
     pn_id  = scaleway_vpc_private_network.pn.id
+    ip_net = "172.16.20.4/22"   # IP address within a given IP network
+    (enable_ipam = false)
   }
-  disable_public_endpoint = true
 }
 ```
 
+#### 1 IPAM private network endpoint + 1 public endpoint
+
+```hcl
+resource "scaleway_vpc_private_network" "pn" {}
+
+resource "scaleway_rdb_instance" "main" {
+  node_type      = "DB-DEV-S"
+  engine         = "PostgreSQL-11"
+  private_network {
+    pn_id = scaleway_vpc_private_network.pn.id
+    (enable_ipam = true)
+  }
+  load_balancer {}
+}
+```
+
+#### Default: 1 public endpoint
+
+```hcl
+resource "scaleway_rdb_instance" "main" {
+  node_type         = "db-dev-s"
+  engine            = "PostgreSQL-11"
+}  
+```
+
+-> If nothing is defined, your instance will have a default public load-balancer endpoint
+
 ## Arguments Reference
 
 The following arguments are supported:
@@ -145,6 +145,16 @@ and if you are using `bssd` storage, you should increase the volume size before
 
 - `name` - (Optional) The name of the Database Instance.
 
+- `tags` - (Optional) The tags associated with the Database Instance.
+
+- `region` - (Defaults to [provider](../index.md#arguments-reference) `region`) The [region](../guides/regions_and_zones.md#regions)
+  in which the Database Instance should be created.
+
+- `project_id` - (Defaults to [provider](../index.md#arguments-reference) `project_id`) The ID of the project the Database
+  Instance is associated with.
+
+### Backups
+
 - `disable_backup` - (Optional) Disable automated backup for the database instance.
 
 - `backup_schedule_frequency` - (Optional) Backup schedule frequency in hours.
@@ -153,40 +163,32 @@ and if you are using `bssd` storage, you should increase the volume size before
 
 - `backup_same_region` - (Optional) Boolean to store logical backups in the same region as the database instance.
 
-- `init_settings` - (Optional) Map of engine settings to be set at database initialisation.
-
-~> **Important:** Updates to `init_settings` will recreate the Database Instance.
+### Settings
 
 - `settings` - (Optional) Map of engine settings to be set. Using this option will override default config.
 
-- `tags` - (Optional) The tags associated with the Database Instance.
-
-- `disable_public_endpoint` - (Optional) Disable the default public endpoint
-
-- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions)
-  in which the Database Instance should be created.
-
-- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the Database
-  Instance is associated with.
+- `init_settings` - (Optional) Map of engine settings to be set at database initialisation.
 
-## Settings
+~> **Important:** Updates to `init_settings` will recreate the Database Instance.
 
-Please consult
-the [GoDoc](https://pkg.go.dev/github.com/scaleway/[email protected]/api/rdb/v1#EngineVersion) to list all
-available `settings` and `init_settings` on your `node_type` of your convenient.
+Please consult the [GoDoc](https://pkg.go.dev/github.com/scaleway/[email protected]/api/rdb/v1#EngineVersion) to list all available `settings` and `init_settings` for the `node_type` of your convenience.
 
-## Private Network
+### Endpoints
 
-~> **Important:** Updates to `private_network` will recreate the attachment Instance.
+- `private_network` - List of private networks endpoints of the database instance.
 
-~> **NOTE:** Please calculate your host IP.
-using [cirhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost). Otherwise, lets IPAM service
+    - `pn_id` - (Required) The ID of the private network.
+    - `enable_ipam` - (Optional) Whether the endpoint should be configured with IPAM. Defaults to `false` if `ip_net` is defined, `true` otherwise.
+    - `ip_net` - (Optional) The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation.
+    The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
+  
+~> **NOTE:** Please calculate your host IP using [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost). Otherwise, let IPAM service
 handle the host IP on the network.
 
-- `ip_net` - (Optional) The IP network address within the private subnet. This must be an IPv4 address with a
-  CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM)
-  service if not set.
-- `pn_id` - (Required) The ID of the private network.
+~> **Important:** Updates to `private_network` will recreate the Instance's endpoint
+
+- `load_balancer` - (Optional) List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is.
+This block must be defined if you want a public endpoint in addition to your private endpoint.
 
 ## Attributes Reference
 

scaleway/data_source_ipam_ip_test.go

@@ -139,7 +139,7 @@ func TestAccScalewayDataSourceIPAMIP_RDB(t *testing.T) {
 					}
 
 					resource scaleway_rdb_instance main {
-						name = "test-rdb"
+						name = "test-ipam-ip-rdb"
 						node_type = "db-dev-s"
 						engine = "PostgreSQL-14"
 						is_ha_cluster = false

scaleway/helpers_rdb.go

@@ -9,6 +9,7 @@ import (
 	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"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"
 )
@@ -108,28 +109,30 @@ func waitForRDBReadReplica(ctx context.Context, api *rdb.API, region scw.Region,
 	}, scw.WithContext(ctx))
 }
 
-func expandPrivateNetwork(data interface{}, exist bool) ([]*rdb.EndpointSpec, error) {
+func expandPrivateNetwork(data interface{}, exist bool, enableIpam bool) ([]*rdb.EndpointSpec, error) {
 	if data == nil || !exist {
 		return nil, nil
 	}
 
 	var res []*rdb.EndpointSpec
 	for _, pn := range data.([]interface{}) {
 		r := pn.(map[string]interface{})
-		ipNet := r["ip_net"].(string)
 		spec := &rdb.EndpointSpec{
 			PrivateNetwork: &rdb.EndpointSpecPrivateNetwork{
 				PrivateNetworkID: expandID(r["pn_id"].(string)),
 			},
 		}
-		if len(ipNet) > 0 {
-			ip, err := expandIPNet(r["ip_net"].(string))
-			if err != nil {
-				return res, err
-			}
-			spec.PrivateNetwork.ServiceIP = &ip
-		} else {
+		if enableIpam {
 			spec.PrivateNetwork.IpamConfig = &rdb.EndpointSpecPrivateNetworkIpamConfig{}
+		} else {
+			ipNet := r["ip_net"].(string)
+			if len(ipNet) > 0 {
+				ip, err := expandIPNet(r["ip_net"].(string))
+				if err != nil {
+					return res, err
+				}
+				spec.PrivateNetwork.ServiceIP = &ip
+			}
 		}
 		res = append(res, spec)
 	}
@@ -143,7 +146,7 @@ func expandLoadBalancer() *rdb.EndpointSpec {
 	}
 }
 
-func flattenPrivateNetwork(endpoints []*rdb.Endpoint) (interface{}, bool) {
+func flattenPrivateNetwork(endpoints []*rdb.Endpoint, enableIpam bool) (interface{}, bool) {
 	pnI := []map[string]interface{}(nil)
 	for _, endpoint := range endpoints {
 		if endpoint.PrivateNetwork != nil {
@@ -165,6 +168,7 @@ func flattenPrivateNetwork(endpoints []*rdb.Endpoint) (interface{}, bool) {
 				"ip_net":      serviceIP,
 				"pn_id":       pnRegionalID,
 				"hostname":    flattenStringPtr(endpoint.Hostname),
+				"enable_ipam": enableIpam,
 			})
 			return pnI, true
 		}
@@ -317,3 +321,26 @@ func rdbPrivilegeUpgradeV1SchemaType() cty.Type {
 		"id": cty.String,
 	})
 }
+
+func isIpamEndpoint(instance *rdb.Instance, meta interface{}) (bool, error) {
+	ipamAPI := ipam.NewAPI(meta.(*Meta).scwClient)
+
+	ips, err := ipamAPI.ListIPs(&ipam.ListIPsRequest{
+		Region:       instance.Region,
+		ResourceID:   &instance.ID,
+		ResourceType: "rdb_instance",
+		IsIPv6:       scw.BoolPtr(false),
+	}, scw.WithAllPages())
+	if err != nil {
+		return false, fmt.Errorf("could not list IPs: %w", err)
+	}
+
+	switch ips.TotalCount {
+	case 1:
+		return true, nil
+	case 0:
+		return false, nil
+	default:
+		return false, fmt.Errorf("expected no more than 1 IP for instance, got %d", ips.TotalCount)
+	}
+}