From 79dc2de2332ed154bf753e6c56e185643befb1d3 Mon Sep 17 00:00:00 2001 From: Logan Blyth Date: Mon, 25 Nov 2024 17:43:01 -0500 Subject: [PATCH] Upgrade info (#46) --- docs/getting-started/download.md | 2 +- docs/index.md | 2 +- docs/install-upgrade/.pages | 4 ++- .../{overview.md => install.md} | 3 -- docs/install-upgrade/upgrade.md | 28 +++++++++++++++++++ 5 files changed, 33 insertions(+), 6 deletions(-) rename docs/install-upgrade/{overview.md => install.md} (99%) create mode 100644 docs/install-upgrade/upgrade.md diff --git a/docs/getting-started/download.md b/docs/getting-started/download.md index 6a1092bb..2f9a5c70 100644 --- a/docs/getting-started/download.md +++ b/docs/getting-started/download.md @@ -50,5 +50,5 @@ curl -fsSL https://i.hhdev.io/oras | bash * [Concepts](../concepts/overview.md) * [Virtual LAB](../vlab/overview.md) -* [Installation](../install-upgrade/overview.md) +* [Installation](../install-upgrade/install.md) * [User guide](../user-guide/overview.md) diff --git a/docs/index.md b/docs/index.md index 555a65ac..98f28ba9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,4 +11,4 @@ You can read more about its [concepts](concepts/overview.md) and [architecture]( documentation. You can find out how to [download](getting-started/download.md) and try the Fabric on the self-hosted -[fully virtualized lab](vlab/overview.md) or on [hardware](install-upgrade/overview.md). +[fully virtualized lab](vlab/overview.md) or on [hardware](install-upgrade/install.md). diff --git a/docs/install-upgrade/.pages b/docs/install-upgrade/.pages index 5be44636..6842624c 100644 --- a/docs/install-upgrade/.pages +++ b/docs/install-upgrade/.pages @@ -1,6 +1,8 @@ nav: - - Overview: overview.md + - Install: install.md - Supported Devices: supported-devices.md - System Requirements: requirements.md - Build Wiring Diagram: build-wiring.md - Fabric Configuration: config.md + - ... + - Upgrade: upgrade.md diff --git a/docs/install-upgrade/overview.md b/docs/install-upgrade/install.md similarity index 99% rename from docs/install-upgrade/overview.md rename to docs/install-upgrade/install.md index f7443afd..ac8aea0a 100644 --- a/docs/install-upgrade/overview.md +++ b/docs/install-upgrade/install.md @@ -1,8 +1,5 @@ # Install Fabric -!!! warning "" - Under construction. - ## Prerequisites * A machine with access to the Internet to use Fabricator and build installer with at least 8 GB RAM and 25 GB of disk space diff --git a/docs/install-upgrade/upgrade.md b/docs/install-upgrade/upgrade.md new file mode 100644 index 00000000..f761b2a1 --- /dev/null +++ b/docs/install-upgrade/upgrade.md @@ -0,0 +1,28 @@ +# Upgrading from Alpha-7 to Beta-1 +## Control Node +Ensure the hardware that is to be used for the control node meets the [system requirements](requirements.md#control-node). The upgrade process is destructive of the host, so ensure all data needed is removed from the selected server before the upgrade is started. + +## Management Network +Beta-1 uses the RJ-45 management ports of the switches instead of front panel ports. A simple management network will need to be in place and cabled before the install of Beta-1. The control node will run a DHCP server on this network and must be the sole DHCP server. Do not co-mingle other services or equipment on this network, it is for the exclusive use of the control node and switches. + +## Install Switch Vendor ONIE +Beta-1 uses the switch vendor ONIE for installation of the NOS. The latest vendor provided version of ONIE is recommended to be installed. Hedgehog ONIE **must not** be used. + + +## Changes to the Wiring Diagram + +* All API versions changed from `v1alpha2` to `v1beta1` +* `Server[control=true]` object type was removed and replaced with `ControlNode` object in the `fabricator.githedgehog.com/v1beta1` API (.spec.control field removed), `Server` object only describes workload server now +* All initial configuration is mainly still available using the `hhfab init` flags but now configurable in the `fab.yaml` file it creates and available in the runtime in the `Fabricator` object in the `fabricator.githedgehog.com/v1beta1` API +* `Connection[type=management]` object removed, relevant information is now present on the `ControlNode` object in the form of the management interface and its config, switches are always connected using management port +* `.spec.location` remove from `Switch` object +* `.spec.boot` added to `Switch` object with `mac` and `serial` fields, at least **one** of them is required to identify switch for installation + +## Install The Control Node +Follow the [instructions](install.md#build-control-node-configuration-and-installer) for installing the Beta-1 Fabric on a control node. + + +## Install NOS using ONIE NOS Install Option +As the switches boot up, select the ONIE option from the grub screen. From there select the "NOS Install" option. The install option will cause the switch to begin searching for installation media, this media is supplied by the control node. + +