remove references to mangement connections as applied to fabric links

githedgehog · Oct 23, 2024 · be68212 · be68212
1 parent 071a1bb
commit be68212
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 39 deletions.
diff --git a/docs/install-upgrade/overview.md b/docs/install-upgrade/overview.md
@@ -44,7 +44,7 @@ Hedgehog has created a command line utility, called `hhfab`, that helps generate
 1. `hhfab validate`
 1. `hhfab build`
 
-The installer for the fabric is generated in `$WORKDIR/result/`. This installation image is named `control-1-usb.img` and is 7.5 GB in size. Once the image is created, you can write it to a USB drive, or mount it via virtual media.
+The installer for the fabric is generated in `$WORKDIR/result/`. This installation image is named `control-1-install-usb.img` and is 7.5 GB in size. Once the image is created, you can write it to a USB drive, or mount it via virtual media.
 
 ### Write USB Image to Disk
 
@@ -54,7 +54,7 @@ The installer for the fabric is generated in `$WORKDIR/result/`. This installati
 1. Insert the usb to your machine
 1. Identify the path to your USB stick, for example: `/dev/sdc`
 1. Issue the command to write the image to the USB drive
-    - `sudo dd if=/path/to/control-os/img of=/dev/sdc bs=4k status=progress`
+    - `sudo dd if=control-1-install-usb.img of=/dev/sdc bs=4k status=progress`
 
 There are utilities that assist this process such as [etcher](https://etcher.balena.io/).
 

diff --git a/docs/reference/api.md b/docs/reference/api.md
@@ -1870,7 +1870,6 @@ _Appears in:_
 | `label` _string_ | Label defines the physical port label you can see on the actual switch |  |  |
 | `group` _string_ | If port isn't directly manageable, group defines the group it belongs to, exclusive with profile |  |  |
 | `profile` _string_ | If port is directly configurable, profile defines the profile it belongs to, exclusive with group |  |  |
-| `management` _boolean_ | Management defines if port is a management port, it's a special case and it can't have a group or profile |  |  |
 | `oniePortName` _string_ | OniePortName defines the ONIE port name for management ports only |  |  |
 
 

diff --git a/docs/user-guide/connections.md b/docs/user-guide/connections.md
@@ -197,27 +197,6 @@ spec:
         port: s5248-01/Ethernet19
 ```
 
-## Management
-
-Management connections define connections to the Control Node.
-
-```yaml
-apiVersion: wiring.githedgehog.com/v1beta1
-kind: Connection
-metadata:
-  name: control-1--mgmt--s5248-01-front
-  namespace: default
-spec:
-  management:
-    link: # Defines a single link between a control node and a switch
-      server:
-        ip: 172.30.20.0/31
-        port: control-1/enp2s1
-      switch:
-        ip: 172.30.20.1/31
-        port: s5248-01/Ethernet0
-```
-
 ## Connecting Fabric to the outside world
 
 Connections in this section provide connectivity to the outside world. For example, they can be connections to the

diff --git a/docs/user-guide/profiles.md b/docs/user-guide/profiles.md
@@ -81,6 +81,3 @@ the example above. Omitting the breakout number is allowed for the first breakou
 `E1/55/1`. The breakout ports are always consecutive numbers independent of the lanes allocation and other
 implementation details.
 
-### Management ports
-
-Not configurable, no port profile, only used for connecting the switch to the control node.
diff --git a/docs/user-guide/shrink-expand.md b/docs/user-guide/shrink-expand.md
@@ -3,15 +3,15 @@
 This section provides a brief overview of how to add or remove switches within the fabric using Hedgehog Fabric API, and
 how to manage connections between them.
 
-Manipulating API objects is done with the assumption that target devices are correctly cabeled and connected.
+Manipulating API objects is done with the assumption that target devices are correctly cabled and connected.
 
 This article uses terms that can be found in the [Hedgehog Concepts](../concepts/overview.md), the [User
 Guide](overview.md) documentation, and the [Fabric API](../reference/api.md) reference.
 
 ### Add a switch to the existing fabric
 
 In order to be added to the Hedgehog Fabric, a switch should have a corresponding `Switch` object. An example on how to define
-this object is available in the [User Guilde](devices.md).
+this object is available in the [User Guild](devices.md).
 
 !!! note
     If the`Switch` will be used in `ESLAG` or `MCLAG` groups, appropriate groups should exist. Redundancy groups should
@@ -22,13 +22,11 @@ connections may differ based on the `Switch` role given to the device. For more
 section](connections.md).
 
 !!! note
-    If the switch is facing a Control Node Connection on the front-panel port, the switch port should be described in a
-    `Management` connection.
-
-!!! note
-    Switch devices should be booted in `ONIE` or `HONIE` installation mode to install SONiC OS and configure the Fabric
+    Switch devices should be booted in `ONIE` installation mode to install SONiC OS and configure the Fabric
     Agent.
 
+Ensure the management port of the switch is connected to fabric management network.
+
 ### Remove a switch from the existing fabric
 
 Before you decommission a switch from the Hedgehog Fabric, several preparation steps are necessary.

diff --git a/docs/vlab/running.md b/docs/vlab/running.md
@@ -282,11 +282,6 @@ For connections, use:
 ```console
 core@control-1 ~ $ kubectl get connection
 NAME                                 TYPE           AGE
-control-1--mgmt--leaf-01             management     6h11m
-control-1--mgmt--leaf-02             management     6h11m
-control-1--mgmt--leaf-03             management     6h11m
-control-1--mgmt--spine-01            management     6h11m
-control-1--mgmt--spine-02            management     6h11m
 leaf-01--mclag-domain--leaf-02       mclag-domain   6h11m
 leaf-01--vpc-loopback                vpc-loopback   6h11m
 leaf-02--vpc-loopback                vpc-loopback   6h11m