From 50e5c5e752a37f8eaff7bda7a05a989e163a8b2b Mon Sep 17 00:00:00 2001 From: Silvio Moioli Date: Thu, 24 Oct 2024 13:22:42 +0200 Subject: [PATCH 1/3] Add disconnected cluster best practices guide Signed-off-by: Silvio Moioli --- .../disconnected-clusters.md | 19 +++++++++++++++++++ .../rancher-managed-clusters.md | 4 ++++ .../disconnected-clusters.md | 19 +++++++++++++++++++ .../rancher-managed-clusters.md | 4 ++++ 4 files changed, 46 insertions(+) create mode 100644 docs/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md create mode 100644 versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md diff --git a/docs/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md b/docs/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md new file mode 100644 index 000000000000..cfc698e80f3a --- /dev/null +++ b/docs/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md @@ -0,0 +1,19 @@ +--- +title: Best Practices for Disconnected Clusters +--- + + + + + +Rancher supports managing clusters that may not always be online due to network disruptions, control plane availability, or because all cluster nodes are down. At the moment there are no known issues with disconnected clusters in the latest released Rancher version. + +While a managed cluster is disconnected from Rancher, management operations will be unavailable, and the Rancher UI will not allow navigation to the cluster. However, once the connection is reestablished, functionality is fully restored. + +### Best Practices for Managing Disconnected Clusters + +- **Cluster Availability During Rancher Upgrades**: It is recommended to have all, or at least most, managed clusters online during a Rancher upgrade. The reason is that upgrading Rancher automatically upgrades the Rancher agent software running on managed clusters. Keeping the agent and Rancher versions aligned ensures consistent functionality. Any clusters that are disconnected during the upgrade will have their agents updated as soon as they reconnect. + +- **Cleaning Up Disconnected Clusters**: Regularly remove clusters that will no longer reconnect to Rancher (e.g., clusters that have been decommissioned or destroyed). Keeping such clusters in the Rancher management system consumes unnecessary resources, which could impact Rancher's performance over time. + +- **Certificate Rotation Considerations**: When designing processes that involve regularly shutting down clusters, whether connected to Rancher or not, keep into account for certificate rotation policies. For example, RKE/RKE2/k3s clusters may rotate certificates on startup if they exceeded their lifetime. diff --git a/docs/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md b/docs/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md index 1e73af430af9..c0bdf07d88db 100644 --- a/docs/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md +++ b/docs/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md @@ -14,6 +14,10 @@ Refer to [this guide](logging-best-practices.md) for our recommendations for clu Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. Refer to this [guide](monitoring-best-practices.md) for our recommendations. +### Disconnected clusters + +Rancher supports managing clusters that may not always be online due to network disruptions, control plane availability, or because all cluster nodes are down. Refer to this [guide](disconnected-clusters.md) for our recommendations. + ### Tips for Setting Up Containers Running well-built containers can greatly impact the overall performance and security of your environment. Refer to this [guide](tips-to-set-up-containers.md) for tips. diff --git a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md new file mode 100644 index 000000000000..cfc698e80f3a --- /dev/null +++ b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md @@ -0,0 +1,19 @@ +--- +title: Best Practices for Disconnected Clusters +--- + + + + + +Rancher supports managing clusters that may not always be online due to network disruptions, control plane availability, or because all cluster nodes are down. At the moment there are no known issues with disconnected clusters in the latest released Rancher version. + +While a managed cluster is disconnected from Rancher, management operations will be unavailable, and the Rancher UI will not allow navigation to the cluster. However, once the connection is reestablished, functionality is fully restored. + +### Best Practices for Managing Disconnected Clusters + +- **Cluster Availability During Rancher Upgrades**: It is recommended to have all, or at least most, managed clusters online during a Rancher upgrade. The reason is that upgrading Rancher automatically upgrades the Rancher agent software running on managed clusters. Keeping the agent and Rancher versions aligned ensures consistent functionality. Any clusters that are disconnected during the upgrade will have their agents updated as soon as they reconnect. + +- **Cleaning Up Disconnected Clusters**: Regularly remove clusters that will no longer reconnect to Rancher (e.g., clusters that have been decommissioned or destroyed). Keeping such clusters in the Rancher management system consumes unnecessary resources, which could impact Rancher's performance over time. + +- **Certificate Rotation Considerations**: When designing processes that involve regularly shutting down clusters, whether connected to Rancher or not, keep into account for certificate rotation policies. For example, RKE/RKE2/k3s clusters may rotate certificates on startup if they exceeded their lifetime. diff --git a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md index 1e73af430af9..c0bdf07d88db 100644 --- a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md +++ b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md @@ -14,6 +14,10 @@ Refer to [this guide](logging-best-practices.md) for our recommendations for clu Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. Refer to this [guide](monitoring-best-practices.md) for our recommendations. +### Disconnected clusters + +Rancher supports managing clusters that may not always be online due to network disruptions, control plane availability, or because all cluster nodes are down. Refer to this [guide](disconnected-clusters.md) for our recommendations. + ### Tips for Setting Up Containers Running well-built containers can greatly impact the overall performance and security of your environment. Refer to this [guide](tips-to-set-up-containers.md) for tips. From 944ba6475df8d483130d0475eca3ec6f7106c108 Mon Sep 17 00:00:00 2001 From: Silvio Moioli Date: Wed, 6 Nov 2024 09:15:07 +0100 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Billy Tat --- .../rancher-managed-clusters/disconnected-clusters.md | 2 +- .../rancher-managed-clusters/disconnected-clusters.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md b/docs/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md index cfc698e80f3a..c3c9b7a732df 100644 --- a/docs/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md +++ b/docs/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md @@ -16,4 +16,4 @@ While a managed cluster is disconnected from Rancher, management operations will - **Cleaning Up Disconnected Clusters**: Regularly remove clusters that will no longer reconnect to Rancher (e.g., clusters that have been decommissioned or destroyed). Keeping such clusters in the Rancher management system consumes unnecessary resources, which could impact Rancher's performance over time. -- **Certificate Rotation Considerations**: When designing processes that involve regularly shutting down clusters, whether connected to Rancher or not, keep into account for certificate rotation policies. For example, RKE/RKE2/k3s clusters may rotate certificates on startup if they exceeded their lifetime. +- **Certificate Rotation Considerations**: When designing processes that involve regularly shutting down clusters, whether connected to Rancher or not, take into account certificate rotation policies. For example, RKE/RKE2/K3s clusters may rotate certificates on startup if they exceeded their lifetime. diff --git a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md index cfc698e80f3a..c3c9b7a732df 100644 --- a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md +++ b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters.md @@ -16,4 +16,4 @@ While a managed cluster is disconnected from Rancher, management operations will - **Cleaning Up Disconnected Clusters**: Regularly remove clusters that will no longer reconnect to Rancher (e.g., clusters that have been decommissioned or destroyed). Keeping such clusters in the Rancher management system consumes unnecessary resources, which could impact Rancher's performance over time. -- **Certificate Rotation Considerations**: When designing processes that involve regularly shutting down clusters, whether connected to Rancher or not, keep into account for certificate rotation policies. For example, RKE/RKE2/k3s clusters may rotate certificates on startup if they exceeded their lifetime. +- **Certificate Rotation Considerations**: When designing processes that involve regularly shutting down clusters, whether connected to Rancher or not, take into account certificate rotation policies. For example, RKE/RKE2/K3s clusters may rotate certificates on startup if they exceeded their lifetime. From 8c40500d9ce84b96ac98b146bcef38913195001e Mon Sep 17 00:00:00 2001 From: Silvio Moioli Date: Wed, 6 Nov 2024 09:18:51 +0100 Subject: [PATCH 3/3] add sidebar links Signed-off-by: Silvio Moioli --- sidebars.js | 3 ++- versioned_sidebars/version-2.9-sidebars.json | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/sidebars.js b/sidebars.js index b5766e2fd9a3..9cdc5eab27bd 100644 --- a/sidebars.js +++ b/sidebars.js @@ -845,7 +845,8 @@ const sidebars = { "reference-guides/best-practices/rancher-managed-clusters/logging-best-practices", "reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices", "reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers", - "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere" + "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere", + "reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters" ] } ] diff --git a/versioned_sidebars/version-2.9-sidebars.json b/versioned_sidebars/version-2.9-sidebars.json index 072459e52284..05fe81be8513 100644 --- a/versioned_sidebars/version-2.9-sidebars.json +++ b/versioned_sidebars/version-2.9-sidebars.json @@ -809,7 +809,8 @@ "reference-guides/best-practices/rancher-managed-clusters/logging-best-practices", "reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices", "reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers", - "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere" + "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere", + "reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters" ] } ]