Skip to content

Commit 15f0b81

Browse files
Amendments to Cluster provisioning and registering documentation
1 parent b7b2a99 commit 15f0b81

File tree

2 files changed

+39
-7
lines changed

2 files changed

+39
-7
lines changed

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-

suggesting-an-improvement.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Suggesting an improvement
2+
3+
If you notice an issue with Kubewarden documentation or want to suggest new content, then open an issue. You only require access to a [GitHub account](https://github.com/join) and a browser.
4+
5+
In most cases, any new documentation work for Kubewarden begins with an issue in GitHub. The [documentation team for Kubewarden](https://github.com/orgs/kubewarden/teams/kubewarden-documentation) reviews, categorizes and tags them as appropriate. Everybody is welcome to work on the issue, including the reporter, but we request that you assign it to yourself before commencing any work to avoid duplicate efforts.
6+
7+
## Opening an issue
8+
9+
If you want to suggest improvements to existing documentation content or notice an error, then open an issue.
10+
11+
- Click the GitHub Octocat icon on the top. This redirects you to the [documentation repository for Kubewarden](https://github.com/kubewarden/docs).
12+
- Navigate to the Issues tab and click **New issue**.
13+
- Describe the issue or suggestion for improvement. The more details you provide, the better!
14+
- Click Submit new issue.
15+
- Post submitting, you can either assign it to yourself or wait for a community member to pick it up. Members of the documentation team and from the community might request clarifications before they can take action on your issue, so we'd request you to actively check your issue or [turn on GitHub notifications](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications).
16+
17+
## New content suggestions
18+
19+
If you want to suggest new content, please file an issue following the steps above. Either
20+
21+
- You can choose an existing page in the section you think the content belongs in and click Create an issue.
22+
OR
23+
- Navigate to [GitHub](https://github.com/kubewarden/docs/issues/new/choose) and file the issue directly.
24+
25+
## How do I make my contribution count?
26+
27+
No contribution is big or small! However, to ensure that the community derives maximum value we'd request you to follow the below when reporting an issue:
28+
29+
- Focus on providing a clear description of the issue. Some key points to consider would be specifically describing what is missing, outdated, erroneous, or requires qualitative/technical improvement.
30+
- Detailing the specific impact the issue has on users.
31+
- Delimiting the scope of the issue. If the scope is larger, we'd request you to break it down to smaller tasks within an issue. For example, "Creating a Contribution guide" is very widely scoped since there would be multiple tasks associated with the issue. However, "Fixing grammatical error on the Quickstart page" is a more narrowly scoped issue that would, potentially, require only a single pull request.
32+
- Crosscheck existing issues to avoid duplicate work.
33+
- There is a fair chance that you're opening an issue with reference to another pull request or existing issue. Ensure you reference it in the issue you're opening to provide context for contributors who may want to work on it.

0 commit comments

Comments
 (0)