[v2.12] Add Documentation for RKE1 Cluster Cleanup #1879
Conversation
krunalhinguu
requested review from
btat,
LucasSaintarbor,
pmkovar and
sunilarjun
as code owners
vardhaman22
changed the title
| - This allows Rancher to clean up associated resources and finalizers. | ||
| ``` | ||
| #!/bin/bash |
There was a problem hiding this comment.
@krunalhinguu could you link directly to https://github.com/rancher/rancher/blob/v2.12.0/chart/scripts/pre-upgrade-hook.sh (it'll be available after v2.12.0 is tagged or https://github.com/rancher/rancher/blob/main/chart/scripts/pre-upgrade-hook.sh temporarily for QA) so we don't have to maintain the script in multiple places?
There was a problem hiding this comment.
Good idea. Debating whether we want to pin it to v2.12.0 tag or have it point to main branch so in case we fix/improve the script it will be "automagically" updated in docs. The counter-argument is if we go with main link then potentially untested changes will be live immediately.
Leaning towards the latter just to be safe and we can bump to a newer tag in docs as needed.
…nup script for RKE1 resources
There was a problem hiding this comment.
Hello @krunalhinguu thank you for the updates, I've left some comments adding suggested rephrasing and some syntax updates. Could you please also apply these changes to the v2.9, v2.10, (updating this comment wrt to below clarification) and v2.11 upgrade-docker-installed-rancher.md pages as the content will be relevant for these users who upgrade to v2.12 as well. I've left out v2.8 as this documentation will be archived soon. Please let me know if you need help with porting the content to versions v2.9-v2.11 or if you need any clarification, thanks again!
...nstallation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md
Outdated
Show resolved
Hide resolved
...nstallation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md
Outdated
Show resolved
Hide resolved
...nstallation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md
Outdated
Show resolved
Hide resolved
...nstallation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md
Outdated
Show resolved
Hide resolved
...nstallation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md
Outdated
Show resolved
Hide resolved
...nstallation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md
Outdated
Show resolved
Hide resolved
|
Thanks @sunilarjun for the suggestion and improvements. I have update the documentation as per the instructions. I have also updated the doc for 2.9,2.10 & 2.11 as well. Please let me know if any additional changes are needed |
| - **Manually delete** the resources listed in the upgrade error message (e.g., RKE1 clusters, NodeTemplates, ClusterTemplates). | ||
| - If deletion is blocked due to **finalizers**, edit the resources and remove the `metadata.finalizers` field. | ||
| - If a **validating webhook** prevents deletion (e.g., for the `system-project`), please refer to the [Bypassing the Webhook](../../../../reference-guides/rancher-webhook.md#bypassing-the-webhook) |
There was a problem hiding this comment.
| - If a **validating webhook** prevents deletion (e.g., for the `system-project`), please refer to the [Bypassing the Webhook](../../../../reference-guides/rancher-webhook.md#bypassing-the-webhook) | |
| - If a **validating webhook** prevents deletion (e.g., for the `system-project`), please refer to the [Bypassing the Webhook](../../../../reference-guides/rancher-webhook.md#bypassing-the-webhook) documentation. |
| - **Manually delete** the resources listed in the upgrade error message (e.g., RKE1 clusters, NodeTemplates, ClusterTemplates). | ||
| - If deletion is blocked due to **finalizers**, edit the resources and remove the `metadata.finalizers` field. | ||
| - If a **validating webhook** prevents deletion (e.g., for the `system-project`), please refer to the [Bypassing the Webhook](../../../../reference-guides/rancher-webhook.md#bypassing-the-webhook) |
There was a problem hiding this comment.
| - If a **validating webhook** prevents deletion (e.g., for the `system-project`), please refer to the [Bypassing the Webhook](../../../../reference-guides/rancher-webhook.md#bypassing-the-webhook) | |
| - If a **validating webhook** prevents deletion (e.g., for the `system-project`), please refer to the [Bypassing the Webhook](../../../../reference-guides/rancher-webhook.md#bypassing-the-webhook) documentation. |
| - **Manually delete** the resources listed in the upgrade error message (e.g., RKE1 clusters, NodeTemplates, ClusterTemplates). | ||
| - If deletion is blocked due to **finalizers**, edit the resources and remove the `metadata.finalizers` field. | ||
| - If a **validating webhook** prevents deletion (e.g., for the `system-project`), please refer to the [Bypassing the Webhook](../../../../reference-guides/rancher-webhook.md#bypassing-the-webhook) |
There was a problem hiding this comment.
| - If a **validating webhook** prevents deletion (e.g., for the `system-project`), please refer to the [Bypassing the Webhook](../../../../reference-guides/rancher-webhook.md#bypassing-the-webhook) | |
| - If a **validating webhook** prevents deletion (e.g., for the `system-project`), please refer to the [Bypassing the Webhook](../../../../reference-guides/rancher-webhook.md#bypassing-the-webhook) documentation. |
Since we recommend not skipping minor versions during upgrades I don't think this should be included in v2.9 and v2.10. |
Issue
Description
rancher v2.12 upgrade documentation to explain the validation behavior that blocks upgrades when RKE1-related resources are present, and to guide users through manual recovery if an upgrade fails.