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

HVN route migration guide #129

Merged
merged 11 commits into from
Jun 4, 2021
Merged

Conversation

bcmdarroch
Copy link
Contributor

🛠️ Description

Adds a migration guide that captures the steps in #128 for adding HVN routes to existing HCP networking setup managed by Terraform.


The HVN route is a new resource that belongs to an HVN. It contains a CIDR block and targets a networking connection:
currently, either a peering or transit gateway attachment.
TODO: expand on why they're being introduced.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I could use some help on what to say here. Probably a sentence or two on why this change is being introduced and its benefits.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would say something like: "HVN routes provide a general view on how HVN traffic is routed across all networking connections and create a flexible way of managing these routing rules."

@bcmdarroch bcmdarroch marked this pull request as ready for review June 2, 2021 17:14
@bcmdarroch bcmdarroch requested a review from a team June 2, 2021 17:14
CHANGELOG.md Outdated
FEATURES:
* **New resource** `hcp_hvn_route` (#122)

⚠️ Note: Due to the introduction of HVN routes, this version introduces breaking changes to the `hcp_aws_network_peering` and `hcp_aws_transit_gateway_attachment` resources. Please see our [migration guide](link TODO) to learn about how to update your HCP networking setup to work with HVN routes. ⚠️
Copy link
Contributor

Choose a reason for hiding this comment

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

do we a link already?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I'm going to link to your PR with the migration steps here, since I don't think we'll keep the migration guide in the registry docs forever.


The HVN route is a new resource that belongs to an HVN. It contains a CIDR block and targets a networking connection:
currently, either a peering or transit gateway attachment.
TODO: expand on why they're being introduced.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would say something like: "HVN routes provide a general view on how HVN traffic is routed across all networking connections and create a flexible way of managing these routing rules."

@bcmdarroch bcmdarroch force-pushed the hvn-route-migration-guide branch from 45ebee0 to 24b154d Compare June 4, 2021 18:20
@hashicorp-cla
Copy link

hashicorp-cla commented Jun 4, 2021

CLA assistant check
All committers have signed the CLA.

@bcmdarroch bcmdarroch force-pushed the feature-hvn-routes branch from 7a7a8ba to d8f57dd Compare June 4, 2021 18:24
@bcmdarroch bcmdarroch force-pushed the hvn-route-migration-guide branch from 24b154d to ee798c0 Compare June 4, 2021 18:29
@bcmdarroch bcmdarroch force-pushed the feature-hvn-routes branch from d8f57dd to b2eb158 Compare June 4, 2021 18:43
@bcmdarroch bcmdarroch force-pushed the hvn-route-migration-guide branch from ee798c0 to da92413 Compare June 4, 2021 18:44
@bcmdarroch bcmdarroch force-pushed the hvn-route-migration-guide branch from b4346b7 to 461ad53 Compare June 4, 2021 18:56
@bcmdarroch bcmdarroch force-pushed the hvn-route-migration-guide branch from 461ad53 to 63d005a Compare June 4, 2021 19:02
@bcmdarroch bcmdarroch merged commit 6073695 into feature-hvn-routes Jun 4, 2021
@bcmdarroch bcmdarroch deleted the hvn-route-migration-guide branch June 4, 2021 19:06
bcmdarroch added a commit that referenced this pull request Jun 7, 2021
* HCCP-91 HVN route resource (#122)

* added create, scaffolded read and delete for hvn route resource

* Adds delete for HVN route resource

* Adds hvn route import function

* Handle both peering and tgw attachment resource types in HVN route resources

* Regenerate docs, add example s for hvn route resource

* Re-run go generate after adding  example

* ACreate hvn route function checks for target existence before proceeding

* Add peering to example for hvn route, regenerate docs

* Resolves comments - better logging and commenting for HVN route resource

* removed unnecessary validation

* removed todos

* removed tgw attachment from hvn route example

* added examples of the hvn route target

* moved hvn route creation into clients

* simplified parsing target_link for the hvn route resource

* dropped checking for hvn route existance

* fixed hvn routes import

* gofmt hvn_route.go

* redo hvn route import to use route ID

* go mod tidy

* redo hvn route datasource to use route ID

* renamed hvn -> hvn_link

* refactored WaitForHVNRouteToBeActive

* unified hvn route errors/logs

* small refactoring

* improved logs

* messages improvements

* regenarated docs

* HCCP-138 breaking changes for Peering and TGW attachment (#128)

* HCCP-138 required id and removed cidr from peering

* HCCP-138 fixed tgw-attachment resource import

* HCCP-138 removed cidrs from tgw-attachment

* bonus: drop deleted guide example

* update peering examples in guides

* HVN route migration guide (#129)

* add note to changelog

* update readme

* add hvn route migration guide

* id -> ID

* bonus: fix error typo

* go gen

* add context to HVN route intro

* update link in banner to registry migration guide

* update changelog

* update version in examples

* add warning banner to hvn route doc

* added handling 404 when deleting hvn route (#137)

* HCCP-184 acceptance tests for HVN route, TGW attachment and network peering (#130)

* HCCP-184 added acceptance tests for HVN route resource

* HCCP-184 added acceptance tests for TGW attachment resource

* HCCP-184 added acceptance tests for network peering resource

* HCCP-138 added clarification about AWS credentials

* HCCP-184 renamed tgw attachment acceptance test resource

* HCCP-184 improved tests doc

* HCCP-184 fixed test after rebasing

* added dedicated timeout for hvn route delete (#138)

Co-authored-by: Ti Zhang <[email protected]>
Co-authored-by: Anton Panferov <[email protected]>
Co-authored-by: Brenna Hewer-Darroch <[email protected]>
aidan-mundy pushed a commit that referenced this pull request Dec 12, 2023
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