deprecate old versions, improve install & upgrade docs #918
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,9 @@ | ||
| # Deleting a Cluster Installation | ||
|
|
||
| To delete a Run:ai Cluster installation run the following commands: | ||
|
|
||
| ``` | ||
| helm uninstall runai-cluster -n runai | ||
| ``` | ||
|
|
||
| The command will **not** delete existing Projects, Departments, or Workloads submitted by users. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,33 +36,7 @@ If you are installing an air-gapped version of Run:ai, The Run:ai tar file conta | |
|
|
||
| Before proceeding with the upgrade, it's crucial to apply the specific prerequisites associated with your current version of Run:ai and every version in between up to the version you are upgrading to. | ||
|
|
||
| ### Upgrade from version 2.9 | ||
|
|
||
| Two significant changes to the control-plane installation have happened with version 2.12: _PVC ownership_ and _installation customization_. | ||
|
|
||
|
|
@@ -81,7 +55,6 @@ To remove the ownership in an older installation, run: | |
| kubectl patch pvc -n runai-backend pvc-thanos-receive -p '{"metadata": {"annotations":{"helm.sh/resource-policy": "keep"}}}' | ||
| kubectl patch pvc -n runai-backend pvc-postgresql -p '{"metadata": {"annotations":{"helm.sh/resource-policy": "keep"}}}' | ||
| ``` | ||
| #### Ingress | ||
|
|
||
| Delete the ingress object which will be recreated by the control plane upgrade | ||
|
|
@@ -98,9 +71,7 @@ The Run:ai control-plane installation has been rewritten and is no longer using | |
|
|
||
|
|
||
| ## Upgrade Control Plane | ||
| ### Upgrade from version 2.13, or later | ||
| === "Connected" | ||
|
|
||
| ``` bash | ||
|
|
@@ -113,9 +84,7 @@ The Run:ai control-plane installation has been rewritten and is no longer using | |
| helm get values runai-backend -n runai-backend > runai_control_plane_values.yaml | ||
| helm upgrade runai-backend control-plane-<NEW-VERSION>.tgz -n runai-backend -f runai_control_plane_values.yaml --reset-then-reuse-values | ||
| ``` | ||
| ### Upgrade from version 2.9 | ||
| * Create a `tls secret` as described in the [control plane installation](backend.md). | ||
| * Upgrade the control plane as described in the [control plane installation](backend.md). During the upgrade, you must tell the installation __not__ to create the two PVCs: | ||
|
|
||
|
|
@@ -142,4 +111,4 @@ The Run:ai control-plane installation has been rewritten and is no longer using | |
|
|
||
| ## Upgrade Cluster | ||
|
|
||
| To upgrade the cluster follow the instructions [here](../../cluster-setup/cluster-upgrade.md). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,23 +2,19 @@ | |
| title: Upgrade self-hosted OpenShift installation | ||
| --- | ||
| # Upgrade Run:ai | ||
| !!! Important | ||
| Run:ai data is stored in Kubernetes persistent volumes (PVs). Prior to Run:ai 2.12, PVs are owned by the Run:ai installation. Thus, uninstalling the `runai-backend` helm chart may delete all of your data. | ||
|
|
||
| From version 2.12 forward, PVs are owned the customer and are independent of the Run:ai installation. As such, they are subject to storage class [reclaim](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy){target=_blank} policy. | ||
|
|
||
| ## Preparations | ||
| ### Helm | ||
| Run:ai requires [Helm](https://helm.sh/){target=_blank} 3.14 or later. | ||
| Before you continue, validate your installed helm client version. | ||
| To install or upgrade Helm, see [Installing Helm](https://helm.sh/docs/intro/install/){target=_blank}. | ||
| If you are installing an air-gapped version of Run:ai, The Run:ai tar file contains the helm binary. | ||
|
|
||
| ### Software files | ||
| === "Connected" | ||
| Run the helm command below: | ||
|
|
||
|
|
@@ -32,11 +28,8 @@ If you are installing an air-gapped version of Run:ai, The Run:ai tar file conta | |
| * Upload the images as described [here](preparations.md#software-artifacts). | ||
|
|
||
| ## Before upgrade | ||
| Before proceeding with the upgrade, it's crucial to apply the specific prerequisites associated with your current version of Run:ai and every version in between up to the version you are upgrading to. | ||
|
|
||
| Before upgrading the control plane, run: | ||
|
|
||
| ``` bash | ||
|
|
@@ -49,11 +42,10 @@ kubectl delete sts -n runai-backend keycloak runai-backend-postgresql | |
|
|
||
| Then upgrade the control plane as described [below](#upgrade-control-plane). Before upgrading, find customizations and merge them as discussed below. | ||
|
|
||
| ### Upgrade from version 2.9 | ||
| Two significant changes to the control-plane installation have happened with version 2.12: _PVC ownership_ and _installation customization_. | ||
|
|
||
| #### PVC ownership | ||
| Run:ai will no longer directly create the PVCs that store Run:ai data (metrics and database). Instead, going forward, | ||
|
|
||
| * Run:ai requires a Kubernetes storage class to be installed. | ||
|
|
@@ -68,17 +60,13 @@ kubectl patch pvc -n runai-backend pvc-postgresql -p '{"metadata": {"annotation | |
| ``` | ||
|
|
||
| #### Installation customization | ||
| The Run:ai control-plane installation has been rewritten and is no longer using a _backend values file_. Instead, to customize the installation use standard `--set` flags. If you have previously customized the installation, you must now extract these customizations and add them as `--set` flag to the helm installation: | ||
|
|
||
| * Find previous customizations to the control plane if such exist. Run:ai provides a utility for that here `https://raw.githubusercontent.com/run-ai/docs/v2.13/install/backend/cp-helm-vals-diff.sh`. For information on how to use this utility please contact Run:ai customer support. | ||
| * Search for the customizations you found in the [optional configurations](./backend.md#additional-runai-configurations-optional) table and add them in the new format. | ||
|
|
||
| ## Upgrade Control Plane | ||
| ### Upgrade from version 2.13, or later | ||
| === "Connected" | ||
|
|
||
| ``` bash | ||
|
|
@@ -91,8 +79,7 @@ The Run:ai control-plane installation has been rewritten and is no longer using | |
| helm get values runai-backend -n runai-backend > runai_control_plane_values.yaml | ||
| helm upgrade runai-backend control-plane-<NEW-VERSION>.tgz -n runai-backend -f runai_control_plane_values.yaml --reset-then-reuse-values | ||
| ``` | ||
| ### Upgrade from version 2.9 | ||
|
|
||
| === "Connected" | ||
|
|
||
|
|
@@ -124,5 +111,4 @@ The Run:ai control-plane installation has been rewritten and is no longer using | |
| 1. The subdomain configured for the OpenShift cluster. | ||
|
|
||
| ## Upgrade Cluster | ||
| To upgrade the cluster follow the instructions [here](../../cluster-setup/cluster-upgrade.md). | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.