Skip to content

Commit cb34436

Browse files
committed
add iso related options, macos instructions, attempted diagram of control node architecure
1 parent 929d4dc commit cb34436

File tree

1 file changed

+43
-4
lines changed

1 file changed

+43
-4
lines changed

docs/install-upgrade/install.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,29 @@ Hedgehog has created a command line utility, called `hhfab`, that helps generate
4141
1. The `init` command generates a `fab.yaml` file, edit the `fab.yaml` file for your needs
4242
1. ensure the correct boot disk (e.g. `/dev/sda`) and control node NIC names are supplied
4343
1. `hhfab validate`
44-
1. `hhfab build`
44+
1. `hhfab build --mode iso`
45+
1. There are two options for the format of the bootable media. ISO and IMG. An ISO is best suited to use with IPMI based virtual media. The img file is designed for writing to a removable USB drive.
4546

46-
The installer for the fabric is generated in `$CWD/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.
47+
The installer for the fabric is generated in `$CWD/result/`. This installation image is named `control-1-install-usb.iso` 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.
4748

4849
### Write USB Image to Disk
4950

5051
!!! warning ""
5152
This will erase data on the USB disk.
5253

54+
### Steps for Linux
5355
1. Insert the USB to your machine
5456
1. Identify the path to your USB stick, for example: `/dev/sdc`
5557
1. Issue the command to write the image to the USB drive
56-
- `sudo dd if=control-1-install-usb.img of=/dev/sdc bs=4k status=progress`
58+
- `sudo dd if=control-1-install-usb.iso of=/dev/sdc bs=4k status=progress`
59+
60+
### Steps for MacOS
61+
1. Plug the drive into the computer
62+
1. Open the terminal
63+
1. Identify the drive using `diskutil list`
64+
1. Unmount the disk `diskutil unmount disk5`, the disk is specific to your environment
65+
1. Write the image to the disk: `sudo dd if=./control-1-install-usb.iso of=/dev/disk5 bs=4k status=progress`
66+
5767

5868
There are utilities that assist this process such as [etcher](https://etcher.balena.io/).
5969

@@ -84,7 +94,36 @@ This control node should be given a static IP address. Either a lease or statica
8494

8595
### Configure Management Network
8696

87-
The control node is dual-homed. It has a 10GbE interface that connects to the management network. The other link called `external` in the `fab.yaml` file is for the customer to access the control node. The management network is for the command and control of the switches that comprise the fabric. This management network can be a simple broadcast domain with layer 2 connectivity. The control node will run a DHCP and small http servers. The management network is not accessible to machines or devices not associated with the fabric.
97+
The control node is dual-homed. It has a 10GbE interface that connects to the management network. The other link called `external` in the `fab.yaml` file is for the customer to access the control node via their building IT network. The management network is for the command and control of the switches that comprise the fabric. This management network can be a simple broadcast domain with layer 2 connectivity. The control node will run a DHCP and small http servers. The management network is not accessible to machines or devices not associated with the fabric. The following diagram illustrates 3 networks for the control node. A "Local IT" network that is used for command and control or IPMI. The other network is exclusive to Hedgehog, the best solution is a dedicated network switch, but a private exclusive vlan is potentially workable.
98+
```mermaid
99+
graph LR
100+
101+
N1[IPMI]
102+
N2[SSH access to Operating system]
103+
N3[HH Exclusive Network]
104+
C1[Control Node]
105+
S1([Spine 1])
106+
S2([Spine 1])
107+
L1([Leaf 1])
108+
L2([Leaf 2])
109+
L3([Leaf 3])
110+
L4([Leaf 4])
111+
112+
subgraph itnet [Local IT Network]
113+
N1 <--> C1
114+
N2 <--> C1
115+
end
116+
117+
subgraph hhnet [HH Network Mangement]
118+
C1 <--> N3
119+
end
120+
121+
S1 & S2 <--> L1 & L2 & L3 & L4
122+
123+
hhnet <--> S1 & S2 & L1 & L2 & L3 & L4
124+
125+
```
126+
88127

89128
### Fabric Manages Switches
90129

0 commit comments

Comments
 (0)