Merge pull request #1521 from moio/disconnected_best_practice

btat · web-flow · commit f748b8a60d38 · 2024-11-06T14:46:03.000-08:00
Add disconnected cluster best practices guide
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
@@ -0,0 +1,19 @@
+---
+title: Best Practices for Disconnected Clusters
+---
+
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/best-practices/disconnected-clusters"/>
+</head>
+
+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, 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/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/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_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
@@ -0,0 +1,19 @@
+---
+title: Best Practices for Disconnected Clusters
+---
+
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/best-practices/disconnected-clusters"/>
+</head>
+
+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, 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/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.
diff --git 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"
               ]
             }
           ]

Original file line number	Diff line number	Diff line change
`@@ -845,7 +845,8 @@ const sidebars = {`
`845`	`845`	`"reference-guides/best-practices/rancher-managed-clusters/logging-best-practices",`
`846`	`846`	`"reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices",`
`847`	`847`	`"reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers",`
`848`		`- "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere"`
	`848`	`+ "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere",`
	`849`	`+ "reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters"`
`849`	`850`	`]`
`850`	`851`	`}`
`851`	`852`	`]`
Original file line number	Diff line number	Diff line change
`@@ -809,7 +809,8 @@`
`809`	`809`	`"reference-guides/best-practices/rancher-managed-clusters/logging-best-practices",`
`810`	`810`	`"reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices",`
`811`	`811`	`"reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers",`
`812`		`- "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere"`
	`812`	`+ "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere",`
	`813`	`+ "reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters"`
`813`	`814`	`]`
`814`	`815`	`}`
`815`	`816`	`]`