Skip to content

Commit 4408182

Browse files
committed
Update Build Wiring Diagram page
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
1 parent c0bc7ef commit 4408182

File tree

1 file changed

+40
-194
lines changed

1 file changed

+40
-194
lines changed

docs/install-upgrade/build-wiring.md

Lines changed: 40 additions & 194 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1+
12
# Build Wiring Diagram
23

3-
!!! warning ""
4-
Under construction.
4+
!!! note ""
5+
This documentation is actively maintained and updated.
56

67
## Overview
78

8-
A wiring diagram is a YAML file that is a digital representation of your network. You can find more YAML level details in the User Guide section [switch features and port naming](../user-guide/profiles.md) and the [api](../reference/api.md). It's mandatory for all switches to reference a `SwitchProfile` in the `spec.profile` of the `Switch` object. Only port naming defined by switch profiles could be used in the wiring diagram, NOS (or any other) port names aren't supported.
9+
A wiring diagram expresses your network topology in YAML format, serving as a blueprint for your infrastructure. For detailed YAML specifications, refer to the User Guide section [switch features and port naming](../user-guide/profiles.md) and the [api](../reference/api.md). All switches must reference a `SwitchProfile` in the `spec.profile` of the `Switch` object. Only port names defined by switch profiles can be used in the wiring diagram - NOS (or any other) port names are not supported.
910

10-
In the meantime, to have a look at working wiring diagram for Hedgehog Fabric, run the sample generator that produces
11-
working wiring diagrams:
11+
To get started with Hedgehog Fabric, explore the built-in sample wiring diagrams using the sample generator:
1212

