Skip to content

Commit cbea42e

Browse files
committed
improve cluster upgrade instructions
1 parent fc44a68 commit cbea42e

File tree

5 files changed

+74
-67
lines changed

5 files changed

+74
-67
lines changed

docs/admin/runai-setup/cluster-setup/cluster-install.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,15 @@ Using the cluster wizard:
1717

1818
* Choose a name for your cluster.
1919
* Choose the Run:ai version for the cluster.
20-
* Choose a target Kubernetes distribution (see [table](cluster-prerequisites.md#kubernetes) for supported distributions).
20+
* v2.11 / v2.13 - Choose a target Kubernetes distribution.
21+
2122
* (SaaS and remote self-hosted cluster only) Enter a URL for the Kubernetes cluster. The URL need only be accessible within the organization's network. For more informtaion see [here](cluster-prerequisites.md#cluster-url).
2223
* Press `Continue`.
2324

2425
On the next page:
2526

26-
* (SaaS and remote self-hosted cluster only) Install a trusted certificate to the domain entered above.
27+
* (SaaS and remote self-hosted cluster only) Install a [trusted certificate](cluster-prerequisites.md#cluster-url) to the domain entered above.
28+
2729
* Run the [Helm](https://helm.sh/docs/intro/install/) command provided in the wizard.
2830
* In case of a failure, see the [Installation troubleshooting guide](../../troubleshooting/troubleshooting.md#installation).
2931

docs/admin/runai-setup/cluster-setup/cluster-prerequisites.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ Following is a Kubernetes support matrix for the latest Run:ai releases:<a name=
5656

5757
| Run:ai version | Supported Kubernetes versions | Supported OpenShift versions |
5858
|----------------|-------------------------------|--------|
59-
| Run:ai 2.9 | 1.21 through 1.26 | 4.8 through 4.11 |
6059
| Run:ai 2.10 | 1.21 through 1.26 (see note below) | 4.8 through 4.11 |
6160
| Run:ai 2.13 | 1.23 through 1.28 (see note below) | 4.10 through 4.13 |
6261
| Run:ai 2.15 | 1.25 through 1.28 | 4.11 through 4.13 |

docs/admin/runai-setup/cluster-setup/cluster-upgrade.md

Lines changed: 4 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,18 @@
11

22
# Upgrading a Cluster Installation
3+
Below are instructions on how to upgrade a Run:ai cluster.
34

4-
## Find out Run:ai Cluster version
5+
## Upgrade Run:ai cluster
56

6-
To find the Run:ai cluster version, run:
7-
8-
```
9-
helm list -n runai -f runai-cluster
10-
```
11-
12-
and record the chart version in the form of `runai-cluster-<version-number>`
13-
14-
## Upgrade Run:ai cluster
15-
16-
### Upgrade from version 2.15+
177
* In the Run:ai interface, navigate to `Clusters`.
188
* Select the cluster you want to upgrade.
199
* Click on `Get Installation instructions`.
20-
* Choose the `Run:ai version` to be installed on the Cluster.
10+
* Optional: Choose the `Run:ai version` to upgrade to (default: latest)
2111
* Press `Continue`.
2212
* Copy the [Helm](https://helm.sh/docs/intro/install/) command provided in the `Installation Instructions` and run it on in the cluster.
2313
* In the case of a failure, refer to the [Installation troubleshooting guide](../../troubleshooting/troubleshooting.md#installation).
2414

25-
### Upgrade from version 2.9, 2.10, 2.11 or 2.12
26-
Run:
27-
28-
```
29-
helm get values runai-cluster -n runai > old-values.yaml
30-
```
31-
32-
1. Review the file `old-values.yaml` and see if there are any changes performed during the last installation.
33-
2. Follow the instructions for [Installing Run:ai](cluster-install.md#install-runai) to download a new values file.
34-
3. Merge the changes from Step 1 into the new values file.
35-
4. Run `helm upgrade` as per the instructions in the link above.
36-
37-
38-
!!! Note
39-
To upgrade to a __specific__ version of the Run:ai cluster, add `--version <version-number>` to the `helm upgrade` command. You can find the relevant version with `helm search repo` as described above.
40-
41-
### Upgrade from version 2.7 or 2.8
42-
43-
The process of upgrading from 2.7 or 2.8 requires [uninstalling](./cluster-delete.md) and then [installing](./cluster-install.md) again. No data is lost during the process.
44-
45-
!!! Note
46-
The reason for this process is that Run:ai 2.9 cluster installation no longer installs pre-requisites. As such ownership of dependencies such as Prometheus will be undefined if a `helm upgrade` is run.
47-
48-
The process:
49-
50-
* Delete the Run:ai cluster installation according to these [instructions](cluster-delete.md) (do not delete the Run:ai cluster __object__ from the user interface).
51-
* The following commands should be executed __after__ running the helm uninstall command
52-
```
53-
kubectl -n runai delete all --all
54-
kubectl -n runai delete cm --all
55-
kubectl -n runai delete secret --all
56-
kubectl -n runai delete roles --all
57-
kubectl -n runai delete rolebindings --all
58-
kubectl -n runai delete ingress --all
59-
kubectl -n runai delete servicemonitors --all
60-
kubectl -n runai delete podmonitors --all
61-
kubectl delete validatingwebhookconfigurations.admissionregistration.k8s.io -l app=runai
62-
kubectl delete mutatingwebhookconfigurations.admissionregistration.k8s.io -l app=runai
63-
kubectl delete svc -n kube-system runai-cluster-kube-prometh-kubelet
64-
```
65-
* Install the mandatory Run:ai [prerequisites](cluster-prerequisites.md):
66-
* If you have previously installed the SaaS version of Run:ai version 2.7 or below, you will need to install both [Ingress Controller](cluster-prerequisites.md#ingress-controller) and [Prometheus](cluster-prerequisites.md#prometheus).
67-
* If you have previously installed the SaaS version of Run:ai version 2.8 or any Self-hosted version of Run:ai, you will need to install [Prometheus](cluster-prerequisites.md#prometheus) only.
68-
69-
70-
* Install Run:ai cluster as described [here](cluster-install.md)
71-
72-
## Verify Successful Installation
73-
15+
## Verify Successful Upgrade
7416
See [Verify your installation](cluster-install.md#verify-your-clusters-health) on how to verify a Run:ai cluster installation
7517

7618

docs/admin/runai-setup/self-hosted/k8s/upgrade.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,4 +142,36 @@ The Run:ai control-plane installation has been rewritten and is no longer using
142142

143143
## Upgrade Cluster
144144

145-
To upgrade the cluster follow the instructions [here](../../cluster-setup/cluster-upgrade.md).
145+
Follow the steps bellow, based on the Run:ai Cluster version you would like to upgrade to:
146+
147+
=== "2.15-latest"
148+
* In the Run:ai interface, navigate to `Clusters`.
149+
* Select the cluster you want to upgrade.
150+
* Click on `Get Installation instructions`.
151+
* Choose the `Run:ai version` to upgrade to.
152+
* Select the `Cluster location`. If the Cluster locaiton is remote to the control plane - Enter the `Cluster URL`.
153+
* Press `Continue`.
154+
* Copy the [Helm](https://helm.sh/docs/intro/install/) command provided in the `Installation Instructions` and run it on in the cluster.
155+
* In the case of a failure, refer to the [Installation troubleshooting guide](../../troubleshooting/troubleshooting.md#installation).
156+
157+
=== "2.13"
158+
Run:
159+
160+
```
161+
helm get values runai-cluster -n runai > old-values.yaml
162+
```
163+
164+
* Review the file `old-values.yaml` and see if there are any changes performed during the last installation.
165+
* In the Run:ai interface, navigate to `Clusters`.
166+
* Select the cluster you want to upgrade.
167+
** Click on `Get Installation instructions`.
168+
* Select `Run:ai version: 2.13`.
169+
* Select the `cluster's Kubernetes distribution` and the `Cluster location`
170+
* If the Cluster locaiton is remote to the control plane - Enter a URL for the Kubernetes cluster.
171+
* Press `Continue`.
172+
* Follow the instructions to download a new values file.
173+
* Merge the changes from Step 1 into the new values file.
174+
* Copy the [Helm](https://helm.sh/docs/intro/install/) command provided in the `Installation Instructions` and run it on in the cluster.
175+
176+
## Verify Successful Installation
177+
See [Verify your installation](../../cluster-setup/cluster-install.md#verify-your-clusters-health) on how to verify a Run:ai cluster installation

docs/admin/runai-setup/self-hosted/ocp/upgrade.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,4 +125,36 @@ The Run:ai control-plane installation has been rewritten and is no longer using
125125

126126
## Upgrade Cluster
127127

128-
To upgrade the cluster follow the instructions [here](../../cluster-setup/cluster-upgrade.md).
128+
Follow the steps bellow, based on the Run:ai Cluster version you would like to upgrade to:
129+
130+
=== "2.15-latest"
131+
* In the Run:ai interface, navigate to `Clusters`.
132+
* Select the cluster you want to upgrade.
133+
* Click on `Get Installation instructions`.
134+
* Choose the `Run:ai version` to upgrade to.
135+
* Select the `Cluster location`. If the Cluster locaiton is remote to the control plane - Enter the `Cluster URL`.
136+
* Press `Continue`.
137+
* Copy the [Helm](https://helm.sh/docs/intro/install/) command provided in the `Installation Instructions` and run it on in the cluster.
138+
* In the case of a failure, refer to the [Installation troubleshooting guide](../../troubleshooting/troubleshooting.md#installation).
139+
140+
=== "2.13"
141+
Run:
142+
143+
```
144+
helm get values runai-cluster -n runai > old-values.yaml
145+
```
146+
147+
* Review the file `old-values.yaml` and see if there are any changes performed during the last installation.
148+
* In the Run:ai interface, navigate to `Clusters`.
149+
* Select the cluster you want to upgrade.
150+
** Click on `Get Installation instructions`.
151+
* Select `Run:ai version: 2.13`.
152+
* Select the `cluster's Kubernetes distribution` and the `Cluster location`
153+
* If the Cluster locaiton is remote to the control plane - Enter a URL for the Kubernetes cluster.
154+
* Press `Continue`.
155+
* Follow the instructions to download a new values file.
156+
* Merge the changes from Step 1 into the new values file.
157+
* Copy the [Helm](https://helm.sh/docs/intro/install/) command provided in the `Installation Instructions` and run it on in the cluster.
158+
159+
## Verify Successful Installation
160+
See [Verify your installation](../../cluster-setup/cluster-install.md#verify-your-clusters-health) on how to verify a Run:ai cluster installation

0 commit comments

Comments
 (0)