Add dedicated Rancher Cluster Registration page#158
Open
anmazzotti wants to merge 1 commit intorancher:mainfrom
Open
Add dedicated Rancher Cluster Registration page#158anmazzotti wants to merge 1 commit intorancher:mainfrom
anmazzotti wants to merge 1 commit intorancher:mainfrom
Conversation
Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
✅ Deploy Preview for susecapi ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
anmazzotti
added
documentation
sunilarjun
requested changes
Mar 6, 2026
Collaborator
sunilarjun
left a comment
sunilarjun
left a comment
There was a problem hiding this comment.
Thank you for the update @anmazzotti, left some review comments with minor grammar edits and some syntax edits for code blocks, admonitions, and numbered lists. Please let me know if you have any questions.
| ====== | ||
|
|
||
| == Mark Namespace for auto-import | ||
| == Wait for the Cluster to appear in Rancher dashboard. |
Collaborator
There was a problem hiding this comment.
Suggested change
| == Wait for the Cluster to appear in Rancher dashboard. | |
| == Next Steps: Wait for the cluster to appear in the Rancher Dashboard |
| ==== | ||
| To prevent a cluster from getting stuck in deletion when Fleet is removed, keep auto-import enabled in the UI or avoid manually removing labels in the cluster's namespace, as Turtles will no longer handle the 'import' functionality from that point onward. | ||
| ==== No newline at end of file | ||
| The Cluster provisioned in this tutorial contains the `cluster-api.cattle.io/rancher-auto-import` label. |
Collaborator
There was a problem hiding this comment.
Suggested change
| The Cluster provisioned in this tutorial contains the `cluster-api.cattle.io/rancher-auto-import` label. | |
| The cluster provisioned in this tutorial contains the `cluster-api.cattle.io/rancher-auto-import` label. |
| To prevent a cluster from getting stuck in deletion when Fleet is removed, keep auto-import enabled in the UI or avoid manually removing labels in the cluster's namespace, as Turtles will no longer handle the 'import' functionality from that point onward. | ||
| ==== No newline at end of file | ||
| The Cluster provisioned in this tutorial contains the `cluster-api.cattle.io/rancher-auto-import` label. | ||
| This label will instruct Turtles to automatically import the Cluster into Rancher. |
Collaborator
There was a problem hiding this comment.
Suggested change
| This label will instruct Turtles to automatically import the Cluster into Rancher. | |
| This label will instruct Turtles to automatically import the cluster into Rancher. |
| :revdate: 2026-03-06 | ||
| :page-revdate: {revdate} | ||
|
|
||
| == How to register a CAPI Cluster in Rancher using Turtles auto-import |
Collaborator
There was a problem hiding this comment.
Suggested change
| == How to register a CAPI Cluster in Rancher using Turtles auto-import | |
| == How to register a CAPI cluster in Rancher using Turtles auto-import |
|
|
||
| == How to register a CAPI Cluster in Rancher using Turtles auto-import | ||
|
|
||
| The only supported workflow to register CAPI Clusters in Rancher using Turtles, is by using the `cluster-api.cattle.io/rancher-auto-import` label: |
Collaborator
There was a problem hiding this comment.
Suggested change
| The only supported workflow to register CAPI Clusters in Rancher using Turtles, is by using the `cluster-api.cattle.io/rancher-auto-import` label: | |
| The only supported workflow to register CAPI clusters in Rancher using Turtles, is by using the `cluster-api.cattle.io/rancher-auto-import` label: |
| Marking a cluster for auto-import triggers automatic registration by the Turtles controller, manual execution of registration commands is not supported. | ||
| ==== | ||
|
|
||
| == Add a custom description to Rancher Cluster |
Collaborator
There was a problem hiding this comment.
Suggested change
| == Add a custom description to Rancher Cluster | |
| == Add a custom description to Rancher cluster |
|
|
||
| == Delete the imported cluster from Rancher | ||
|
|
||
| The `cluster-api.cattle.io/capi-cluster-owner` and `cluster-api.cattle.io/capi-cluster-owner-ns` labels can be used to delete the Rancher Cluster: |
Collaborator
There was a problem hiding this comment.
Suggested change
| The `cluster-api.cattle.io/capi-cluster-owner` and `cluster-api.cattle.io/capi-cluster-owner-ns` labels can be used to delete the Rancher Cluster: | |
| The `cluster-api.cattle.io/capi-cluster-owner` and `cluster-api.cattle.io/capi-cluster-owner-ns` labels can be used to delete the Rancher cluster: |
| . Turtles controller will annotate the CAPI cluster with `imported: true`. | ||
| . This annotation prevents the cluster from being re-imported automatically by Rancher. | ||
| . Verify the annotation using the following command: | ||
|
|
Comment on lines
+80
to
+81
| [NOTE] | ||
| Deleting the Rancher cluster only removes the `clusters.management.cattle.io` resource and disables auto-import for the associated CAPI cluster. The underlying CAPI cluster iteself remains intact. |
Collaborator
There was a problem hiding this comment.
Suggested change
| [NOTE] | |
| Deleting the Rancher cluster only removes the `clusters.management.cattle.io` resource and disables auto-import for the associated CAPI cluster. The underlying CAPI cluster iteself remains intact. | |
| [NOTE] | |
| ==== | |
| Deleting the Rancher cluster only removes the `clusters.management.cattle.io` resource and disables auto-import for the associated CAPI cluster. The underlying CAPI cluster iteself remains intact. | |
| ==== |
Comment on lines
+85
to
+91
| If you need to re-import the same CAPI cluster into Rancher: | ||
|
|
||
| Remove the `imported: true` annotation: | ||
| [source, bash] | ||
| ---- | ||
| kubectl -n capi-clusters patch clusters.cluster.x-k8s.io <cluster-name> --type='json' -p='[{"op": "remove", "path": "/metadata/annotations/imported"}]' | ||
| ---- |
Collaborator
There was a problem hiding this comment.
Suggested change
| If you need to re-import the same CAPI cluster into Rancher: | |
| Remove the `imported: true` annotation: | |
| [source, bash] | |
| ---- | |
| kubectl -n capi-clusters patch clusters.cluster.x-k8s.io <cluster-name> --type='json' -p='[{"op": "remove", "path": "/metadata/annotations/imported"}]' | |
| ---- | |
| If you need to re-import the same CAPI cluster into Rancher, remove the `imported: true` annotation via the command below: | |
| [source, bash] | |
| ---- | |
| kubectl -n capi-clusters patch clusters.cluster.x-k8s.io <cluster-name> --type='json' -p='[{"op": "remove", "path": "/metadata/annotations/imported"}]' | |
| ---- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a new "Rancher Cluster Registration" page.
This page serves to consolidate some documentation about Cluster import into Rancher, which was sparse before.
It includes:
Fixes #148