#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
2026-09-25 20:48:11 +00:00 · 2023-09-18 11:41:09 -04:00
parent 6dd093f6c5
commit aa1223263d
61 changed files with 244 additions and 0 deletions
@@ -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.
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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

@@ -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.
@@ -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
@@ -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
@@ -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 |
@@ -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
@@ -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.
@@ -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
@@ -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
@@ -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)