TPT-4479: Added support for Configurable VPC IPv4 Prefixes (#2402) (#2406)

* Added datasource for GET vpcs/default_ranges

* Added support for IPv4 in VPC resource/datasource and VPCs datasource

* Fix docs

* Address CoPilot suggestion

* Address PR comments

* Remove LKE fix since it is out of scope

* Fix tests

* More fixes

* More fixes

* Remove custom type from ResourceSchemaIPv4NestedObject range attribute

* Address CoPilot suggestions

Author: ezilber-akamai

.github/workflows/integration_tests.yml

@@ -70,7 +70,7 @@ jobs:
               echo "LINODE_CONSUMER_TOKEN=${{ secrets.LINODE_TOKEN_USER_2 }}" >> $GITHUB_ENV
               ;;
             "USER_2")
-              echo "TEST_SUITE=databasemysqlv2,firewall,firewallsettings,firewalltemplate,firewalltemplates,firewalldevice,firewalls,image,images,instancenetworking,instancesharedips,instancetype,instancetypes,ipv6range,ipv6ranges,kernel,kernels,lock,locks,nb,nbconfig,nbconfigs,nbnode,nbs,nbvpc,nbvpcs,sshkey,sshkeys,vlan,volume,volumes,vpc,vpcs,vpcsubnets,vpcips" >> $GITHUB_ENV
+              echo "TEST_SUITE=databasemysqlv2,firewall,firewallsettings,firewalltemplate,firewalltemplates,firewalldevice,firewalls,image,images,instancenetworking,instancesharedips,instancetype,instancetypes,ipv6range,ipv6ranges,kernel,kernels,lock,locks,nb,nbconfig,nbconfigs,nbnode,nbs,nbvpc,nbvpcs,sshkey,sshkeys,vlan,volume,volumes,vpc,vpcs,vpcsubnets,vpcips,vpcdefaultranges" >> $GITHUB_ENV
               echo "LINODE_TOKEN=${{ secrets.LINODE_TOKEN_USER_2 }}" >> $GITHUB_ENV
               ;;
             "USER_3")

docs/data-sources/vpc.md

@@ -39,6 +39,8 @@ In addition to all arguments above, the following attributes are exported:
 
 * `ipv6` - A list of IPv6 allocations under this VPC.
 
+* `ipv4` - A list of IPv4 ranges under this VPC.
+
 * `region` - The region where the VPC is deployed.
 
 * `created` - The date and time when the VPC was created.
@@ -53,6 +55,14 @@ Contains information about a single IPv6 allocation under this VPC.
 
 * `range` - The allocated range in CIDR format.
 
+## IPv4
+
+-> **Limited Availability** Custom VPC IPv4 Ranges may not currently be available to all users.
+
+Contains information about a single IPv4 range under this VPC.
+
+* `range` - The IPv4 range in CIDR format.
+
 ### Subnets Reference
 
 To list all subnets under a VPC, please refer to the [linode_vpc_subnets](vpc_subnets.html.markdown) data source.

docs/data-sources/vpc_default_ranges.md

@@ -0,0 +1,30 @@
+---
+page_title: "Linode: linode_vpc_default_ranges"
+description: |-
+  Provides details about the default and forbidden IPv4 address ranges for VPCs.
+---
+
+# Data Source: linode\_vpc\_default\_ranges
+
+Provides information about the default and forbidden IPv4 address ranges for VPCs.
+For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-vpcs-default-ranges).
+
+## Example Usage
+
+The following example shows how one might use this data source to access information about the default and forbidden IPv4 address ranges for VPCs.
+
+```hcl
+data "linode_vpc_default_ranges" "foo" {}
+
+output "vpc_default_ranges" {
+  value = data.linode_vpc_default_ranges.foo
+}
+```
+
+## Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `default_ipv4_ranges` - The default IPv4 address ranges (CIDR blocks) used by the system when creating a VPC if no custom ranges are provided.
+
+* `forbidden_ipv4_ranges` - IPv4 address ranges (CIDR blocks) that are forbidden and can't be used as part of a VPC's address space.

docs/data-sources/vpcs.md

@@ -52,6 +52,8 @@ Each Linode VPC will be stored in the `vpcs` attribute and will export the follo
 
 * `ipv6` - A list of IPv6 allocations under this VPC.
 
+* `ipv4` - A list of IPv4 ranges under this VPC.
+
 * `label` - The label of the VPC.
 
 * `region` - The region where the VPC is deployed.
