Skip to content

Commit

Permalink
Add Rancher Turtles component
Browse files Browse the repository at this point in the history
  • Loading branch information
hardys committed Dec 17, 2024
1 parent 00b2985 commit f4035ef
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 0 deletions.
45 changes: 45 additions & 0 deletions asciidoc/components/turtles.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
[#components-rancher-turtles]
= Rancher Turtles
:experimental:

ifdef::env-github[]
:imagesdir: ../images/
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]


See Rancher Turtles documentation at https://turtles.docs.rancher.com/turtles/{rancher-turtles-docs-version}

[quote]
____
Rancher Turtles is a Kubernetes Operator that provides integration between Rancher Manager and Cluster API (CAPI) with the aim of bringing full CAPI support to Rancher
____


== Key Features of Rancher Turtles

* Automatically import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters.
* Install and configure CAPI controller dependencies via the https://cluster-api-operator.sigs.k8s.io/[CAPI Operator].

== Rancher Turtles use in SUSE Edge

The SUSE Edge stack provides a helm wrapper chart which installs Rancher Turtles with a specific configuration that enables:

* Core CAPI controller components
* RKE2 Control Plane and Bootstrap provider components
* <<components-metal3,Metal3>> infrastructure provider components

Only the default providers installed via the wrapper chart are supported - alternative Control Plane, Bootstrap and Infrastructure providers are not currently supported as part of the SUSE Edge stack.

== Installing Rancher Turtles

Rancher Turtles may be installed by following the <<quickstart-metal3,Metal3 Quickstart>> guide, or the <<atip-management-cluster,ATIP Management Cluster>> documentation.

== Additional Resources

* https://rancher.com/docs/[Rancher Documentation]
* https://cluster-api.sigs.k8s.io/[Cluster API Book]
2 changes: 2 additions & 0 deletions asciidoc/edge-book/edge.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ include::../components/rancher.adoc[leveloffset=+1]
include::../components/rancher-dashboard-extensions.adoc[leveloffset=+1]
include::../components/turtles.adoc[leveloffset=+1]
include::../components/fleet.adoc[leveloffset=+1]
include::../components/sle-micro.adoc[leveloffset=+1]
Expand Down
5 changes: 5 additions & 0 deletions asciidoc/edge-book/links.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@

:link-cert-manager-installation: https://cert-manager.io/v1.14-docs/installation/helm/#installing-with-helm

// ============================================================================
// Rancher Turtles

:rancher-turtles-docs-version: v0.11

// ============================================================================
// Longhorn

Expand Down
1 change: 1 addition & 0 deletions asciidoc/edge-book/welcome.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ The full list of components, along with a link to a high-level description of ea

* <<components-rancher,Rancher>>
* <<components-rancher-dashboard-extensions,Rancher Dashboard Extensions>>
* <<components-rancher-turtles,Rancher Turtles>>
* SUSE Manager
* <<components-fleet,Fleet>>
* <<components-slmicro,SLE Micro>>
Expand Down

0 comments on commit f4035ef

Please sign in to comment.