#420 canonical links for reference guide best practices (#849)

* canonicized rancher-managed-clusters * canonicized rancher-server
rancher · Sep 18, 2023 · 6dd093f · 6dd093f
1 parent e4326fe
commit 6dd093f
Show file tree

Hide file tree

Showing 30 changed files with 120 additions and 0 deletions.
diff --git a/...erence-guides/best-practices/rancher-managed-clusters/logging-best-practices.md b/...erence-guides/best-practices/rancher-managed-clusters/logging-best-practices.md
@@ -2,6 +2,10 @@
 title: Logging Best Practices
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/logging-best-practices"/>
+</head>
+
 In this guide, we recommend best practices for cluster-level logging and application logging.
 
 - [Cluster-level Logging](#cluster-level-logging)

diff --git a/...nce-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md b/...nce-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md
@@ -2,6 +2,10 @@
 title: Monitoring Best Practices
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices"/>
+</head>
+
 Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. This is not different when using Kubernetes and Rancher. Fortunately the integrated monitoring and alerting functionality makes this whole process a lot easier.
 
 The [Rancher monitoring documentation](../../../pages-for-subheaders/monitoring-and-alerting.md) describes how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this.

diff --git a/.../best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md b/.../best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md
@@ -2,6 +2,10 @@
 title: Best Practices for Rancher Managed vSphere Clusters
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere"/>
+</head>
+
 This guide outlines a reference architecture for provisioning downstream Rancher clusters in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.
 
 - [1. VM Considerations](#1-vm-considerations)

diff --git a/...nce-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md b/...nce-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md
@@ -2,6 +2,10 @@
 title: Tips for Setting Up Containers
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers"/>
+</head>
+
 Running well-built containers can greatly impact the overall performance and security of your environment.
 
 Below are a few tips for setting up your containers.

diff --git a/...eference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md b/...eference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md
@@ -2,6 +2,10 @@
 title: Installing Rancher in a vSphere Environment
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere"/>
+</head>
+
 This guide outlines a reference architecture for installing Rancher on an RKE Kubernetes cluster in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.
 
 

diff --git a/docs/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md b/docs/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md
@@ -2,6 +2,10 @@
 title: Rancher Deployment Strategy
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/rancher-deployment-strategy"/>
+</head>
+
 There are two recommended deployment strategies for a Rancher instance that manages downstream Kubernetes clusters. Each one has its own pros and cons. Read more about which one would fit best for your use case.
 
 ## Hub & Spoke Strategy

diff --git a/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md
@@ -2,6 +2,10 @@
 title: Tips for Running Rancher
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/tips-for-running-rancher"/>
+</head>
+
 This guide is geared toward use cases where Rancher is used to manage downstream Kubernetes clusters. The high-availability setup is intended to prevent losing access to downstream clusters if the Rancher server is not available.
 
 A high-availability Kubernetes installation, defined as an installation of Rancher on a Kubernetes cluster with at least three nodes, should be used in any production installation of Rancher, as well as any installation deemed "important." Multiple Rancher instances running on multiple nodes ensure high availability that cannot be accomplished with a single node environment.

diff --git a/docs/reference-guides/best-practices/rancher-server/tips-for-scaling-rancher.md b/docs/reference-guides/best-practices/rancher-server/tips-for-scaling-rancher.md
@@ -2,6 +2,10 @@
 title: Tips for Scaling Rancher
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/tips-for-scaling-rancher"/>
+</head>
+
 This guide aims to introduce the approaches that should be considered to scale Rancher setups, and associated challenges with doing so. As systems grow performance will naturally reduce, but there are steps we can take to minimize the load put on Rancher, as well as optimize Rancher's ability to handle these larger setups.
 
 ## General Tips on Optimizing Rancher's Performance

diff --git a/...erence-guides/best-practices/rancher-managed-clusters/logging-best-practices.md b/...erence-guides/best-practices/rancher-managed-clusters/logging-best-practices.md
@@ -2,6 +2,10 @@
 title: Logging Best Practices
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/logging-best-practices"/>
+</head>
+
 In this guide, we recommend best practices for cluster-level logging and application logging.
 
 - [Changes in Logging in Rancher v2.5](#changes-in-logging-in-rancher-v2-5)

diff --git a/...nce-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md b/...nce-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md
@@ -2,6 +2,10 @@
 title: Monitoring Best Practices
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices"/>
+</head>
+
 Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. This is not different when using Kubernetes and Rancher. Fortunately the integrated monitoring and alerting functionality makes this whole process a lot easier.
 
 The [Rancher monitoring documentation](../../../pages-for-subheaders/monitoring-and-alerting.md) describes how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this.

diff --git a/.../best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md b/.../best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md
@@ -2,6 +2,10 @@
 title: Best Practices for Rancher Managed vSphere Clusters
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere"/>
+</head>
+
 This guide outlines a reference architecture for provisioning downstream Rancher clusters in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.
 
 - [1. VM Considerations](#1-vm-considerations)

diff --git a/...nce-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md b/...nce-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md
@@ -2,6 +2,10 @@
 title: Tips for Setting Up Containers
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers"/>
+</head>
+
 Running well-built containers can greatly impact the overall performance and security of your environment.
 
 Below are a few tips for setting up your containers.

diff --git a/...eference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md b/...eference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md
@@ -2,6 +2,10 @@
 title: Installing Rancher in a vSphere Environment
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere"/>
+</head>
+
 This guide outlines a reference architecture for installing Rancher on an RKE Kubernetes cluster in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.
 
 

diff --git a/...5/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md b/...5/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md
@@ -2,6 +2,10 @@
 title: Rancher Deployment Strategy
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/rancher-deployment-strategy"/>
+</head>
+
 There are two recommended deployment strategies for a Rancher server that manages downstream Kubernetes clusters. Each one has its own pros and cons. Read more about which one would fit best for your use case.
 
 ## Hub & Spoke Strategy

diff --git a/...-2.5/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/...-2.5/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md
@@ -2,6 +2,10 @@
 title: Tips for Running Rancher
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/tips-for-running-rancher"/>
+</head>
+
 This guide is geared toward use cases where Rancher is used to manage downstream Kubernetes clusters. The high-availability setup is intended to prevent losing access to downstream clusters if the Rancher server is not available.
 
 A high-availability Kubernetes installation, defined as an installation of Rancher on a Kubernetes cluster with at least three nodes, should be used in any production installation of Rancher, as well as any installation deemed "important." Multiple Rancher instances running on multiple nodes ensure high availability that cannot be accomplished with a single node environment.

diff --git a/...erence-guides/best-practices/rancher-managed-clusters/logging-best-practices.md b/...erence-guides/best-practices/rancher-managed-clusters/logging-best-practices.md
@@ -2,6 +2,10 @@
 title: Logging Best Practices
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/logging-best-practices"/>
+</head>
+
 In this guide, we recommend best practices for cluster-level logging and application logging.
 
 - [Cluster-level Logging](#cluster-level-logging)

diff --git a/...nce-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md b/...nce-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md
@@ -2,6 +2,10 @@
 title: Monitoring Best Practices
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices"/>
+</head>
+
 Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. This is not different when using Kubernetes and Rancher. Fortunately the integrated monitoring and alerting functionality makes this whole process a lot easier.
 
 The [Rancher monitoring documentation](../../../pages-for-subheaders/monitoring-and-alerting.md) describes how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this.

diff --git a/.../best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md b/.../best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md
@@ -2,6 +2,10 @@
 title: Best Practices for Rancher Managed vSphere Clusters
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere"/>
+</head>
+
 This guide outlines a reference architecture for provisioning downstream Rancher clusters in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.
 
 - [1. VM Considerations](#1-vm-considerations)

diff --git a/...nce-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md b/...nce-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md
@@ -2,6 +2,10 @@
 title: Tips for Setting Up Containers
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers"/>
+</head>
+
 Running well-built containers can greatly impact the overall performance and security of your environment.
 
 Below are a few tips for setting up your containers.

diff --git a/...eference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md b/...eference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md
@@ -2,6 +2,10 @@
 title: Installing Rancher in a vSphere Environment
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere"/>
+</head>
+
 This guide outlines a reference architecture for installing Rancher on an RKE Kubernetes cluster in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.
 
 

diff --git a/...6/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md b/...6/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md
@@ -2,6 +2,10 @@
 title: Rancher Deployment Strategy
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/rancher-deployment-strategy"/>
+</head>
+
 There are two recommended deployment strategies for a Rancher instance that manages downstream Kubernetes clusters. Each one has its own pros and cons. Read more about which one would fit best for your use case.
 
 ## Hub & Spoke Strategy

diff --git a/...-2.6/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/...-2.6/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md
@@ -2,6 +2,10 @@
 title: Tips for Running Rancher
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/tips-for-running-rancher"/>
+</head>
+
 This guide is geared toward use cases where Rancher is used to manage downstream Kubernetes clusters. The high-availability setup is intended to prevent losing access to downstream clusters if the Rancher server is not available.
 
 A high-availability Kubernetes installation, defined as an installation of Rancher on a Kubernetes cluster with at least three nodes, should be used in any production installation of Rancher, as well as any installation deemed "important." Multiple Rancher instances running on multiple nodes ensure high availability that cannot be accomplished with a single node environment.

diff --git a/...erence-guides/best-practices/rancher-managed-clusters/logging-best-practices.md b/...erence-guides/best-practices/rancher-managed-clusters/logging-best-practices.md
@@ -2,6 +2,10 @@
 title: Logging Best Practices
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/logging-best-practices"/>
+</head>
+
 In this guide, we recommend best practices for cluster-level logging and application logging.
 
 - [Cluster-level Logging](#cluster-level-logging)

diff --git a/...nce-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md b/...nce-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md
@@ -2,6 +2,10 @@
 title: Monitoring Best Practices
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices"/>
+</head>
+
 Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. This is not different when using Kubernetes and Rancher. Fortunately the integrated monitoring and alerting functionality makes this whole process a lot easier.
 
 The [Rancher monitoring documentation](../../../pages-for-subheaders/monitoring-and-alerting.md) describes how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this.

diff --git a/.../best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md b/.../best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md
@@ -2,6 +2,10 @@
 title: Best Practices for Rancher Managed vSphere Clusters
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere"/>
+</head>
+
 This guide outlines a reference architecture for provisioning downstream Rancher clusters in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.
 
 - [1. VM Considerations](#1-vm-considerations)

diff --git a/...nce-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md b/...nce-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md
@@ -2,6 +2,10 @@
 title: Tips for Setting Up Containers
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers"/>
+</head>
+
 Running well-built containers can greatly impact the overall performance and security of your environment.
 
 Below are a few tips for setting up your containers.

diff --git a/...eference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md b/...eference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md
@@ -2,6 +2,10 @@
 title: Installing Rancher in a vSphere Environment
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere"/>
+</head>
+
 This guide outlines a reference architecture for installing Rancher on an RKE Kubernetes cluster in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.
 
 

diff --git a/...7/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md b/...7/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md
@@ -2,6 +2,10 @@
 title: Rancher Deployment Strategy
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/rancher-deployment-strategy"/>
+</head>
+
 There are two recommended deployment strategies for a Rancher instance that manages downstream Kubernetes clusters. Each one has its own pros and cons. Read more about which one would fit best for your use case.
 
 ## Hub & Spoke Strategy

diff --git a/...-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/...-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md
@@ -2,6 +2,10 @@
 title: Tips for Running Rancher
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/tips-for-running-rancher"/>
+</head>
+
 This guide is geared toward use cases where Rancher is used to manage downstream Kubernetes clusters. The high-availability setup is intended to prevent losing access to downstream clusters if the Rancher server is not available.
 
 A high-availability Kubernetes installation, defined as an installation of Rancher on a Kubernetes cluster with at least three nodes, should be used in any production installation of Rancher, as well as any installation deemed "important." Multiple Rancher instances running on multiple nodes ensure high availability that cannot be accomplished with a single node environment.

diff --git a/...-2.7/reference-guides/best-practices/rancher-server/tips-for-scaling-rancher.md b/...-2.7/reference-guides/best-practices/rancher-server/tips-for-scaling-rancher.md
@@ -2,6 +2,10 @@
 title: Tips for Scaling Rancher
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/best-practices/rancher-server/tips-for-scaling-rancher"/>
+</head>
+
 This guide aims to introduce the approaches that should be considered to scale Rancher setups, and associated challenges with doing so. As systems grow performance will naturally reduce, but there are steps we can take to minimize the load put on Rancher, as well as optimize Rancher's ability to handle these larger setups.
 
 ## General Tips on Optimizing Rancher's Performance