@@ -66,6 +68,14 @@ Contains information about a single IPv6 allocation under a VPC.
 
 * `range` - The allocated range in CIDR format.
 
+## IPv4
+
+-> **Limited Availability** Custom VPC IPv4 Ranges may not currently be available to all users.
+
+Contains information about a single IPv4 range under this VPC.
+
+* `range` - The IPv4 range in CIDR format.
+
 ## Filterable Fields
 
 * `id`

docs/resources/vpc.md

@@ -39,6 +39,22 @@ resource "linode_vpc" "test" {
 }
 ```
 
+Create a VPC with a custom IPv4 range:
+
+```terraform
+# NOTE: Custom VPC IPv4 Ranges may not currently be available to all users.
+resource "linode_vpc" "test" {
+    label = "test-vpc"
+    region = "us-iad"
+    
+    ipv4 = [
+      {
+        range = "10.0.0.0/8"
+      }
+    ]
+}
+```
+
 ## Argument Reference
 
 The following arguments are supported:
@@ -51,6 +67,8 @@ The following arguments are supported:
 
 * [`ipv6`](#ipv6) - (Optional) A list of IPv6 allocations under this VPC.
 
+* [`ipv4`](#ipv4) - (Optional) A list of IPv4 ranges under this VPC.
+
 ## IPv6
 
 -> **Limited Availability** IPv6 VPCs may not currently be available to all users.
@@ -63,6 +81,14 @@ Configures a single IPv6 range under this VPC.
 
 * `allocated_range` - (Read-Only) The value of range computed by the API. This is necessary when needing to access the range for an implicit allocation.
 
+## IPv4
+
+-> **Limited Availability** Custom VPC IPv4 Ranges may not currently be available to all users.
+
+Configures a single IPv4 range under this VPC. Unlike IPv6, IPv4 ranges can be updated in-place without requiring resource replacement.
+
+* `range` - (Required) The IPv4 range in CIDR format to assign to this VPC (e.g. `10.0.0.0/8`).
+
 ## Attributes Reference
 
 In addition to all the arguments above, the following attributes are exported.

linode/framework_provider.go

@@ -117,6 +117,7 @@ import (
 	"github.com/linode/terraform-provider-linode/v4/linode/volumes"
 	"github.com/linode/terraform-provider-linode/v4/linode/volumetypes"
 	"github.com/linode/terraform-provider-linode/v4/linode/vpc"
+	"github.com/linode/terraform-provider-linode/v4/linode/vpcdefaultranges"
 	"github.com/linode/terraform-provider-linode/v4/linode/vpcips"
 	"github.com/linode/terraform-provider-linode/v4/linode/vpcs"
 	"github.com/linode/terraform-provider-linode/v4/linode/vpcsubnet"
@@ -400,5 +401,6 @@ func (p *FrameworkProvider) DataSources(ctx context.Context) []func() datasource
 		monitorlogsstreamhistory.NewDataSource,
 		monitorlogsstreams.NewDataSource,
 		monitoralertchannels.NewDataSource,
+		vpcdefaultranges.NewDataSource,
 	}
 }

linode/vpc/datasource_test.go

@@ -102,3 +102,50 @@ func TestAccDataSourceVPC_dualStack(t *testing.T) {
 		},
 	})
 }
+
+func TestAccDataSourceVPC_ipv4(t *testing.T) {
+	t.Parallel()
+
+	resourceName := "data.linode_vpc.foo"
+	vpcLabel := acctest.RandomWithPrefix("tf-test")
+
+	targetRegion, err := acceptance.GetRandomRegionWithCaps([]linodego.RegionCapability{
+		linodego.CapabilityVPCs,
+		linodego.CapabilityVPCCustomIPv4Ranges,
+	}, "core")
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { acceptance.PreCheck(t) },
+		ProtoV6ProviderFactories: acceptance.ProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: tmpl.DataIPv4(t, vpcLabel, targetRegion, "10.0.0.0/8"),
+				ConfigStateChecks: []statecheck.StateCheck{
+					statecheck.ExpectKnownValue(
+						resourceName,
+						tfjsonpath.New("label"),
+						knownvalue.StringExact(vpcLabel),
+					),
+					statecheck.ExpectKnownValue(
+						resourceName,
+						tfjsonpath.New("region"),
+						knownvalue.NotNull(),
+					),
+					statecheck.ExpectKnownValue(
+						resourceName,
+						tfjsonpath.New("ipv4"),
+						knownvalue.ListSizeExact(1),
+					),
+					statecheck.ExpectKnownValue(
+						resourceName,
+						tfjsonpath.New("ipv4").AtSliceIndex(0).AtMapKey("range"),
+						knownvalue.StringExact("10.0.0.0/8"),
+					),
+				},
+			},
+		},
+	})
+}

linode/vpc/framework_models.go

@@ -23,6 +23,7 @@ type BaseModel struct {
 	Region      types.String      `tfsdk:"region"`
 	Created     timetypes.RFC3339 `tfsdk:"created"`
 	Updated     timetypes.RFC3339 `tfsdk:"updated"`
+	IPv4        types.List        `tfsdk:"ipv4"`
 }
 
 func (m *BaseModel) FlattenVPC(ctx context.Context, vpc *linodego.VPC, preserveKnown bool) diag.Diagnostics {
@@ -47,7 +48,6 @@ func (m *BaseModel) FlattenVPC(ctx context.Context, vpc *linodego.VPC, preserveK
 
 func (m *BaseModel) CopyFrom(ctx context.Context, other BaseModel, preserveKnown bool) {
 	m.ID = helper.KeepOrUpdateValue(m.ID, other.ID, preserveKnown)
-
 	m.Description = helper.KeepOrUpdateValue(m.Description, other.Description, preserveKnown)
 	m.Created = helper.KeepOrUpdateValue(m.Created, other.Created, preserveKnown)
 	m.Updated = helper.KeepOrUpdateValue(m.Updated, other.Updated, preserveKnown)
@@ -70,9 +70,14 @@ type ResourceModelIPv6 struct {
 	AllocationClass types.String                          `tfsdk:"allocation_class"`
 }
 
+type ResourceModelIPv4 struct {
+	Range types.String `tfsdk:"range"`
+}
+
 func (m *ResourceModel) FlattenVPC(ctx context.Context, vpc *linodego.VPC, preserveKnown bool) diag.Diagnostics {
 	m.BaseModel.FlattenVPC(ctx, vpc, preserveKnown)
 
+	// Flatten IPv6
 	ipv6Models := helper.MapSlice(vpc.IPv6,
 		func(r linodego.VPCIPv6Range) ResourceModelIPv6 {
 			return ResourceModelIPv6{
@@ -94,12 +99,33 @@ func (m *ResourceModel) FlattenVPC(ctx context.Context, vpc *linodego.VPC, prese
 		false,
 	)
 
+	// Flatten IPv4
+	ipv4Models := helper.MapSlice(vpc.IPv4,
+		func(r linodego.VPCIPv4Range) ResourceModelIPv4 {
+			return ResourceModelIPv4{
+				Range: types.StringValue(r.Range),
+			}
+		},
+	)
+
+	ipv4List, ipv4Diags := types.ListValueFrom(ctx, ResourceSchemaIPv4NestedObject.Type(), ipv4Models)
+	if ipv4Diags.HasError() {
+		return ipv4Diags
+	}
+
+	m.IPv4 = helper.KeepOrUpdateValue(
+		m.IPv4,
+		ipv4List,
+		false,
+	)
+
 	return nil
 }
 
 func (m *ResourceModel) CopyFrom(ctx context.Context, other ResourceModel, preserveKnown bool) {
 	m.BaseModel.CopyFrom(ctx, other.BaseModel, preserveKnown)
 	m.IPv6 = helper.KeepOrUpdateValue(m.IPv6, other.IPv6, preserveKnown)
+	m.IPv4 = helper.KeepOrUpdateValue(m.IPv4, other.IPv4, preserveKnown)
 }
 
 /*
@@ -115,9 +141,14 @@ type DataSourceModelIPv6 struct {
 	Range customtypes.LinodeAutoAllocRangeValue `tfsdk:"range"`
 }
 
+type DataSourceModelIPv4 struct {
+	Range types.String `tfsdk:"range"`
+}
+
 func (m *DataSourceModel) FlattenVPC(ctx context.Context, vpc *linodego.VPC, preserveKnown bool) diag.Diagnostics {
 	m.BaseModel.FlattenVPC(ctx, vpc, preserveKnown)
 
+	// Flatten IPv6
 	ipv6Models := helper.MapSlice(
 		vpc.IPv6,
 		func(r linodego.VPCIPv6Range) DataSourceModelIPv6 {
@@ -138,10 +169,32 @@ func (m *DataSourceModel) FlattenVPC(ctx context.Context, vpc *linodego.VPC, pre
 		preserveKnown,
 	)
 
+	// Flatten IPv4
+	ipv4Models := helper.MapSlice(
+		vpc.IPv4,
+		func(r linodego.VPCIPv4Range) DataSourceModelIPv4 {
+			return DataSourceModelIPv4{
+				Range: types.StringValue(r.Range),
+			}
+		},
+	)
+
+	ipv4List, ipv4Diags := types.ListValueFrom(ctx, DataSourceSchemaIPv4NestedObject.Type(), ipv4Models)
+	if ipv4Diags.HasError() {
+		return ipv4Diags
+	}
+
+	m.IPv4 = helper.KeepOrUpdateValue(
+		m.IPv4,
+		ipv4List,
+		preserveKnown,
+	)
+
 	return nil
 }
 
 func (m *DataSourceModel) CopyFrom(ctx context.Context, other DataSourceModel, preserveKnown bool) {
 	m.BaseModel.CopyFrom(ctx, other.BaseModel, preserveKnown)
 	m.IPv6 = helper.KeepOrUpdateValue(m.IPv6, other.IPv6, preserveKnown)
+	m.IPv4 = helper.KeepOrUpdateValue(m.IPv4, other.IPv4, preserveKnown)
 }

linode/vpc/framework_resource.go

@@ -70,6 +70,24 @@ func (r *Resource) Create(
 		)
 	}
 
+	if !data.IPv4.IsNull() && !data.IPv4.IsUnknown() {
+		modelIPv4s := make([]ResourceModelIPv4, len(data.IPv4.Elements()))
+
+		resp.Diagnostics.Append(data.IPv4.ElementsAs(ctx, &modelIPv4s, true)...)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+
+		vpcCreateOpts.IPv4 = helper.MapSlice(
+			modelIPv4s,
+			func(m ResourceModelIPv4) linodego.VPCCreateOptionsIPv4 {
+				return linodego.VPCCreateOptionsIPv4{
+					Range: m.Range.ValueStringPointer(),
+				}
+			},
+		)
+	}
+
 	tflog.Debug(ctx, "client.CreateVPC(...)", map[string]any{
 		"options": vpcCreateOpts,
 	})
@@ -83,6 +101,7 @@ func (r *Resource) Create(
 	}
 
 	ipv6Configured := !data.IPv6.IsNull()
+	ipv4Configured := !data.IPv4.IsNull() && !data.IPv4.IsUnknown()
 
 	resp.Diagnostics.Append(data.FlattenVPC(ctx, vpc, true)...)
 	if resp.Diagnostics.HasError() {
@@ -103,6 +122,15 @@ func (r *Resource) Create(
 				"Please ensure the current user has access to the VPC IPv6 feature.",
 		)
 	}
+
+	if ipv4Configured && vpc.IPv4 == nil {
+		resp.Diagnostics.AddAttributeError(
+			path.Root("ipv4"),
+			"Value Mismatch",
+			"The `ipv4` field was configured but was not found in the API's response. "+
+				"Please ensure the current user has access to the VPC IPv4 feature.",
+		)
+	}
 }
 
 func (r *Resource) Read(
@@ -187,6 +215,31 @@ func (r *Resource) Update(
 		updateOpts.Label = plan.Label.ValueString()
 	}
 
+	if !plan.IPv4.IsUnknown() && !state.IPv4.Equal(plan.IPv4) {
+		shouldUpdate = true
+
+		if !plan.IPv4.IsNull() {
+			modelIPv4s := make([]ResourceModelIPv4, len(plan.IPv4.Elements()))
+
+			resp.Diagnostics.Append(plan.IPv4.ElementsAs(ctx, &modelIPv4s, true)...)
+			if resp.Diagnostics.HasError() {
+				return
+			}
+
+			updateOpts.IPv4 = helper.MapSlice(
+				modelIPv4s,
+				func(m ResourceModelIPv4) linodego.VPCUpdateOptionsIPv4 {
+					return linodego.VPCUpdateOptionsIPv4{
+						Range: m.Range.ValueStringPointer(),
+					}
+				},
+			)
+		} else {
+			// Explicitly set to empty slice to clear all IPv4 ranges
+			updateOpts.IPv4 = []linodego.VPCUpdateOptionsIPv4{}
+		}
+	}
+
 	if shouldUpdate {
 		id := helper.FrameworkSafeStringToInt(plan.ID.ValueString(), &resp.Diagnostics)
 		if resp.Diagnostics.HasError() {