Skip to content

Commit 825a282

Browse files
committed
changes due to feedback
1 parent cb34436 commit 825a282

File tree

1 file changed

+32
-17
lines changed

1 file changed

+32
-17
lines changed

docs/install-upgrade/install.md

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,13 @@ The main steps to install Fabric are:
3333
1. Boot them into ONIE Install Mode to have them automatically provisioned
3434

3535
## Build Control Node configuration and Installer
36-
Hedgehog has created a command line utility, called `hhfab`, that helps generate the wiring diagram and fabric configuration, validate the supplied configurations, and generate an installation image (.img) suitable for writing to a USB flash drive or mounting via IPMI virtual media. The first `hhfab` command to run is `hhfab init`. This will generate the main configuration file, `fab.yaml`. `fab.yaml` is responsible for almost every configuration of the fabric with the exception of the wiring. Each command and subcommand have usage messages, simply supply the `-h` flag to your command or sub command to see the available options. For example `hhfab vlab -h` and `hhfab vlab gen -h`.
36+
Hedgehog has created a command line utility, called `hhfab`, that helps generate the wiring diagram and fabric configuration,
37+
validate the supplied configurations, and generate an installation image (.img or .iso) suitable
38+
for writing to a USB flash drive or mounting via IPMI virtual media. The first `hhfab` command to
39+
run is `hhfab init`. This will generate the main configuration file, `fab.yaml`. `fab.yaml` is
40+
responsible for almost every configuration of the fabric with the exception of the wiring. Each
41+
command and subcommand have usage messages, simply supply the `-h` flag to your command or sub
42+
command to see the available options. For example `hhfab vlab -h` and `hhfab vlab gen -h`.
3743

3844
### HHFAB commands to make a bootable image
3945

@@ -42,7 +48,8 @@ Hedgehog has created a command line utility, called `hhfab`, that helps generate
4248
1. ensure the correct boot disk (e.g. `/dev/sda`) and control node NIC names are supplied
4349
1. `hhfab validate`
4450
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.
51+
1. There are two options for the format of the bootable media: ISO and USB. An ISO is best suited to use with IPMI based
52+
virtual media. The USB file is designed for writing to a removable USB drive. USB is the default.
4653

4754
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.
4855

@@ -55,14 +62,14 @@ The installer for the fabric is generated in `$CWD/result/`. This installation i
5562
1. Insert the USB to your machine
5663
1. Identify the path to your USB stick, for example: `/dev/sdc`
5764
1. Issue the command to write the image to the USB drive
58-
- `sudo dd if=control-1-install-usb.iso of=/dev/sdc bs=4k status=progress`
65+
- `sudo dd if=control-1-install-usb.img of=/dev/sdc bs=4k status=progress`
5966

6067
### Steps for MacOS
6168
1. Plug the drive into the computer
6269
1. Open the terminal
6370
1. Identify the drive using `diskutil list`
6471
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`
72+
1. Write the image to the disk: `sudo dd if=./control-1-install-usb.img of=/dev/disk5 bs=4k status=progress`
6673

6774

6875
There are utilities that assist this process such as [etcher](https://etcher.balena.io/).
@@ -94,37 +101,45 @@ This control node should be given a static IP address. Either a lease or statica
94101

95102
### Configure Management Network
96103

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.
104+
The control node is dual-homed. It has a 10GbE interface that connects to the management network.
105+
The other link called `external` in the `fab.yaml` file is for the customer to access the control
106+
node via their local IT network. The management network is for the command and control of the
107+
switches that comprise the fabric. The management network can be a simple broadcast domain with
108+
layer 2 connectivity. The control node will run a DHCP and a small http server. The management
109+
network is not accessible to machines or devices not associated with the fabric. The following
110+
diagram illustrates 3 network connections for the control node. A "Local IT" network that is used
111+
for IPMI and ssh access to the control node operating system. The other network is exclusive to
112+
the control node, the best solution is a dedicated network switch, but a private exclusive vlan is
113+
potentially workable.
114+
98115
```mermaid
99-
graph LR
116+
flowchart LR
100117
101-
N1[IPMI]
102-
N2[SSH access to Operating system]
103-
N3[HH Exclusive Network]
104-
C1[Control Node]
105118
S1([Spine 1])
106119
S2([Spine 1])
107120
L1([Leaf 1])
108121
L2([Leaf 2])
109122
L3([Leaf 3])
110123
L4([Leaf 4])
111124
112-
subgraph itnet [Local IT Network]
113-
N1 <--> C1
114-
N2 <--> C1
125+
subgraph ctrlnet [Fabric Control Network]
126+
C1[Control Node]
115127
end
116128
117-
subgraph hhnet [HH Network Mangement]
118-
C1 <--> N3
129+
subgraph localnet [Local IT Network]
130+
N1[IPMI]
131+
N2[SSH access to operating system]
132+
N1 <--> C1
133+
N2 <--> C1
119134
end
120135
136+
121137
S1 & S2 <--> L1 & L2 & L3 & L4
122138
123-
hhnet <--> S1 & S2 & L1 & L2 & L3 & L4
139+
ctrlnet <-..-> S1 & S2 & L1 & L2 & L3 & L4
124140
125141
```
126142

127-
128143
### Fabric Manages Switches
129144

130145
Now that the install has finished, you can start interacting with the Fabric using `kubectl`, `kubectl fabric` and `k9s`, all pre-installed as part of the Control Node installer.

0 commit comments

Comments
 (0)