Skip to content

chore: add upgrade script and docs for it #1341

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

Draft
cloudnull wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

chore: add upgrade script and docs for it #1341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e37c5a2
chore: add upgrade script and docs for it
cloudnull Dec 3, 2025
b0c53fd
fix: add preflights, inventory validation and command-line arguments
rackerchris Dec 12, 2025
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
32 changes: 4 additions & 28 deletions docs/k8s-kubespray-upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,38 +28,14 @@ Once the group variables are set, you can proceed with the upgrade execution.

Running an upgrade with Kubespray is fairly simple and executed via `ansible-playbook`.

Before running the playbook be sure to source your environment variables.
* We recoommend running the upgrade from a control node that is not part of the cluster being upgraded. This helps to ensure that the upgrade process is not competing for resources with the cluster being upgraded.

``` shell
source /opt/genestack/scripts/genestack.rc
```

Change to the `kubespary` directory.

``` shell
cd /opt/genestack/submodules/kubespray
```

!!! note

When running an upgrade be sure to set the `kube_version` variable to the desired version number.

Now run the upgrade.

``` shell
ansible-playbook upgrade-cluster.yml -e kube_version=${VERSION_NUMBER}
```

!!! note

While the basic command could work, be sure to include any and all flags needed for your environment before running the upgrade.

### Running an unsafe upgrade
* We also recommend running the upgrade within a `screen` or `tmux` session to help ensure that the upgrade process is not interrupted by network issues.

When running an upgrade, it is possible to force the upgrade by running the cluster playbook with the `upgrade_cluster_setup` flag set to **true**. This option is a lot faster, though does introduce the possibility of service disruption during the upgrade operation.
The script to run the upgrade can be found within the `scripts/kubespray-major-upgrade.sh` file; however, the process is fairly straightforward.

``` shell
ansible-playbook cluster.yml -e upgrade_cluster_setup=true -e kube_version=${VERSION_NUMBER}
--8<-- "scripts/kubespray-major-upgrade.sh"
```

### Upgrade Hangs
Expand Down
Loading