Skip to content

docs: add outage expectation, order and gateway node upgrade to upgrade page #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Frostman merged 1 commit into from
Oct 7, 2026
Merged

docs: add outage expectation, order and gateway node upgrade to upgrade page #356

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/install-upgrade/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
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 are upgraded using the control node.

!!! warning
Plan for an outage during the upgrade: traffic that goes through the gateways can be
interrupted while the gateway components restart during the control node upgrade.
Upgrade the control node first and then the gateway nodes, if your fabric has any.

In order to apply the upgrade, use the following instructions:

1. Generate the current configuration of your fabric:
Expand Down Expand Up @@ -34,6 +39,45 @@ Upgrade process is idempotent and can be run multiple times without any issues.
Check the [release notes](../release-notes/index.md) for your version to see if a [SONiC
Upgrade](#upgrade-sonic) is available.

### Upgrade gateway nodes

If your fabric has gateway nodes, upgrade them after the control node upgrade has finished.
The same `hhfab build --mode=manual` run that generated the control node package also
generates one package per gateway node; for a gateway node named `gateway-1`, it will be
`result/node--gateway-1--install.tgz`.

For each gateway node:

1. upload its package to the gateway node (e.g. using `scp`)
1. unpack and run `hhfab-recipe upgrade` from the resulting directory

```bash
tar xzf node--gateway-1--install.tgz
cd node--gateway-1--install
sudo ./hhfab-recipe upgrade
```

After the upgrade, check from the control node that the gateway node is `Ready`:

```console
core@control-1 ~ $ kubectl get nodes
NAME STATUS ROLES AGE VERSION
control-1 Ready control-plane,etcd 2d2h v1.34.1+k3s1
gateway-1 Ready <none> 2d2h v1.34.1+k3s1
```

and that its gateway pods, named `gw--<gateway name>--...`, are `Running`:

```console
core@control-1 ~ $ kubectl -n fab get pods
NAME READY STATUS RESTARTS AGE
gw--gateway-1--dataplane-qtp7p 1/1 Running 0 5m
gw--gateway-1--frr-64jzt 2/2 Running 0 5m
[..]
```

The other pods in the `fab` namespace are listed as well.

## Install SONiC using ONIE

As the switches boot up, select the `ONIE` option from the grub screen. From
Expand Down
Loading