Skip to content

Commit

Permalink
Deployed b7ee6b4 to dev with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
HHDocs committed Dec 19, 2024
1 parent e24cb9b commit 091fed8
Show file tree
Hide file tree
Showing 3 changed files with 250 additions and 39 deletions.
165 changes: 136 additions & 29 deletions dev/install-upgrade/upgrade/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
<div data-md-component="skip">


<a href="#upgrading-from-alpha-7-to-beta-1" class="md-skip">
<a href="#upgrade" class="md-skip">
Skip to content
</a>

Expand Down Expand Up @@ -652,57 +652,96 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#control-node" class="md-nav__link">
<a href="#upgrades-from-beta-1-onwards" class="md-nav__link">
<span class="md-ellipsis">
Control Node
Upgrades from Beta-1 onwards
</span>
</a>

<nav class="md-nav" aria-label="Upgrades from Beta-1 onwards">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#init-hhfab-dir-from-the-running-installation" class="md-nav__link">
<span class="md-ellipsis">
Init hhfab dir from the running installation
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#upgrade-from-alpha-7-to-beta-1" class="md-nav__link">
<span class="md-ellipsis">
Upgrade from Alpha-7 to Beta-1
</span>
</a>

<nav class="md-nav" aria-label="Upgrade from Alpha-7 to Beta-1">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#control-node" class="md-nav__link">
<span class="md-ellipsis">
Control Node
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#management-network" class="md-nav__link">
<span class="md-ellipsis">
Management Network
</span>
</a>

</li>

<li class="md-nav__item">
<li class="md-nav__item">
<a href="#install-switch-vendor-onie" class="md-nav__link">
<span class="md-ellipsis">
Install Switch Vendor ONIE
</span>
</a>

</li>

<li class="md-nav__item">
<li class="md-nav__item">
<a href="#changes-to-the-wiring-diagram" class="md-nav__link">
<span class="md-ellipsis">
Changes to the Wiring Diagram
</span>
</a>

</li>

<li class="md-nav__item">
<li class="md-nav__item">
<a href="#install-the-control-node" class="md-nav__link">
<span class="md-ellipsis">
Install The Control Node
</span>
</a>

</li>

<li class="md-nav__item">
<li class="md-nav__item">
<a href="#install-nos-using-onie-nos-install-option" class="md-nav__link">
<span class="md-ellipsis">
Install NOS using ONIE NOS Install Option
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -1320,57 +1359,96 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#control-node" class="md-nav__link">
<a href="#upgrades-from-beta-1-onwards" class="md-nav__link">
<span class="md-ellipsis">
Control Node
Upgrades from Beta-1 onwards
</span>
</a>

<nav class="md-nav" aria-label="Upgrades from Beta-1 onwards">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#init-hhfab-dir-from-the-running-installation" class="md-nav__link">
<span class="md-ellipsis">
Init hhfab dir from the running installation
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#upgrade-from-alpha-7-to-beta-1" class="md-nav__link">
<span class="md-ellipsis">
Upgrade from Alpha-7 to Beta-1
</span>
</a>

<nav class="md-nav" aria-label="Upgrade from Alpha-7 to Beta-1">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#control-node" class="md-nav__link">
<span class="md-ellipsis">
Control Node
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#management-network" class="md-nav__link">
<span class="md-ellipsis">
Management Network
</span>
</a>

</li>

<li class="md-nav__item">
<li class="md-nav__item">
<a href="#install-switch-vendor-onie" class="md-nav__link">
<span class="md-ellipsis">
Install Switch Vendor ONIE
</span>
</a>

</li>

<li class="md-nav__item">
<li class="md-nav__item">
<a href="#changes-to-the-wiring-diagram" class="md-nav__link">
<span class="md-ellipsis">
Changes to the Wiring Diagram
</span>
</a>

</li>

<li class="md-nav__item">
<li class="md-nav__item">
<a href="#install-the-control-node" class="md-nav__link">
<span class="md-ellipsis">
Install The Control Node
</span>
</a>

</li>

<li class="md-nav__item">
<li class="md-nav__item">
<a href="#install-nos-using-onie-nos-install-option" class="md-nav__link">
<span class="md-ellipsis">
Install NOS using ONIE NOS Install Option
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand All @@ -1396,14 +1474,43 @@



