diff --git a/docs/architecture/fabric.md b/docs/architecture/fabric.md index e03bd30db..efc932a0c 100644 --- a/docs/architecture/fabric.md +++ b/docs/architecture/fabric.md @@ -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. diff --git a/docs/concepts/overview.md b/docs/concepts/overview.md index 04aba5b30..b903776d1 100644 --- a/docs/concepts/overview.md +++ b/docs/concepts/overview.md @@ -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 * 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 diff --git a/docs/install-upgrade/build-wiring.md b/docs/install-upgrade/build-wiring.md index ea44c19fe..631af3592 100644 --- a/docs/install-upgrade/build-wiring.md +++ b/docs/install-upgrade/build-wiring.md @@ -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 diff --git a/docs/user-guide/vpcs.md b/docs/user-guide/vpcs.md index 06976aeba..aae79a07d 100644 --- a/docs/user-guide/vpcs.md +++ b/docs/user-guide/vpcs.md @@ -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 diff --git a/includes/abbreviations.md b/includes/abbreviations.md index c6e4a2aad..92886a9b4 100644 --- a/includes/abbreviations.md +++ b/includes/abbreviations.md @@ -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 *[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