Skip to content

Commit

Permalink
Refactor hcp hvn docs (#338)
Browse files Browse the repository at this point in the history
* Refactor hcp_hvn cloud provider documentation to be more generic

Co-authored-by: Dominic Gregoire <[email protected]>

* Regenerate documentation

Co-authored-by: Dominic Gregoire <[email protected]>

Co-authored-by: Dominic Gregoire <[email protected]>
  • Loading branch information
daneharrigan and dgregoire authored Jun 28, 2022
1 parent f7d4b71 commit 77aa3d8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/resources/hvn.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ We recommend the following when selecting the CIDR block of an HVN:

- The CIDR block value must end between /16 and /25.

- If the CIDR block values for your HVN and VPCs overlap, then you will not be able to establish a connection. Ensure that any VPCs you plan to connect do not have overlapping values.
- If the CIDR block values for your HCP HVN and your cloud provider’s virtual network overlap you will not be able to establish a connection. The following are default CIDR block values to be aware of: HCP HVN (172.25.16.0/20), AWS VPC (172.31.0.0/16), and Azure VNet (172.29.0.0/24). Avoid creating overlapping networks.

- The default HVN CIDR block value does not overlap with the default CIDR block value for AWS VPCs (172.31.0.0/16). However, if you are planning to use this HVN in production, we recommend adding a custom value instead of using the default.
- If you’re creating a HVN for use in production it's recommended that you specify a CIDR block value that does not overlap with the other HVNs already created in your organization. You will not be able to connect two HVNs with overlapping CIDR block values.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions templates/resources/hvn.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ We recommend the following when selecting the CIDR block of an HVN:

- The CIDR block value must end between /16 and /25.

- If the CIDR block values for your HVN and VPCs overlap, then you will not be able to establish a connection. Ensure that any VPCs you plan to connect do not have overlapping values.
- If the CIDR block values for your HCP HVN and your cloud provider’s virtual network overlap you will not be able to establish a connection. The following are default CIDR block values to be aware of: HCP HVN (172.25.16.0/20), AWS VPC (172.31.0.0/16), and Azure VNet (172.29.0.0/24). Avoid creating overlapping networks.

- The default HVN CIDR block value does not overlap with the default CIDR block value for AWS VPCs (172.31.0.0/16). However, if you are planning to use this HVN in production, we recommend adding a custom value instead of using the default.
- If you’re creating a HVN for use in production it's recommended that you specify a CIDR block value that does not overlap with the other HVNs already created in your organization. You will not be able to connect two HVNs with overlapping CIDR block values.

## Example Usage

Expand Down

0 comments on commit 77aa3d8

Please sign in to comment.