Skip to content

Commit 604be52

Browse files
committed
chore: deprecate collapsed-core topology
Signed-off-by: Sergei Lukianov <[email protected]>
1 parent 3a0224c commit 604be52

File tree

5 files changed

+27
-17
lines changed

5 files changed

+27
-17
lines changed

docs/architecture/fabric.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ The Hedgehog Fabric currently supports two underlay network topologies.
1414

1515
### Collapsed Core
1616

17+
!!! warning
18+
Collapsed Core is deprecated starting from 25.03 release and will be removed in a future releases. It'll be replaced
19+
by a new mesh topology that will work in a similar way to the spine-leaf topology but with leaf switches directly
20+
connected to each other.
21+
1722
A collapsed core topology is just a pair of switches connected in a MCLAG configuration with no other network elements.
1823
All workloads attach to these two switches.
1924

docs/install-upgrade/config.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Fabric Configuration
22
## Overview
33
The `fab.yaml` file is the configuration file for the fabric. It supplies
4-
the configuration of the users, their credentials, logging, telemetry, and
5-
other non wiring related settings. The `fab.yaml` file is composed of multiple
6-
YAML objects inside of a single file. Per the YAML spec 3 hyphens (`---`) on
7-
a single line separate the end of one object from the beginning of the next.
8-
There are two YAML objects in the `fab.yaml` file. For more information about
4+
the configuration of the users, their credentials, logging, telemetry, and
5+
other non wiring related settings. The `fab.yaml` file is composed of multiple
6+
YAML objects inside of a single file. Per the YAML spec 3 hyphens (`---`) on
7+
a single line separate the end of one object from the beginning of the next.
8+
There are two YAML objects in the `fab.yaml` file. For more information about
99
how to use `hhfab init`, run `hhfab init --help`.
1010

1111
## HHFAB workflow
@@ -35,7 +35,7 @@ The following example outlines a comprehensive Fabricator configuration. You
3535
can find further configuration details in the Fabricator [API
3636
Reference](../reference/fab-api.md).
3737

38-
``` { .yaml .annotate title="fab.yaml" linenums="1"}
38+
``` { .yaml .annotate title="fab.yaml" linenums="1"}
3939
apiVersion: fabricator.githedgehog.com/v1beta1
4040
kind: Fabricator
4141
metadata:
@@ -57,7 +57,7 @@ spec:
5757
- "ssh-ed25519 key..." # generate ssh key with ssh-keygen
5858
5959
fabric:
60-
mode: spine-leaf # "spine-leaf" or "collapsed-core"
60+
mode: spine-leaf # "spine-leaf" or "collapsed-core" (deprecated)
6161
includeONIE: true
6262
defaultSwitchUsers:
6363
admin: # at least one user with name 'admin' and role 'admin'
@@ -109,15 +109,15 @@ spec:
109109
### Configure Control Node and Switch Users
110110

111111
#### Control Node Users
112-
Configuring control node and switch users is done either passing
113-
`--default-password-hash` to `hhfab init` or editing the resulting `fab.yaml`
112+
Configuring control node and switch users is done either passing
113+
`--default-password-hash` to `hhfab init` or editing the resulting `fab.yaml`
114114
file emitted by `hhfab init`. The default username on the control node is
115115
`core`.
116116

117117
#### Switch Users
118118
There are two users on the switches, `admin` and `operator`. The `operator` user has
119119
read-only access to `sonic-cli` command on the switches. The `admin` user has
120-
broad administrative power on the switch.
120+
broad administrative power on the switch.
121121
To avoid conflicts, do not use the following usernames: `operator`,`hhagent`,`netops`.
122122

123123
### NTP and DHCP
@@ -126,17 +126,17 @@ The control node runs a DHCP server on the management network. See the [example
126126
file](#complete-example-file).
127127

128128
### Control Node
129-
The control node is the host that manages all the switches, runs k3s, and serves images.
130-
The **management** interface is for the control node to manage the fabric
131-
switches, *not* end-user management of the control node. For end-user
129+
The control node is the host that manages all the switches, runs k3s, and serves images.
130+
The **management** interface is for the control node to manage the fabric
131+
switches, *not* end-user management of the control node. For end-user
132132
management of the control node specify the **external** interface name.
133133

134134
### Telemetry
135135

136136
There is an option to enable [Grafana
137137
Alloy](https://grafana.com/docs/alloy/latest/) on all switches to forward metrics and logs to the configured targets using
138138
[Prometheus Remote-Write
139-
API](https://prometheus.io/docs/specs/prw/remote_write_spec/) and Loki API. Metrics includes port speeds, counters,
139+
API](https://prometheus.io/docs/specs/prw/remote_write_spec/) and Loki API. Metrics includes port speeds, counters,
140140
errors, operational status, transceivers, fans, power supplies, temperature
141141
sensors, BGP neighbors, LLDP neighbors, and more. Logs include Hedgehog agent
142142
logs. Modify the URL as needed, instead of `/api/v1/push` it could be

docs/vlab/demo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can find instructions on how to setup VLAB in the [Overview](overview.md) an
1010
## Default topology
1111

1212
The default topology is Spine-Leaf with 2 spines, 2 MCLAG leaves, 2 ESLAG leaves and 1 non-MCLAG leaf. Optionally, you can choose to run
13-
the default Collapsed Core topology using flag `--fabric-mode collapsed-core` (or `-m collapsed-core`) which only
13+
the default Collapsed Core topology (deprecated) using flag `--fabric-mode collapsed-core` (or `-m collapsed-core`) which only
1414
consists of 2 switches.
1515

1616
For more details on customizing topologies see the [Running VLAB](running.md) section.

docs/vlab/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ The following packages needs to be installed: `qemu-kvm socat`. Docker is also r
2626
into the OCI registry.
2727

2828
By default, the VLAB topology is Spine-Leaf with 2 spines, 2 MCLAG leaves and 1 non-MCLAG leaf. Optionally, you can
29-
choose to run the default Collapsed Core topology using flag `--fabric-mode collapsed-core` (or `-m collapsed-core`)
30-
which only consists of 2 switches.
29+
choose to run the default Collapsed Core topology (deprecated) using flag `--fabric-mode collapsed-core`
30+
(or `-m collapsed-core`) which only consists of 2 switches.
3131

3232
You can calculate the system requirements based on the allocated resources to the VMs using the following table:
3333

docs/vlab/running.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,11 @@ You can jump [to the instructions](#build-the-installer-and-start-vlab) to start
166166

167167
### Collapsed Core
168168

169+
!!! warning
170+
Collapsed Core is deprecated starting from 25.03 release and will be removed in a future releases. It'll be replaced
171+
by a new mesh topology that will work in a similar way to the spine-leaf topology but with leaf switches directly
172+
connected to each other.
173+
169174
If a Collapsed Core topology is desired, after the `hhfab init --dev` step, edit the resulting `fab.yaml` file and change the `mode: spine-leaf` to `mode: collapsed-core`:
170175

171176
```console

0 commit comments

Comments
 (0)