Merge pull request #1144 from lgarber-akamai/fix/docs-typo

doc: Various VPC docs improvements
linode · Nov 17, 2023 · cf3a2e8 · cf3a2e8
2 parents b9d63fd + 5de20ba
commit cf3a2e8
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 22 deletions.
diff --git a/docs/data-sources/instances.md b/docs/data-sources/instances.md
@@ -178,11 +178,29 @@ Interface defines a network interfaces that is exposed to a Linode. See the offi
 
 Each interface exports the following attributes:
 
-* `purpose` - (Required) The type of interface. (`public`, `vlan`)
+* `purpose` - The type of interface. (`public`, `vlan`, `vpc`)
 
-* `label` - (Optional) The name of this interface. If the interface is a `vlan`, a label is required. Must be undefined for `public` purpose interfaces.
+* `ipam_address` - This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation. (e.g. `10.0.0.1/24`) This field is only allowed for interfaces with the `vlan` purpose.
 
-* `ipam_address` - (Optional) This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
+* `label` - The name of the VLAN to join. This field is only allowed and required for interfaces with the `vlan` purpose.
+
+* `subnet_id` - The name of the VPC Subnet to join. This field is only allowed and required for interfaces with the `vpc` purpose.
+
+* `primary` - Whether the interface is the primary interface that should have the default route for this Linode. This field is only allowed for interfaces with the `public` or `vpc` purpose.
+
+* [`ipv4`](#ipv4) -The IPv4 configuration of the VPC interface. This field is currently only allowed for interfaces with the `vpc` purpose.
+
+* `vpc_id` - The ID of VPC which this interface is attached to.
+
+* `ip_ranges` - IPv4 CIDR VPC Subnet ranges that are routed to this Interface. IPv6 ranges are also available to select participants in the Beta program.
+
+#### ipv4
+
+The following arguments are available in an `ipv4` configuration block of an `interface` block:
+
+* `vpc` - The IP from the VPC subnet to use for this interface. A random address will be assigned if this is not specified in a VPC interface.
+
+* `nat_1_1` - The public IP that will be used for the one-to-one NAT purpose. If this is `any`, the public IPv4 address assigned to this Linode is used on this interface and will be 1:1 NATted with the VPC IPv4 address.
 
 ### Backups
 

diff --git a/docs/data-sources/vpc.md b/docs/data-sources/vpc.md
@@ -40,7 +40,7 @@ In addition to all arguments above, the following attributes are exported:
 
 * `created` - The date and time when the VPC was created.
 
-* `updated` - The date and time when the VPC was updated.
+* `updated` - The date and time when the VPC was last updated.
 
 ### Subnets Reference
 

diff --git a/docs/data-sources/vpc_subnet.md b/docs/data-sources/vpc_subnet.md
@@ -43,4 +43,4 @@ In addition to all arguments above, the following attributes are exported:
 
 * `created` - The date and time when the VPC Subnet was created.
 
-* `updated` - The date and time when the VPC Subnet was updated.
+* `updated` - The date and time when the VPC Subnet was last updated.
diff --git a/docs/data-sources/vpc_subnets.md b/docs/data-sources/vpc_subnets.md
@@ -56,7 +56,7 @@ Each Linode VPC subnet will be stored in the `vpc_subnets` attribute and will ex
 
 * `created` - The date and time when the VPC Subnet was created.
 
-* `updated` - The date and time when the VPC Subnet was updated.
+* `updated` - The date and time when the VPC Subnet was last updated.
 
 ## Filterable Fields
 

diff --git a/docs/data-sources/vpcs.md b/docs/data-sources/vpcs.md
@@ -53,7 +53,7 @@ Each Linode VPC will be stored in the `vpcs` attribute and will export the follo
 
 * `created` - The date and time when the VPC was created.
 
-* `updated` - The date and time when the VPC was updated.
+* `updated` - The date and time when the VPC was last updated.
 
 ## Filterable Fields
 

diff --git a/docs/resources/instance.md b/docs/resources/instance.md
@@ -240,31 +240,31 @@ Interface defines a network interfaces that is exposed to a Linode. See the offi
 
 Each interface exports the following attributes:
 
-* `purpose` - (Required) The type of interface. (`public`, `vlan`)
+* `purpose` - (Required) The type of interface. (`public`, `vlan`, `vpc`)
 
 * `ipam_address` - (Optional) This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation. (e.g. `10.0.0.1/24`) This field is only allowed for interfaces with the `vlan` purpose.
 
 * `label` - (Optional) The name of the VLAN to join. This field is only allowed and required for interfaces with the `vlan` purpose.
 
-* `subnet_id` - (Optional) The name of the VLAN to join. This field is only allowed and required for interfaces with the `vpc` purpose.
+* `subnet_id` - (Optional) The name of the VPC Subnet to join. This field is only allowed and required for interfaces with the `vpc` purpose.
 
-* `primary` - (Optional) Whether the interface is the primary interface that should have the default route for this Linode.
+* `primary` - (Optional) Whether the interface is the primary interface that should have the default route for this Linode. This field is only allowed for interfaces with the `public` or `vpc` purpose.
 
 * [`ipv4`](#ipv4) - (Optional) The IPv4 configuration of the VPC interface. This field is currently only allowed for interfaces with the `vpc` purpose.
 
 The following computed attribute is available in a VPC interface:
 
-* `vpc_id` - (Optional) The ID of VPC of the subnet which the VPC interface is connected to.
+* `vpc_id` - The ID of VPC which this interface is attached to.
 
-* `ip_ranges` - (Optional) IPv4 CIDR VPC Subnet ranges that are routed to this Interface. IPv6 ranges are also available to select participants in the Beta program.
+* `ip_ranges` - IPv4 CIDR VPC Subnet ranges that are routed to this Interface. IPv6 ranges are also available to select participants in the Beta program.
 
 #### ipv4
 
 The following arguments are available in an `ipv4` configuration block of an `interface` block:
 
 * `vpc` - (Optional) The IP from the VPC subnet to use for this interface. A random address will be assigned if this is not specified in a VPC interface.
 
-* `nat_1_1` - (Optional) The public IP that will be used for the one-to-one NAT purpose. If this is `any`, the public IPv4 address assigned to this Linode is used on this interface and will be 1:1 natted with the vpc ipv4 address.
+* `nat_1_1` - (Optional) The public IP that will be used for the one-to-one NAT purpose. If this is `any`, the public IPv4 address assigned to this Linode is used on this interface and will be 1:1 NATted with the VPC IPv4 address.
 
 ### Timeouts
 

diff --git a/docs/resources/instance_config.md b/docs/resources/instance_config.md
@@ -220,21 +220,21 @@ The following attributes are available on helpers:
 
 The following arguments are available in an interface:
 
-* `purpose` - (Required) The type of interface. (`public`, `vlan`)
+* `purpose` - (Required) The type of interface. (`public`, `vlan`, `vpc`)
 
 * `ipam_address` - (Optional) This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation. (e.g. `10.0.0.1/24`) This field is only allowed for interfaces with the `vlan` purpose.
 
 * `label` - (Optional) The name of the VLAN to join. This field is only allowed and required for interfaces with the `vlan` purpose.
 
-* `subnet_id` - (Optional) The name of the VLAN to join. This field is only allowed and required for interfaces with the `vpc` purpose.
+* `subnet_id` - (Optional) The name of the VPC Subnet to join. This field is only allowed and required for interfaces with the `vpc` purpose.
 
-* `primary` - (Optional) Whether the interface is the primary interface that should have the default route for this Linode.
+* `primary` - (Optional) Whether the interface is the primary interface that should have the default route for this Linode. This field is only allowed for interfaces with the `public` or `vpc` purpose.
 
 * [`ipv4`](#ipv4) - (Optional) The IPv4 configuration of the VPC interface. This field is currently only allowed for interfaces with the `vpc` purpose.
 
 The following computed attribute is available in a VPC interface:
 
-* `vpc_id` - (Optional) The ID of VPC of the subnet which the VPC interface is connected to.
+* `vpc_id` - The ID of VPC which this interface is attached to.
 
 * `ip_ranges` - (Optional) IPv4 CIDR VPC Subnet ranges that are routed to this Interface. IPv6 ranges are also available to select participants in the Beta program.
 
@@ -244,7 +244,7 @@ The following arguments are available in an `ipv4` configuration block of an `in
 
 * `vpc` - (Optional) The IP from the VPC subnet to use for this interface. A random address will be assigned if this is not specified in a VPC interface.
 
-* `nat_1_1` - (Optional) The public IP that will be used for the one-to-one NAT purpose. If this is `any`, the public IPv4 address assigned to this Linode is used on this interface and will be 1:1 natted with the vpc ipv4 address.
+* `nat_1_1` - (Optional) The public IP that will be used for the one-to-one NAT purpose. If this is `any`, the public IPv4 address assigned to this Linode is used on this interface and will be 1:1 NATted with the VPC IPv4 address.
 
 ## Import
 

diff --git a/docs/resources/vpc.md b/docs/resources/vpc.md
@@ -26,7 +26,7 @@ resource "linode_vpc" "test" {
 
 The following arguments are supported:
 
-* `label` - (Required) The label of the VPC. Only contains ascii letters, digits and dashes.
+* `label` - (Required) The label of the VPC. This field can only contain ASCII letters, digits and dashes.
 
 * `region` - (Required) The region of the VPC.
 
@@ -40,4 +40,4 @@ In addition to all the arguments above, the following attributes are exported.
 
 * `created` - The date and time when the VPC was created.
 
-* `updated` - The date and time when the VPC was updated.
+* `updated` - The date and time when the VPC was last updated.
diff --git a/docs/resources/vpc_subnet.md b/docs/resources/vpc_subnet.md
@@ -26,7 +26,7 @@ The following arguments are supported:
 
 * `vpc_id` - (Required) The id of the parent VPC for this VPC Subnet.
 
-* `label` - (Required) The label of the VPC. Only contains ascii letters, digits and dashes.
+* `label` - (Required) The label of the VPC. Only contains ASCII letters, digits and dashes.
 
 * `ipv4` - (Required) The IPv4 range of this subnet in CIDR format.
 
@@ -40,4 +40,4 @@ In addition to all the arguments above, the following attributes are exported.
 
 * `created` - The date and time when the VPC was created.
 
-* `updated` - The date and time when the VPC was updated.
+* `updated` - The date and time when the VPC was last updated.