Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HCPE-1198: add CIDR guidance to HVN resource documentation #160

Merged
merged 5 commits into from
Jul 8, 2021

Conversation

bcmdarroch
Copy link
Contributor

🛠️ Description

Adds some helpful guidance around HVN CIDR blocks, like we offer in the UI.

@bcmdarroch bcmdarroch requested a review from a team as a code owner July 2, 2021 22:49
@bcmdarroch bcmdarroch requested a review from a team July 2, 2021 22:49

- 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.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One other thing since we're adding some more guidance here (although definitely not blocking): I believe our APIs expect CIDR blocks to use the first IP address in the block, and will error if an arbitrary IP address within the block is used (and I think cidrsubnet() can help with this?). We could potentially add something to help guide users past that restriction.

Copy link
Contributor Author

@bcmdarroch bcmdarroch Jul 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I didn't know that.💡 I'll run this by control plane team:
The CIDR block value should be the first IP address of the desired CIDR block. The [cidrsubnet()](https://www.terraform.io/docs/language/functions/cidrsubnet.html) helper can be used to specify the first address.

Copy link
Contributor Author

@bcmdarroch bcmdarroch Jul 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got 👍 from control plane. Went ahead and added a couple more rules that we're enforcing on the backend.

@bcmdarroch bcmdarroch force-pushed the hcpe-1198-update-cidr-guidance branch from c4cf9a3 to 571bb38 Compare July 8, 2021 16:51
@bcmdarroch bcmdarroch merged commit 74b73af into main Jul 8, 2021
@bcmdarroch bcmdarroch deleted the hcpe-1198-update-cidr-guidance branch July 8, 2021 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants