#420 canonical links for reference guide subfolders, cli and cluster …

…config (#850) * canonicized cli-with-rancher * canonicized machine-configuration * canonicized node-template-configuration * canonicized gke-cluster-configuration * canonicized use-existing-nodes * canonicized rancher-server-configuration
rancher · Sep 18, 2023 · aa12232 · aa12232
1 parent 6dd093f
commit aa12232
Show file tree

Hide file tree

Showing 61 changed files with 244 additions and 0 deletions.
diff --git a/docs/reference-guides/cli-with-rancher/kubectl-utility.md b/docs/reference-guides/cli-with-rancher/kubectl-utility.md
@@ -2,6 +2,10 @@
 title: kubectl Utility
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cli-with-rancher/kubectl-utility"/>
+</head>
+
 ## kubectl
 
 Interact with Rancher using kubectl.

diff --git a/docs/reference-guides/cli-with-rancher/rancher-cli.md b/docs/reference-guides/cli-with-rancher/rancher-cli.md
@@ -3,6 +3,10 @@ title: Rancher CLI
 description: Interact with Rancher using command line interface (CLI) tools from your workstation.
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cli-with-rancher/rancher-cli"/>
+</head>
+
 The Rancher CLI (Command Line Interface) is a unified tool that you can use to interact with Rancher. With this tool, you can operate Rancher using a command line rather than the GUI.
 
 ### Download Rancher CLI

diff --git a/...figuration/downstream-cluster-configuration/machine-configuration/amazon-ec2.md b/...figuration/downstream-cluster-configuration/machine-configuration/amazon-ec2.md
@@ -2,6 +2,10 @@
 title: EC2 Machine Configuration Reference
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/amazon-ec2"/>
+</head>
+
 For more details about EC2 nodes, refer to the official documentation for the [EC2 Management Console](https://aws.amazon.com/ec2).
 
 ### Region

diff --git a/...r-configuration/downstream-cluster-configuration/machine-configuration/azure.md b/...r-configuration/downstream-cluster-configuration/machine-configuration/azure.md
@@ -2,6 +2,10 @@
 title: Azure Machine Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/azure"/>
+</head>
+
 For more information about Azure, refer to the official [Azure documentation.](https://docs.microsoft.com/en-us/azure/?product=featured)
 
 ### Environment

diff --git a/...guration/downstream-cluster-configuration/machine-configuration/digitalocean.md b/...guration/downstream-cluster-configuration/machine-configuration/digitalocean.md
@@ -2,6 +2,10 @@
 title: DigitalOcean Machine Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/digitalocean"/>
+</head>
+
 For more details about DigitalOcean, Droplets, refer to the [official documentation](https://docs.digitalocean.com/products/compute/).
 
 ### Region

diff --git a/...tion/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md b/...tion/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md
@@ -2,6 +2,10 @@
 title: EC2 Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2"/>
+</head>
+
 For more details about EC2, nodes, refer to the official documentation for the [EC2 Management Console](https://aws.amazon.com/ec2).
 
 ### Region

diff --git a/...iguration/downstream-cluster-configuration/node-template-configuration/azure.md b/...iguration/downstream-cluster-configuration/node-template-configuration/azure.md
@@ -2,6 +2,10 @@
 title: Azure Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure"/>
+</head>
+
 For more information about Azure, refer to the official [Azure documentation.](https://docs.microsoft.com/en-us/azure/?product=featured)
 
 Account access information is stored as a cloud credential. Cloud credentials are stored as Kubernetes secrets. Multiple node templates can use the same cloud credential. You can use an existing cloud credential or create a new one.

diff --git a/...on/downstream-cluster-configuration/node-template-configuration/digitalocean.md b/...on/downstream-cluster-configuration/node-template-configuration/digitalocean.md
@@ -2,6 +2,10 @@
 title: DigitalOcean Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean"/>
+</head>
+
 Account access information is stored as a cloud credential. Cloud credentials are stored as Kubernetes secrets. Multiple node templates can use the same cloud credential. You can use an existing cloud credential or create a new one.
 
 ### Droplet Options

diff --git a/...uration/downstream-cluster-configuration/node-template-configuration/nutanix.md b/...uration/downstream-cluster-configuration/node-template-configuration/nutanix.md
@@ -2,6 +2,10 @@
 title: Nutanix Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/nutanix"/>
+</head>
+
 ## Account Access
 
 | Parameter                    | Required | Description | Default

diff --git a/...uration/downstream-cluster-configuration/node-template-configuration/vsphere.md b/...uration/downstream-cluster-configuration/node-template-configuration/vsphere.md
@@ -2,6 +2,10 @@
 title: VSphere Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere"/>
+</head>
+
 ## Account Access
 
 | Parameter                | Required | Description |

diff --git a/...cluster-configuration/rancher-server-configuration/aks-cluster-configuration.md b/...cluster-configuration/rancher-server-configuration/aks-cluster-configuration.md
@@ -2,6 +2,10 @@
 title: AKS Cluster Configuration Reference
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/aks-cluster-configuration"/>
+</head>
+
 ## Changes in Rancher v2.6
 
 - Support for adding more than one node pool

diff --git a/...cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/...cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md
@@ -2,6 +2,10 @@
 title: EKS Cluster Configuration Reference
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration"/>
+</head>
+
 ### Account Access
 
 Complete each drop-down and field using the information obtained for your IAM policy.

diff --git a/.../rancher-server-configuration/gke-cluster-configuration/gke-private-clusters.md b/.../rancher-server-configuration/gke-cluster-configuration/gke-private-clusters.md
@@ -2,6 +2,10 @@
 title: Private Clusters
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters"/>
+</head>
+
 In GKE, [private clusters](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept) are clusters whose nodes are isolated from inbound and outbound traffic by assigning them internal IP addresses only. Private clusters in GKE have the option of exposing the control plane endpoint as a publicly accessible address or as a private address. This is different from other Kubernetes providers, which may refer to clusters with private control plane endpoints as "private clusters" but still allow traffic to and from nodes. You may want to create a cluster with private nodes, with or without a public control plane endpoint, depending on your organization's networking and security requirements. A GKE cluster provisioned from Rancher can use isolated nodes by selecting "Private Cluster" in the Cluster Options (under "Show advanced options"). The control plane endpoint can optionally be made private by selecting "Enable Private Endpoint".
 
 ### Private Nodes

diff --git a/...ence-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md b/...ence-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md
@@ -2,6 +2,10 @@
 title: Syncing
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters"/>
+</head>
+
 Syncing allows Rancher to update cluster values so that they're up to date with the corresponding cluster object hosted in AKS, EKS or GKE. This enables sources other than Rancher to own a hosted cluster’s state. 
 
 :::warning

diff --git a/...ration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md b/...ration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md
@@ -2,6 +2,10 @@
 title: Rancher Agent Options
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options"/>
+</head>
+
 Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to [create a cluster with custom nodes](../../../../pages-for-subheaders/use-existing-nodes.md) and add the options to the generated `docker run` command when adding a node.
 
 For an overview of how Rancher communicates with downstream clusters using node agents, refer to the [architecture section.](../../../rancher-manager-architecture/communicating-with-downstream-user-clusters.md#3-node-agents)

diff --git a/...ioned_docs/version-2.0-2.4/reference-guides/cli-with-rancher/kubectl-utility.md b/...ioned_docs/version-2.0-2.4/reference-guides/cli-with-rancher/kubectl-utility.md
@@ -2,6 +2,10 @@
 title: kubectl Utility
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cli-with-rancher/kubectl-utility"/>
+</head>
+
 ## kubectl
 
 Interact with Rancher using kubectl.

diff --git a/versioned_docs/version-2.0-2.4/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.0-2.4/reference-guides/cli-with-rancher/rancher-cli.md
@@ -3,6 +3,10 @@ title: Rancher CLI
 description: Interact with Rancher using command line interface (CLI) tools from your workstation.
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cli-with-rancher/rancher-cli"/>
+</head>
+
 The Rancher CLI (Command Line Interface) is a unified tool that you can use to interact with Rancher. With this tool, you can operate Rancher using a command line rather than the GUI.
 
 ### Download Rancher CLI

diff --git a/...tion/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md b/...tion/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md
@@ -2,6 +2,10 @@
 title: EC2 Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2"/>
+</head>
+
 For more details about EC2, nodes, refer to the official documentation for the [EC2 Management Console](https://aws.amazon.com/ec2).
 
 <Tabs>

diff --git a/...iguration/downstream-cluster-configuration/node-template-configuration/azure.md b/...iguration/downstream-cluster-configuration/node-template-configuration/azure.md
@@ -2,6 +2,10 @@
 title: Azure Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure"/>
+</head>
+
 For more information about Azure, refer to the official [Azure documentation.](https://docs.microsoft.com/en-us/azure/?product=featured)
 
 <Tabs>

diff --git a/...on/downstream-cluster-configuration/node-template-configuration/digitalocean.md b/...on/downstream-cluster-configuration/node-template-configuration/digitalocean.md
@@ -2,6 +2,10 @@
 title: DigitalOcean Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean"/>
+</head>
+
 <Tabs>
 <TabItem value="Rancher v2.2.0+">
 

diff --git a/...ration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md b/...ration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md
@@ -2,6 +2,10 @@
 title: Rancher Agent Options
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options"/>
+</head>
+
 Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to [create a cluster with custom nodes](../../../../pages-for-subheaders/use-existing-nodes.md) and add the options to the generated `docker run` command when adding a node.
 
 For an overview of how Rancher communicates with downstream clusters using node agents, refer to the [architecture section.](../../../rancher-manager-architecture/communicating-with-downstream-user-clusters.md#3-node-agents)

diff --git a/versioned_docs/version-2.5/reference-guides/cli-with-rancher/kubectl-utility.md b/versioned_docs/version-2.5/reference-guides/cli-with-rancher/kubectl-utility.md
@@ -2,6 +2,10 @@
 title: kubectl Utility
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cli-with-rancher/kubectl-utility"/>
+</head>
+
 ## kubectl
 
 Interact with Rancher using kubectl.

diff --git a/versioned_docs/version-2.5/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.5/reference-guides/cli-with-rancher/rancher-cli.md
@@ -3,6 +3,10 @@ title: Rancher CLI
 description: Interact with Rancher using command line interface (CLI) tools from your workstation.
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cli-with-rancher/rancher-cli"/>
+</head>
+
 The Rancher CLI (Command Line Interface) is a unified tool that you can use to interact with Rancher. With this tool, you can operate Rancher using a command line rather than the GUI.
 
 ### Download Rancher CLI

diff --git a/...tion/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md b/...tion/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md
@@ -2,6 +2,10 @@
 title: EC2 Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2"/>
+</head>
+
 For more details about EC2, nodes, refer to the official documentation for the [EC2 Management Console](https://aws.amazon.com/ec2).
 ### Region
 

diff --git a/...iguration/downstream-cluster-configuration/node-template-configuration/azure.md b/...iguration/downstream-cluster-configuration/node-template-configuration/azure.md
@@ -2,6 +2,10 @@
 title: Azure Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure"/>
+</head>
+
 For more information about Azure, refer to the official [Azure documentation.](https://docs.microsoft.com/en-us/azure/?product=featured)
 
 Account access information is stored as a cloud credential. Cloud credentials are stored as Kubernetes secrets. Multiple node templates can use the same cloud credential. You can use an existing cloud credential or create a new one.

diff --git a/...on/downstream-cluster-configuration/node-template-configuration/digitalocean.md b/...on/downstream-cluster-configuration/node-template-configuration/digitalocean.md
@@ -2,6 +2,10 @@
 title: DigitalOcean Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean"/>
+</head>
+
 Account access information is stored as a cloud credential. Cloud credentials are stored as Kubernetes secrets. Multiple node templates can use the same cloud credential. You can use an existing cloud credential or create a new one.
 
 ### Droplet Options

diff --git a/...uration/downstream-cluster-configuration/node-template-configuration/vsphere.md b/...uration/downstream-cluster-configuration/node-template-configuration/vsphere.md
@@ -2,6 +2,10 @@
 title: VSphere Node Template Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere"/>
+</head>
+
 The following node template configuration reference applies to Rancher v2.3.3+.
 
 

diff --git a/...cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/...cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md
@@ -2,6 +2,10 @@
 title: EKS Cluster Configuration Reference
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration"/>
+</head>
+
 <Tabs>
 <TabItem value="Rancher v2.5.6+">
 

diff --git a/.../rancher-server-configuration/gke-cluster-configuration/gke-private-clusters.md b/.../rancher-server-configuration/gke-cluster-configuration/gke-private-clusters.md
@@ -2,6 +2,10 @@
 title: Private Clusters
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters"/>
+</head>
+
 _Available as of v2.5.8_
 
 In GKE, [private clusters](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept) are clusters whose nodes are isolated from inbound and outbound traffic by assigning them internal IP addresses only. Private clusters in GKE have the option of exposing the control plane endpoint as a publicly accessible address or as a private address. This is different from other Kubernetes providers, which may refer to clusters with private control plane endpoints as "private clusters" but still allow traffic to and from nodes. You may want to create a cluster with private nodes, with or without a public control plane endpoint, depending on your organization's networking and security requirements. A GKE cluster provisioned from Rancher can use isolated nodes by selecting "Private Cluster" in the Cluster Options (under "Show advanced options"). The control plane endpoint can optionally be made private by selecting "Enable Private Endpoint".

diff --git a/...ence-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md b/...ence-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md
@@ -2,6 +2,10 @@
 title: Syncing
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters"/>
+</head>
+
 Syncing is the feature for EKS and GKE clusters that causes Rancher to update the clusters' values so they are up to date with their corresponding cluster object in the hosted Kubernetes provider. This enables Rancher to not be the sole owner of a hosted cluster’s state. Its largest limitation is that processing an update from Rancher and another source at the same time or within 5 minutes of one finishing may cause the state from one source to completely overwrite the other.
 
 ### How it works

diff --git a/...ration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md b/...ration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md
@@ -2,6 +2,10 @@
 title: Rancher Agent Options
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options"/>
+</head>
+
 Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to [create a cluster with custom nodes](../../../../pages-for-subheaders/use-existing-nodes.md) and add the options to the generated `docker run` command when adding a node.
 
 For an overview of how Rancher communicates with downstream clusters using node agents, refer to the [architecture section.](../../../rancher-manager-architecture/communicating-with-downstream-user-clusters.md#3-node-agents)

diff --git a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/kubectl-utility.md b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/kubectl-utility.md
@@ -2,6 +2,10 @@
 title: kubectl Utility
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cli-with-rancher/kubectl-utility"/>
+</head>
+
 ## kubectl
 
 Interact with Rancher using kubectl.

diff --git a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md
@@ -3,6 +3,10 @@ title: Rancher CLI
 description: Interact with Rancher using command line interface (CLI) tools from your workstation.
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cli-with-rancher/rancher-cli"/>
+</head>
+
 The Rancher CLI (Command Line Interface) is a unified tool that you can use to interact with Rancher. With this tool, you can operate Rancher using a command line rather than the GUI.
 
 ### Download Rancher CLI

diff --git a/...figuration/downstream-cluster-configuration/machine-configuration/amazon-ec2.md b/...figuration/downstream-cluster-configuration/machine-configuration/amazon-ec2.md
@@ -2,6 +2,10 @@
 title: EC2 Machine Configuration Reference
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/amazon-ec2"/>
+</head>
+
 For more details about EC2 nodes, refer to the official documentation for the [EC2 Management Console](https://aws.amazon.com/ec2).
 
 ### Region

diff --git a/...r-configuration/downstream-cluster-configuration/machine-configuration/azure.md b/...r-configuration/downstream-cluster-configuration/machine-configuration/azure.md
@@ -2,6 +2,10 @@
 title: Azure Machine Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/azure"/>
+</head>
+
 For more information about Azure, refer to the official [Azure documentation.](https://docs.microsoft.com/en-us/azure/?product=featured)
 
 ### Environment

diff --git a/...guration/downstream-cluster-configuration/machine-configuration/digitalocean.md b/...guration/downstream-cluster-configuration/machine-configuration/digitalocean.md
@@ -2,6 +2,10 @@
 title: DigitalOcean Machine Configuration
 ---
 
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com//reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/digitalocean"/>
+</head>
+
 For more details about DigitalOcean, Droplets, refer to the [official documentation](https://docs.digitalocean.com/products/compute/).
 
 ### Region