1313
```console
1414
ubuntu@sl-dev:~$ hhfab sample -h
@@ -79,203 +79,49 @@ spec:
7979
```
8080
8181
## Design Discussion
82-
This section is meant to help the reader understand how to assemble the primitives presented by the Fabric API into a functional fabric.
82+
This section helps you understand how to combine the Fabric API primitives into a functional fabric.
8383
8484
### VPC
8585
86-
A VPC allows for isolation at layer 3. This is the main building block for users when creating their architecture. Hosts inside of a VPC belong to the same broadcast domain and can communicate with each other, if desired a single VPC can be configured with multiple broadcast domains. The hosts inside of a VPC will likely need to connect to other VPCs or the outside world. To communicate between two VPC a *peering* will need to be created. A VPC can be a logical separation of workloads. By separating these workloads additional controls are available. The logical separation doesn't have to be the traditional database, web, and compute layers it could be development teams who need isolation, it could be tenants inside of an office building, or any separation that allows for better control of the network. Once your VPCs are decided, the rest of the fabric will come together. With the VPCs decided traffic can be prioritized, security can be put into place, and the wiring can begin. The fabric allows for the VPC to span more than one switch, which provides great flexibility.
87-
88-
``` mermaid
89-
graph TD
90-
L1([Leaf 1])
91-
L2([Leaf 2])
92-
S1["Server 1
93-
10.7.71.1"]
94-
S2["Server 2
95-
172.16.2.31"]
96-
S3["Server 3
97-
192.168.18.85"]
98-
99-
L1 <--> S1
100-
L1 <--> S2
101-
L2 <--> S3
102-
103-
subgraph VPC 1
104-
S1
105-
S2
106-
S3
107-
end
108-
```
109-
### Connection
110-
111-
A connection represents the physical wires in your data center. They connect switches to other switches or switches to servers.
112-
113-
#### Server Connections
114-
115-
A server connection is a connection used to connect servers to the fabric. The fabric will configure the server-facing port according to the type of the connection (MLAG, Bundle, etc). The configuration of the actual server needs to be done by the server administrator. The server port names are not validated by the fabric and used as metadata to identify the connection. A server connection can be one of:
116-
117-
- *Unbundled* - A single cable connecting switch to server.
118-
- *Bundled* - Two or more cables going to a single switch, a LAG or similar.
119-
- *MCLAG* - Two cables going to two different switches, also called dual homing. The switches will need a fabric link between them.
120-
- *ESLAG* - Two to four cables going to different switches, also called multi-homing. If four links are used there will need to be four switches connected to a single server with four NIC ports.
121-
122-
``` mermaid
123-
graph TD
124-
S1([Spine 1])
125-
S2([Spine 2])
126-
L1([Leaf 1])
127-
L2([Leaf 2])
128-
L3([Leaf 3])
129-
L4([Leaf 4])
130-
L5([Leaf 5])
131-
L6([Leaf 6])
132-
L7([Leaf 7])
133-
134-
TS1[Server1]
135-
TS2[Server2]
136-
TS3[Server3]
137-
TS4[Server4]
138-
139-
S1 & S2 ---- L1 & L2 & L3 & L4 & L5 & L6 & L7
140-
L1 <-- Bundled --> TS1
141-
L1 <-- Bundled --> TS1
142-
L1 <-- Unbundled --> TS2
143-
L2 <-- MCLAG --> TS3
144-
L3 <-- MCLAG --> TS3
145-
L4 <-- ESLAG --> TS4
146-
L5 <-- ESLAG --> TS4
147-
L6 <-- ESLAG --> TS4
148-
L7 <-- ESLAG --> TS4
149-
150-
subgraph VPC 1
151-
TS1
152-
TS2
153-
TS3
154-
TS4
155-
end
156-
157-
subgraph MCLAG
158-
L2
159-
L3
160-
end
161-
162-
subgraph ESLAG
163-
L3
164-
L4
165-
L5
166-
L6
167-
L7
168-
end
169-
170-
```
171-
#### Fabric Connections
172-
173-
Fabric connections serve as connections between switches, they form the fabric of the network.
174-
175-
176-
### VPC Peering
177-
178-
VPCs need VPC Peerings to talk to each other. VPC Peerings come in two varieties: local and remote.
86+
A VPC enables Layer 3 isolation and serves as the primary building block for network architecture. Hosts within a VPC belong to the same broadcast domain and can communicate with each other. If desired, a single VPC can be configured with multiple broadcast domains. For communication between VPCs, a *peering* connection must be established. VPCs can logically separate workloads, enabling additional controls. This separation isn't limited to traditional database, web, and compute layers - it can accommodate development teams requiring isolation, building tenants, or any other organizational structure that benefits from network control. Once VPCs are defined, you can establish traffic priorities, implement security measures, and plan the physical wiring. The fabric allows VPCs to span multiple switches, providing enhanced flexibility.
17987
180-
``` mermaid
88+
```mermaid
18189
graph TD
182-
S1([Spine 1])
183-
S2([Spine 2])
184-
L1([Leaf 1])
185-
L2([Leaf 2])
186-
TS1[Server1]
187-
TS2[Server2]
188-
TS3[Server3]
189-
TS4[Server4]
190-
191-
S1 & S2 <--> L1 & L2
192-
L1 <--> TS1 & TS2
193-
L2 <--> TS3 & TS4
194-
195-
196-
subgraph VPC 1
197-
TS1
198-
TS2
199-
end
200-
201-
subgraph VPC 2
202-
TS3
203-
TS4
204-
end
205-
```
206-
207-
#### Local VPC Peering
208-
209-
When there is no dedicated border/peering switch available in the fabric we can use local VPC peering. This kind of peering tries sends traffic between the two VPC's on the switch where either of the VPC's has workloads attached. Due to limitation in the Sonic network operating system this kind of peering bandwidth is limited to the number of VPC loopbacks you have selected while initializing the fabric. Traffic between the VPCs will use the loopback interface, the bandwidth of this connection will be equal to the bandwidth of port used in the loopback.
210-
211-
``` mermaid
212-
graph TD
213-
214-
L1([Leaf 1])
215-
S1[Server1]
216-
S2[Server2]
217-
S3[Server3]
218-
S4[Server4]
219-
220-
L1 <-.2,loopback.-> L1;
221-
L1 <-.3.-> S1;
222-
L1 <--> S2 & S4;
223-
L1 <-.1.-> S3;
224-
225-
subgraph VPC 1
226-
S1
227-
S2
228-
end
229-
230-
subgraph VPC 2
231-
S3
232-
S4
233-
end
90+
%% Styling
91+
classDef switch fill:#f9f,stroke:#333,stroke-width:2px;
92+
classDef server fill:#9cf,stroke:#333,stroke-width:2px;
93+
classDef vpc fill:none,stroke:#666,stroke-width:2px,stroke-dasharray: 5 5;
94+
95+
%% Nodes
96+
L1([Leaf 1])
97+
L2([Leaf 2])
98+
S1["Server 1
99+
10.7.71.1"]
100+
S2["Server 2
101+
172.16.2.31"]
102+
S3["Server 3
103+
192.168.18.85"]
104+
105+
L1 -- S1
106+
L1 -- S2
107+
L2 -- S3
108+
109+
subgraph VPC 1
110+
S1
111+
S2
112+
S3
113+
end
234114
```
235-
The dotted line in the diagram shows the traffic flow for local peering. The traffic originates in VPC 2, travels to the switch, travels out the first loopback port, into the second loopback port, and finally out the port destined for VPC 1.
236-
237115

238-
#### Remote VPC Peering
239-
240-
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 VPC's 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.
241-
242-
``` mermaid
243-
graph TD
244-
S1([Spine 1])
245-
S2([Spine 2])
246-
L1([Leaf 1])
247-
L2([Leaf 2])
248-
L3([Leaf 3])
249-
TS1[Server1]
250-
TS2[Server2]
251-
TS3[Server3]
252-
TS4[Server4]
116+
## Connection
253117

254-
S1 <-.5.-> L1;
255-
S1 <-.2.-> L2;
256-
S1 <-.3,4.-> L3;
257-
S2 <--> L1;
258-
S2 <--> L2;
259-
S2 <--> L3;
260-
L1 <-.6.-> TS1;
261-
L1 <--> TS2;
262-
L2 <--> TS3;
263-
L2 <-.1.-> TS4;
118+
A connection represents the physical cabling in your data center. Connections link switches to other switches or switches to servers.
264119

120+
#### Server Connections
265121

266-
subgraph VPC 1
267-
TS1
268-
TS2
269-
end
270-
271-
subgraph VPC 2
272-
TS3
273-
TS4
274-
end
275-
```
276-
The dotted line in the diagram shows the traffic flow for remote peering. The traffic could take a different path because of ECMP. It is important to note that Leaf 3 cannot have any servers from VPC 1 or VPC 2 on it, but it can have a different VPC attached to it.
277-
278-
#### VPC Loopback
279-
280-
A VPC loopback is a physical cable with both ends plugged into the same switch, suggested but not required to be the adjacent ports. This loopback allows two different VPCs to communicate with each other. This is due to a Broadcom limitation.
122+
A server connection links servers to the fabric. The fabric configures server-facing ports according to the connection type (MLAG, Bundle, etc). Server administrators must handle the configuration of the server side. Server port names serve as metadata to identify connections and are not validated by the fabric. Server connections include:
281123

124+
- *Unbundled* - A single cable connecting switch to server
125+
- *Bundled* - Two or more cables connecting to a single switch (LAG or similar)
126+
- *MCLAG* - Two cables connecting to two different switches (dual homing), requiring a fabric link between switches
127+
- *ESLAG* - Two to four cables connecting to different switches (multi-homing), requiring four switches when using four links

0 commit comments

Comments
 (0)