Skip to content

Commit eb57565

Browse files
mrbojangles3Frostman
authored andcommitted
docs: cleanup of upgrade procedure
Signed-off-by: Logan Blyth <[email protected]> Apply suggestions from code review Co-authored-by: Quentin Monnet <[email protected]> instruct users to generate a fresh fabric config Signed-off-by: Logan Blyth <[email protected]>
1 parent d203494 commit eb57565

File tree

1 file changed

+14
-23
lines changed

1 file changed

+14
-23
lines changed

docs/install-upgrade/upgrade.md

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,30 @@
55
Starting with Beta-1 release and onwards, the upgrade process is more streamlined and fully automated. The control node
66
is upgraded in place and the agents/switches is upgraded using the control node.
77

8-
In order to apply the upgrade, the following steps need to be followed:
8+
In order to apply the upgrade, use the following instructions:
99

10-
- use the `hhfab` directory from the initial deployment or init the new one using the configs from the running installation
11-
- run `hhfab build --mode=manual` to generate fully self-contained (airgap) upgrade package
12-
- for control node named `control-1` it will be `result/control-1-install.tgz`
13-
- upload it to the control node (e.g. using `scp`)
14-
- unpack and run `hhfab-recipe control upgrade` from the resulting directory
10+
1. Generate the current configuration of your fabric:
11+
1. On a control node: `kubectl hhfab config export > fab.yaml`
12+
1. On the node with the new version of `hhfab`:
13+
1. `hhfab init -c fab.yaml -f`, using the fab.yaml from the previous step
14+
1. run `hhfab build --mode=manual` to generate fully self-contained (airgap) upgrade package; for a control node named `control-1`, it will be `result/control-1-install.tgz`
15+
1. upload it to the control node (e.g. using `scp`)
16+
1. unpack and run `hhfab-recipe upgrade` from the resulting directory
1517

1618
```bash
1719
tar xzf control-1-install.tgz
1820
cd control-1-install
19-
./hhfab-recipe control upgrade
21+
sudo ./hhfab-recipe upgrade
2022
```
2123

22-
It'll do all necessary steps to upgrade the control node and the agents/switches. Resulting version could be checked
23-
using `kubectl -n fab get fab/default -o=jsonpath='{.status.versions.fabricator.controller}'` and compare to the
24-
fabricator version in the release notes.
24+
The upgrade will do all necessary steps to upgrade the control node and the
25+
agents/switches. The upgrade process will prompt the user to **reboot**, as part of
26+
upgrading Flatcar on the control node. To validate that the version has been deployed,
27+
run `kubectl -n fab get fab/default -o=jsonpath='{.status.versions.fabricator.controller}'`
28+
and compare to the fabricator version in the release notes.
2529

2630
Upgrade process is idempotent and can be run multiple times without any issues.
2731

28-
### Init hhfab dir from the running installation
29-
30-
If the original `hhfab` directory is no longer available, it is possible to export the current configuration from the
31-
running installation and init the new `hhfab` directory with it.
32-
33-
```bash
34-
# on a control node
35-
kubectl hhfab config export > fab.yaml
36-
37-
# on a node with internet access using the exported config
38-
hhfab init -c fab.yaml
39-
```
40-
4132
## Upgrade from Alpha-7 to Beta-1
4233

4334
### Control Node

0 commit comments

Comments
 (0)