Skip to content

deprecate remote vpc peering #263

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.

Sign up for GitHub

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

Open
pau-hedgehog wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −9
Open

deprecate remote vpc peering #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions docs/architecture/fabric.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,15 @@ supports two different peering modes:
automatically creates a stub VPC for peering and imports routes from it. This allows VPCs to peer with each other
without the need for a dedicated peering leaf. Traffic between the peered VPCs will not leave the switch that connects
them.
* Remote Peering: Remote peering is implemented using a dedicated peering switch/switches which is used as a rendezvous
point for the 2 VPC's in the fabric. The set of switches to be used for peering is determined by configuration in the
peering policy. When a remote peering policy is applied for a pair of VPCs, the VRFs corresponding to these VPCs on
the peering switch advertise default routes into their specific VRFs identified by the L3VNI. All traffic that does
not belong to the VPCs is forwarded to the peering switch which has routes to the other VPCs and gets forwarded from
there. This peering mode was introduced as a workaround to previous limitations of the fabric; users are recommended
to use local peering instead.
* Remote Peering:

!!! warning "Deprecated"
Remote peering is being deprecated. Using local peering is encouraged.

Remote peering is implemented using a dedicated peering switch/switches which is used as a rendezvous
point for the 2 VPC's in the fabric. The set of switches to be used for peering is determined by configuration in the
peering policy. When a remote peering policy is applied for a pair of VPCs, the VRFs corresponding to these VPCs on
the peering switch advertise default routes into their specific VRFs identified by the L3VNI. All traffic that does
not belong to the VPCs is forwarded to the peering switch which has routes to the other VPCs and gets forwarded from
there. This peering mode was introduced as a workaround to previous limitations of the fabric; users are recommended
to use local peering instead.
2 changes: 1 addition & 1 deletion docs/concepts/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Wiring Diagram consists of the following resources:
* __VPC__: Virtual Private Cloud, similar to a public cloud VPC, provides an isolated private network for the
resources, with support for multiple subnets, each with user-defined VLANs and optional DHCP service
* __VPCAttachment__: represents a specific VPC subnet assignment to the Connection object which means exact server port to a VPC binding
* __VPCPeering__: enables VPC-to-VPC connectivity (could be Local where VPCs are used or Remote peering on the border/mixed leaves)
* __VPCPeering__: enables VPC-to-VPC connectivity via Local or Remote (deprecated) peering
Copy link
Contributor

@edipascale edipascale Jan 30, 2026

Choose a reason for hiding this comment

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

nit: I would just end the sentence at connectivity

* External API
* __External__: definition of the "external system" to peer with (could be one or multiple devices such as edge/provider routers)
* __ExternalAttachment__: configuration for a specific switch (using Connection object) describing how it connects to an external system
Expand Down
3 changes: 3 additions & 0 deletions docs/install-upgrade/build-wiring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,9 @@ The dotted line in the diagram shows the traffic flow for local peering. The tra

#### Remote VPC Peering

!!! warning "Deprecated"
Remote peering is being deprecated. Using local peering is encouraged.

Remote Peering is used when you need a high bandwidth connection between the VPCs, you will dedicate a switch to the peering traffic. This is either done on the border leaf or on a switch where either of the VPC's are not present. This kind of peering allows peer traffic between different VPCs at line rate and is only limited by fabric bandwidth. Remote peering introduces a few additional hops in the traffic and may cause a small increase in latency.

``` mermaid
Expand Down
3 changes: 3 additions & 0 deletions docs/user-guide/vpcs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,9 @@ spec:

### Remote VPC peering

!!! warning "Deprecated"
Remote peering is being deprecated. Using local peering is encouraged.

```yaml
apiVersion: vpc.githedgehog.com/v1beta1
kind: VPCPeering
Expand Down
2 changes: 1 addition & 1 deletion includes/abbreviations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
*[W3C]: World Wide Web Consortium
*[VPC]: Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP
*[VPCAttachment]: Represents a specific VPC subnet assignment to the Connection object which means exact server port to a VPC binding
*[VPCPeering]: Enables VPC to VPC connectivity (could be Local where VPCs are used or Remote peering on the border/mixed leafs)
*[VPCPeering]: Enables VPC-to-VPC connectivity via Local or Remote (deprecated) peering
Copy link
Contributor

@edipascale edipascale Jan 30, 2026

Choose a reason for hiding this comment

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

nit: I would just end the sentence at connectivity

*[External]: Definition of the "external system" to peer with (could be one or multiple devices such as edge/provider routers)
*[ExternalAttachment]: Configuration for a specific switch (using Connection object) describing how it connects to an external system
*[ExternalPeering]: Enables VPC to External connectivity by exposing specific VPC subnets to the external system and allowing inbound routes from it
Expand Down