<h1 id="upgrading-from-alpha-7-to-beta-1">Upgrading from Alpha-7 to Beta-1</h1>
<h2 id="control-node">Control Node</h2>
<h1 id="upgrade">Upgrade</h1>
<h2 id="upgrades-from-beta-1-onwards">Upgrades from Beta-1 onwards</h2>
<p>Starting with Beta-1 release and onwards, the upgrade process is more streamlined and fully automated. The control node
is upgraded in place and the agents/switches is upgraded using the control node.</p>
<p>In order to apply the upgrade, the following steps need to be followed:</p>
<ul>
<li>use the <code>hhfab</code> directory from the initial deployment or init the new one using the configs from the running installation</li>
<li>run <code>hhfab build --mode=manual</code> to generate fully self-contained (airgap) upgrade package</li>
<li>for control node named <code>control-1</code> it will be <code>result/control-1-install.tgz</code></li>
<li>upload it to the control node (e.g. using <code>scp</code>)</li>
<li>unpack and run <code>hhfab-recipe control upgrade</code> from the resulting directory</li>
</ul>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>tar<span class="w"> </span>xzf<span class="w"> </span>control-1-install.tgz
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>control-1-install
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>./hhfab-recipe<span class="w"> </span>control<span class="w"> </span>upgrade
</span></code></pre></div>
<p>It'll do all necessary steps to upgrade the control node and the agents/switches. Resulting version could be checked
using <code>kubectl -n fab get fab/default -o=jsonpath='{.status.versions.fabricator.controller}'</code> and compare to the
fabricator version in the release notes.</p>
<p>Upgrade process is idempotent and can be run multiple times without any issues.</p>
<h3 id="init-hhfab-dir-from-the-running-installation">Init hhfab dir from the running installation</h3>
<p>If the original <code>hhfab</code> directory is no longer available, it is possible to export the current configuration from the
running installation and init the new <code>hhfab</code> directory with it.</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1"># on a control node</span>
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>kubectl<span class="w"> </span>hhfab<span class="w"> </span>config<span class="w"> </span><span class="nb">export</span><span class="w"> </span>&gt;<span class="w"> </span>fab.yaml
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="c1"># on a node with internet access using the exported config</span>
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>hhfab<span class="w"> </span>init<span class="w"> </span>-c<span class="w"> </span>fab.yaml
</span></code></pre></div>
<h2 id="upgrade-from-alpha-7-to-beta-1">Upgrade from Alpha-7 to Beta-1</h2>
<h3 id="control-node">Control Node</h3>
<p>Ensure the hardware that is to be used for the control node meets the <a href="../requirements/#control-node">system requirements</a>. The upgrade process is destructive of the host, so ensure all data needed is removed from the selected server before the upgrade is started.</p>
<h2 id="management-network">Management Network</h2>
<h3 id="management-network">Management Network</h3>
<p>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.</p>
<h2 id="install-switch-vendor-onie">Install Switch Vendor ONIE</h2>
<h3 id="install-switch-vendor-onie">Install Switch Vendor ONIE</h3>
<p>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 <strong>must not</strong> be used.</p>
<h2 id="changes-to-the-wiring-diagram">Changes to the Wiring Diagram</h2>
<h3 id="changes-to-the-wiring-diagram">Changes to the Wiring Diagram</h3>
<ul>
<li>All API versions changed from <code>v1alpha2</code> to <code>v1beta1</code></li>
<li><code>Server[control=true]</code> object type was removed and replaced with <code>ControlNode</code> object in the <code>fabricator.githedgehog.com/v1beta1</code> API (.spec.control field removed), <code>Server</code> object only describes workload server now</li>
Expand All @@ -1412,9 +1519,9 @@ <h2 id="changes-to-the-wiring-diagram">Changes to the Wiring Diagram</h2>
<li><code>.spec.location</code> remove from <code>Switch</code> object</li>
<li><code>.spec.boot</code> added to <code>Switch</code> object with <code>mac</code> and <code>serial</code> fields, at least <strong>one</strong> of them is required to identify switch for installation</li>
</ul>
<h2 id="install-the-control-node">Install The Control Node</h2>
<h3 id="install-the-control-node">Install The Control Node</h3>
<p>Follow the <a href="../install/#build-control-node-configuration-and-installer">instructions</a> for installing the Beta-1 Fabric on a control node.</p>
<h2 id="install-nos-using-onie-nos-install-option">Install NOS using ONIE NOS Install Option</h2>
<h3 id="install-nos-using-onie-nos-install-option">Install NOS using ONIE NOS Install Option</h3>
<p>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.</p>


Expand All @@ -1438,7 +1545,7 @@ <h2 id="install-nos-using-onie-nos-install-option">Install NOS using ONIE NOS In
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 25, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 19, 2024</span>
</span>


Expand Down
Loading

1 comment on commit 091fed8

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 Published on https://docs.githedgehog.com as production
🚀 Deployed on https://6764a237b09a296c61f49ac1--hedgehog-docs.netlify.app

Please sign in to comment.