|
3 | 3 |
|
4 | 4 | ## Overview
|
5 | 5 |
|
6 |
| -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. |
7 |
| - |
8 |
| -In the meantime, to have a look at working wiring diagram for Hedgehog Fabric, run the sample generator that produces |
9 |
| -working wiring diagrams: |
10 |
| - |
11 |
| -```console |
12 |
| -ubuntu@sl-dev:~$ hhfab sample -h |
13 |
| - |
14 |
| -NAME: |
15 |
| - hhfab sample - generate sample wiring diagram |
16 |
| - |
17 |
| -USAGE: |
18 |
| - hhfab sample command [command options] |
19 |
| - |
20 |
| -COMMANDS: |
21 |
| - spine-leaf, sl generate sample spine-leaf wiring diagram |
22 |
| - collapsed-core, cc generate sample collapsed-core wiring diagram |
23 |
| - help, h Shows a list of commands or help for one command |
24 |
| - |
25 |
| -OPTIONS: |
26 |
| - --help, -h show help |
27 |
| -``` |
| 6 | +A wiring diagram is a YAML file that is a digital representation of your |
| 7 | +network. You can find more YAML level details in the User Guide section [switch |
| 8 | +features and port naming](../user-guide/profiles.md) and the |
| 9 | +[api](../reference/api.md). It's mandatory for all switches to reference a |
| 10 | +`SwitchProfile` in the `spec.profile` of the `Switch` object. Only port naming |
| 11 | +defined by switch profiles could be used in the wiring diagram, NOS (or any |
| 12 | +other) port names aren't supported. An complete example wiring diagram is |
| 13 | +[below](build-wiring.md#sample-wiring-diagram). |
| 14 | + |
| 15 | +A good place to start building a wiring diagram is with the switch profiles. |
| 16 | +Start with the switches, then move onto the fabric links, and finally the |
| 17 | +server connections. |
28 | 18 |
|
29 | 19 | ### Sample Switch Configuration
|
30 | 20 | ``` { .yaml .annotate linenums="1" }
|
|
0 commit comments