Release 1.9.0

* Update changelog and regenerate docs

* update lint step

* fix some linting issues

.github/workflows/lint.yml

@@ -7,11 +7,11 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v5
         with:
           go-version: 1.18
       - uses: actions/checkout@v3
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v6.1.0
         with:
           version: latest

CHANGELOG.md

@@ -1,3 +1,13 @@
+## 1.8.0  (September 12, 2024)
+
+FEATURES:
+
+* Add include_sub_defaults to BGP Sessions
+
+IMPROVEMENTS/ENHANCEMENTS:
+
+* Adjust required fields in the documentation
+
 ## 1.8.0  (March 29, 2024)
 
 FEATURES:

docs/resources/packetfabric_backbone_virtual_circuit.md

@@ -100,9 +100,12 @@ resource "packetfabric_backbone_virtual_circuit" "vc1" {
 <a id="nestedblock--bandwidth"></a>
 ### Nested Schema for `bandwidth`
 
-Optional:
+Required:
 
 - `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
+
+Optional:
+
 - `longhaul_type` (String) Dedicated (no limits or additional charges), usage-based (per transferred GB) or hourly billing. Not applicable for Metro Dedicated.
 
 	Enum ["dedicated" "usage" "hourly"]

docs/resources/packetfabric_backbone_virtual_circuit_marketplace.md

@@ -79,9 +79,12 @@ resource "packetfabric_backbone_virtual_circuit_marketplace" "vc_marketplace_con
 <a id="nestedblock--bandwidth"></a>
 ### Nested Schema for `bandwidth`
 
-Optional:
+Required:
 
 - `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
+
+Optional:
+
 - `longhaul_type` (String) Dedicated (no limits or additional charges), usage-based (per transferred GB) or hourly billing. Not applicable for Metro Dedicated.
 
 	Enum ["dedicated" "usage" "hourly"]

docs/resources/packetfabric_cloud_provider_credential_aws.md

@@ -26,12 +26,9 @@ resource "packetfabric_cloud_provider_credential_aws" "aws_creds_staged" {
 
 ### Required
 
-- `description` (String) Description of the Cloud Provider Credentials.
-
-### Optional
-
 - `aws_access_key` (String, Sensitive) The AWS access key you want to save. Can also be set with the AWS_ACCESS_KEY_ID environment variable.
 - `aws_secret_key` (String, Sensitive) The AWS secret key you want to save. Can also be set with the AWS_SECRET_ACCESS_KEY environment variable.
+- `description` (String) Description of the Cloud Provider Credentials.
 
 ### Read-Only
 

docs/resources/packetfabric_cloud_provider_credential_google.md

@@ -33,9 +33,6 @@ resource "packetfabric_cloud_provider_credential_google" "google_creds_staged" {
 ### Required
 
 - `description` (String) Description of the Cloud Provider Credentials.
-
-### Optional
-
 - `google_service_account` (String, Sensitive) The Google service account JSON you want to save. Can also be set with the GOOGLE_CREDENTIALS environment variable.
 
 ### Read-Only

docs/resources/packetfabric_cloud_router.md

@@ -31,6 +31,7 @@ resource "packetfabric_cloud_router" "cr1" {
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `capacity` (String) The cloud router capacity.
 
 	Enum: "100Mbps" "500Mbps" "1Gbps" "2Gbps" "5Gbps" "10Gbps" "20Gbps" "30Gbps" "40Gbps" "50Gbps" "60Gbps" "80Gbps" "100Gbps" ">100Gbps"
@@ -40,7 +41,6 @@ resource "packetfabric_cloud_router" "cr1" {
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `asn` (Number) The ASN of the cloud router.
 
 	This can be the PacketFabric public ASN 4556 (default) or a private ASN from 64512 - 65534. Defaults: 4556

docs/resources/packetfabric_cloud_router_connection_aws.md

@@ -94,6 +94,8 @@ resource "packetfabric_cloud_router_connection_aws" "crc1" {
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
+- `aws_account_id` (String) The AWS account ID to connect with. Must be 12 characters long. Can also be set with the PF_AWS_ACCOUNT_ID or AWS_ACCOUNT_ID environment variables.
 - `circuit_id` (String) Circuit ID of the target cloud router. This starts with "PF-L3-CUST-".
 - `description` (String) A brief description of this connection.
 - `pop` (String) The POP in which you want to provision the connection.
@@ -106,8 +108,6 @@ resource "packetfabric_cloud_router_connection_aws" "crc1" {
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
-- `aws_account_id` (String) The AWS account ID to connect with. Must be 12 characters long. Can also be set with the PF_AWS_ACCOUNT_ID or AWS_ACCOUNT_ID environment variables.
 - `bgp_settings_uuid` (String) BGP session ID generated when the cloud-side connection is provisioned by PacketFabric.
 - `cloud_settings` (Block List, Max: 1) Provision the Cloud side of the connection with PacketFabric. (see [below for nested schema](#nestedblock--cloud_settings))
 - `is_public` (Boolean) Whether PacketFabric should allocate a public IP address for this connection. Set this to true if you intend to use a public VIF on the AWS side. Defaults: false

docs/resources/packetfabric_cloud_router_connection_azure.md

@@ -57,6 +57,7 @@ resource "packetfabric_cloud_router_connection_azure" "crc4" {
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `azure_service_key` (String) The Service Key provided by Microsoft Azure when you created your ExpressRoute circuit.
 - `circuit_id` (String) Circuit ID of the target cloud router. This starts with "PF-L3-CUST-".
 - `description` (String) A brief description of this connection.
@@ -66,7 +67,6 @@ resource "packetfabric_cloud_router_connection_azure" "crc4" {
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `is_public` (Boolean) Whether PacketFabric should allocate a public IP address for this connection. Set this to true if you intend to set up peering with Microsoft public services (such as Microsoft 365). Defaults: false
 - `labels` (Set of String) Label value linked to an object.
 - `maybe_dnat` (Boolean) Set this to true if you intend to use DNAT on this connection. Defaults: false

docs/resources/packetfabric_cloud_router_connection_google.md

@@ -112,6 +112,7 @@ resource "packetfabric_cloud_router_connection_google" "crc2" {
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `circuit_id` (String) Circuit ID of the target cloud router. This starts with "PF-L3-CUST-".
 - `description` (String) A brief description of this connection.
 - `pop` (String) The POP in which you want to provision the connection.
@@ -121,7 +122,6 @@ resource "packetfabric_cloud_router_connection_google" "crc2" {
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `bgp_settings_uuid` (String) BGP session ID generated when the cloud-side connection is provisioned by PacketFabric.
 - `cloud_settings` (Block List, Max: 1) Provision the cloud side of the connection with PacketFabric. (see [below for nested schema](#nestedblock--cloud_settings))
 - `google_pairing_key` (String) The Google pairing key to use for this connection. This is provided when you create the VLAN attachment from the Google Cloud console. Required if not using cloud_settings.

docs/resources/packetfabric_cloud_router_connection_ibm.md

@@ -74,8 +74,10 @@ resource "ibm_dl_gateway_action" "confirmation" {
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `circuit_id` (String) Circuit ID of the target cloud router. This starts with "PF-L3-CUST-".
 - `description` (String) The description of this connection. This will appear as the connection name from the IBM side.
+- `ibm_account_id` (String) Your IBM account ID. Can also be set with the PF_IBM_ACCOUNT_ID environment variable.
 - `ibm_bgp_asn` (Number) Enter an ASN to use with your BGP session. This should be the same ASN you used for your Cloud Router.
 - `pop` (String) The POP in which you want to provision the connection (the on-ramp).
 - `speed` (String) The speed of the new connection.
@@ -87,8 +89,6 @@ resource "ibm_dl_gateway_action" "confirmation" {
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
-- `ibm_account_id` (String) Your IBM account ID. Can also be set with the PF_IBM_ACCOUNT_ID environment variable.
 - `ibm_bgp_cer_cidr` (String) The IP address in CIDR format for the PacketFabric-side router in the BGP session. If you do not specify an address, IBM will assign one on your behalf.
 - `ibm_bgp_ibm_cidr` (String) The IP address in CIDR format for the IBM-side router in the BGP session. If you do not specify an address, IBM will assign one on your behalf. See the documentation for information on which IP ranges are allowed.
 - `labels` (Set of String) Label value linked to an object.

docs/resources/packetfabric_cloud_router_connection_ipsec.md

@@ -54,6 +54,7 @@ resource "packetfabric_cloud_router_connection_ipsec" "crc3" {
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `circuit_id` (String) Circuit ID of the target cloud router. This starts with "PF-L3-CUST-".
 - `description` (String) A brief description of this connection.
 - `gateway_address` (String) The gateway address of your VPN device. Because VPNs traverse the public internet, this must be a public IP address owned by you.
@@ -90,7 +91,6 @@ resource "packetfabric_cloud_router_connection_ipsec" "crc3" {
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `labels` (Set of String) Label value linked to an object.
 - `phase2_authentication_algo` (String) The authentication algorithm to use during phase 2. It cannot be null if phase2_encryption_algo is CBC. 
 

docs/resources/packetfabric_cloud_router_connection_oracle.md

@@ -42,6 +42,7 @@ resource "packetfabric_cloud_router_connection_oracle" "crc6" {
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `circuit_id` (String) Circuit ID of the target cloud router. This starts with "PF-L3-CUST-".
 - `description` (String) A brief description of this connection.
 - `pop` (String) The POP in which you want to provision the connection.
@@ -53,7 +54,6 @@ resource "packetfabric_cloud_router_connection_oracle" "crc6" {
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `labels` (Set of String) Label value linked to an object.
 - `maybe_dnat` (Boolean) Set this to true if you intend to use DNAT on this connection. Defaults: false
 - `maybe_nat` (Boolean) Set this to true if you intend to use NAT on this connection. Defaults: false

docs/resources/packetfabric_cloud_router_connection_port.md

@@ -41,6 +41,7 @@ resource "packetfabric_cloud_router_connection_port" "crc7" {
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `circuit_id` (String) Circuit ID of the target cloud router. This starts with "PF-L3-CUST-".
 - `description` (String) A brief description of this connection.
 - `port_circuit_id` (String) The circuit ID of the port to connect to the cloud router. This starts with "PF-AP-".
@@ -50,7 +51,6 @@ resource "packetfabric_cloud_router_connection_port" "crc7" {
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `is_public` (Boolean) Whether PacketFabric should allocate a public IP address for this connection. Defaults: false
 - `labels` (Set of String) Label value linked to an object.
 - `maybe_dnat` (Boolean) Set this to true if you intend to use DNAT on this connection. Defaults: false

docs/resources/packetfabric_cs_aws_dedicated_connection.md

@@ -35,6 +35,7 @@ resource "packetfabric_cs_aws_dedicated_connection" "pf_cs_conn1_dedicated_aws"
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `autoneg` (Boolean) Whether the port auto-negotiates or not. This is currently only possible with 1Gbps ports and the request will fail if specified with 10Gbps.
 - `aws_region` (String) The region that the new connection will connect to.
 
@@ -58,7 +59,6 @@ resource "packetfabric_cs_aws_dedicated_connection" "pf_cs_conn1_dedicated_aws"
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `labels` (Set of String) Label value linked to an object.
 - `loa` (String) A base64 encoded string of a PDF of the LOA that AWS provided.
 

docs/resources/packetfabric_cs_aws_hosted_connection.md

@@ -87,6 +87,8 @@ resource "packetfabric_cs_aws_hosted_connection" "cs_conn1_hosted_aws_cloud_side
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
+- `aws_account_id` (String) The AWS account ID to connect with. Must be 12 characters long. Can also be set with the PF_AWS_ACCOUNT_ID or AWS_ACCOUNT_ID environment variables.
 - `description` (String) A brief description of this connection.
 - `pop` (String) The POP in which the hosted connection should be provisioned (the cloud on-ramp).
 - `port` (String) The circuit ID of the PacketFabric port you want to connect to AWS. This starts with "PF-AP-".
@@ -100,8 +102,6 @@ resource "packetfabric_cs_aws_hosted_connection" "cs_conn1_hosted_aws_cloud_side
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
-- `aws_account_id` (String) The AWS account ID to connect with. Must be 12 characters long. Can also be set with the PF_AWS_ACCOUNT_ID or AWS_ACCOUNT_ID environment variables.
 - `cloud_settings` (Block List, Max: 1) Provision the Cloud side of the connection with PacketFabric. (see [below for nested schema](#nestedblock--cloud_settings))
 - `labels` (Set of String) Label value linked to an object.
 - `po_number` (String) Purchase order number or identifier of a service.

docs/resources/packetfabric_cs_aws_hosted_marketplace_connection.md

@@ -31,6 +31,8 @@ resource "packetfabric_cs_aws_hosted_marketplace_connection" "cs_conn1_marketpla
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
+- `aws_account_id` (String) The AWS account ID to connect with. Must be 12 characters long. Can also be set with the PF_AWS_ACCOUNT_ID environment variable.
 - `description` (String) A brief description of this connection.
 - `market` (String) The market code (e.g. "ATL" or "DAL") in which you would like the marketplace provider to provision their side of the connection.
 
@@ -48,8 +50,6 @@ resource "packetfabric_cs_aws_hosted_marketplace_connection" "cs_conn1_marketpla
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
-- `aws_account_id` (String) The AWS account ID to connect with. Must be 12 characters long. Can also be set with the PF_AWS_ACCOUNT_ID environment variable.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 
 ### Read-Only

docs/resources/packetfabric_cs_azure_dedicated_connection.md

@@ -32,6 +32,7 @@ resource "packetfabric_cs_azure_dedicated_connection" "pf_cs_conn1_dedicated_azu
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `description` (String) A brief description of this connection.
 - `encapsulation` (String) Specify either QinQ and Dot1Q encapsulation.
 
@@ -55,7 +56,6 @@ resource "packetfabric_cs_azure_dedicated_connection" "pf_cs_conn1_dedicated_azu
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `labels` (Set of String) Label value linked to an object.
 - `loa` (String) A base64 encoded string of a PDF for the LOA that you generated from the Azure portal
 - `po_number` (String) Purchase order number or identifier of a service.

docs/resources/packetfabric_cs_azure_hosted_connection.md

@@ -48,6 +48,7 @@ resource "packetfabric_cs_azure_hosted_connection" "cs_conn1_hosted_azure" {
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `azure_service_key` (String) The Service Key provided by Microsoft Azure when you created your ExpressRoute circuit.
 - `description` (String) A brief description of this connection.
 - `port` (String) The circuit ID of the PacketFabric port you wish to connect to Azure. This starts with "PF-AP-".
@@ -57,7 +58,6 @@ resource "packetfabric_cs_azure_hosted_connection" "cs_conn1_hosted_azure" {
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `labels` (Set of String) Label value linked to an object.
 - `po_number` (String) Purchase order number or identifier of a service.
 - `src_svlan` (Number) Valid S-VLAN range is from 4-4094, inclusive.

docs/resources/packetfabric_cs_azure_hosted_marketplace_connection.md

@@ -30,6 +30,7 @@ resource "packetfabric_cs_azure_hosted_marketplace_connection" "cs_conn1_marketp
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `azure_service_key` (String) The Service Key provided by Microsoft Azure when you created your ExpressRoute circuit.
 - `description` (String) A brief description of this connection.
 - `market` (String) The market code (e.g. "ATL" or "DAL") in which you would like the marketplace provider to provision their side of the connection.
@@ -44,7 +45,6 @@ resource "packetfabric_cs_azure_hosted_marketplace_connection" "cs_conn1_marketp
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `service_uuid` (String) UUID of the marketplace service being requested.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 

docs/resources/packetfabric_cs_google_dedicated_connection.md

@@ -31,6 +31,7 @@ resource "packetfabric_cs_google_dedicated_connection" "pf_cs_conn1_dedicated_go
 
 ### Required
 
+- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `description` (String) A brief description of this connection.
 - `pop` (String) The POP in which the dedicated port should be provisioned (the cloud on-ramp).
 - `service_class` (String) The service class for the given port, either long haul or metro. Specify metro if the cloud on-ramp (the `pop`) is in the same market as the source ports (the ports to which you will be building out virtual circuits).
@@ -48,7 +49,6 @@ resource "packetfabric_cs_google_dedicated_connection" "pf_cs_conn1_dedicated_go
 
 ### Optional
 
-- `account_uuid` (String) The UUID for the billing account that should be billed. Can also be set with the PF_ACCOUNT_ID environment variable.
 - `autoneg` (Boolean) Whether the port auto-negotiates or not. This is currently only possible with 1Gbps ports and the request will fail if specified with 10Gbps. Defaults: false
 - `labels` (Set of String) Label value linked to an object.
 - `loa` (String) A base64 encoded string of a PDF of the LOA that Google provided.