Skip to content

Commit 929adc3

Browse files
Amendments to Cluster provisioning and registering documentation
A#dding change to the registereing cluster docs
1 parent b7b2a99 commit 929adc3

File tree

2 files changed

+9
-11
lines changed
  • content/rancher
    • v2.5/en/cluster-provisioning/registered-clusters
    • v2.6/en/cluster-provisioning/registered-clusters

2 files changed

+9
-11
lines changed

content/rancher/v2.5/en/cluster-provisioning/registered-clusters/_index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases:
77
- /rancher/v2.x/en/cluster-provisioning/registered-clusters/
88
---
99

10-
The cluster registration feature replaced the feature to import clusters.
10+
Along with importing clusters, as of v2.5, Rancher allows you to tie in closer with cloud APIs and manage your cluster by registering existing clusters.
1111

1212
The control that Rancher has to manage a registered cluster depends on the type of cluster. For details, see [Management Capabilities for Registered Clusters.](#management-capabilities-for-registered-clusters)
1313

@@ -121,7 +121,7 @@ $ curl -sfL https://get.k3s.io | K3S_KUBECONFIG_MODE="644" sh -s -
121121

122122
### Configuring an Imported EKS Cluster with Terraform
123123

124-
You should define **only** the minimum fields that Rancher requires when importing an EKS cluster with Terraform. This is important as Rancher will overwrite what was in the EKS cluster with any config that the user has provided.
124+
You should define **only** the minimum fields that Rancher requires when importing an EKS cluster with Terraform. This is important as Rancher will overwrite what was in the EKS cluster with any config that the user has provided.
125125

126126
>**Warning:** Even a small difference between the current EKS cluster and a user-provided config could have unexpected results.
127127
@@ -256,7 +256,7 @@ Also in the K3s documentation, nodes with the worker role are called agent nodes
256256

257257
# Debug Logging and Troubleshooting for Registered K3s Clusters
258258

259-
Nodes are upgraded by the system upgrade controller running in the downstream cluster. Based on the cluster configuration, Rancher deploys two [plans](https://github.com/rancher/system-upgrade-controller#example-upgrade-plan) to upgrade K3s nodes: one for controlplane nodes and one for workers. The system upgrade controller follows the plans and upgrades the nodes.
259+
Nodes are upgraded by the system upgrade controller running in the downstream cluster. Based on the cluster configuration, Rancher deploys two [plans](https://github.com/rancher/system-upgrade-controller#example-upgrade-plan) to upgrade K3s nodes: one for controlplane nodes and one for workers. The system upgrade controller follows the plans and upgrades the nodes.
260260

261261
To enable debug logging on the system upgrade controller deployment, edit the [configmap](https://github.com/rancher/system-upgrade-controller/blob/50a4c8975543d75f1d76a8290001d87dc298bdb4/manifests/system-upgrade-controller.yaml#L32) to set the debug environment variable to true. Then restart the `system-upgrade-controller` pod.
262262

@@ -326,4 +326,3 @@ To annotate a registered cluster,
326326
1. Click **Save.**
327327

328328
**Result:** The annotation does not give the capabilities to the cluster, but it does indicate to Rancher that the cluster has those capabilities.
329-

content/rancher/v2.6/en/cluster-provisioning/registered-clusters/_index.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Registering Existing Clusters
33
weight: 6
44
---
55

6-
The cluster registration feature replaced the feature to import clusters.
6+
Along with importing clusters, as of v2.5, Rancher allows you to tie in closer with cloud APIs and manage your cluster by registering existing clusters.
77

88
The control that Rancher has to manage a registered cluster depends on the type of cluster. For details, see [Management Capabilities for Registered Clusters.](#management-capabilities-for-registered-clusters)
99

@@ -168,7 +168,7 @@ Also in the K3s documentation, nodes with the worker role are called agent nodes
168168

169169
# Debug Logging and Troubleshooting for Registered K3s Clusters
170170

171-
Nodes are upgraded by the system upgrade controller running in the downstream cluster. Based on the cluster configuration, Rancher deploys two [plans](https://github.com/rancher/system-upgrade-controller#example-upgrade-plan) to upgrade K3s nodes: one for controlplane nodes and one for workers. The system upgrade controller follows the plans and upgrades the nodes.
171+
Nodes are upgraded by the system upgrade controller running in the downstream cluster. Based on the cluster configuration, Rancher deploys two [plans](https://github.com/rancher/system-upgrade-controller#example-upgrade-plan) to upgrade K3s nodes: one for controlplane nodes and one for workers. The system upgrade controller follows the plans and upgrades the nodes.
172172

173173
To enable debug logging on the system upgrade controller deployment, edit the [configmap](https://github.com/rancher/system-upgrade-controller/blob/50a4c8975543d75f1d76a8290001d87dc298bdb4/manifests/system-upgrade-controller.yaml#L32) to set the debug environment variable to true. Then restart the `system-upgrade-controller` pod.
174174

@@ -196,7 +196,7 @@ Authorized Cluster Endpoint (ACE) support has been added for registered RKE2 and
196196

197197
> **Note:**
198198
>
199-
> - These steps only need to be performed on the control plane nodes of the downstream cluster. You must configure each control plane node individually.
199+
> - These steps only need to be performed on the control plane nodes of the downstream cluster. You must configure each control plane node individually.
200200
>
201201
> - The following steps will work on both RKE2 and K3s clusters registered in v2.6.x as well as those registered (or imported) from a previous version of Rancher with an upgrade to v2.6.x.
202202
>
@@ -223,19 +223,19 @@ Authorized Cluster Endpoint (ACE) support has been added for registered RKE2 and
223223
context:
224224
user: Default
225225
cluster: Default
226-
226+
227227
1. Add the following to the config file (or create one if it doesn’t exist); note that the default location is `/etc/rancher/{rke2,k3s}/config.yaml`:
228228

229229
kube-apiserver-arg:
230230
- authentication-token-webhook-config-file=/var/lib/rancher/{rke2,k3s}/kube-api-authn-webhook.yaml
231-
231+
232232
1. Run the following commands:
233233

234234
sudo systemctl stop {rke2,k3s}-server
235235
sudo systemctl start {rke2,k3s}-server
236236

237237
1. Finally, you **must** go back to the Rancher UI and edit the imported cluster there to complete the ACE enablement. Click on **⋮ > Edit Config**, then click the **Networking** tab under Cluster Configuration. Finally, click the **Enabled** button for **Authorized Endpoint**. Once the ACE is enabled, you then have the option of entering a fully qualified domain name (FQDN) and certificate information.
238-
238+
239239
>**Note:** The <b>FQDN</b> field is optional, and if one is entered, it should point to the downstream cluster. Certificate information is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the <b>CA Certificates</b> field.
240240
241241
# Annotating Registered Clusters
@@ -286,4 +286,3 @@ To annotate a registered cluster,
286286
1. Click **Save**.
287287

288288
**Result:** The annotation does not give the capabilities to the cluster, but it does indicate to Rancher that the cluster has those capabilities.
289-

0 commit comments

Comments
 (0)