Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Adds general overview of CAPRKE2 #241

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

📖 Adds general overview of CAPRKE2 #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/next/modules/en/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
* Reference
** xref:reference/architecture.adoc[Architecture]
** xref:reference/glossary.adoc[Glossary]
** xref:reference/features.adoc[Feature]
** xref:reference/features.adoc[Features]
** xref:reference/certified.adoc[Certified Providers]
** xref:reference/CAPRKE2.adoc[CAPRKE2]
* User Guide
** xref:user/clusters.adoc[Provision a CAPI cluster]
** xref:user/clusterclass.adoc[Provision a CAPI cluster with ClusterClass]
Expand Down
11 changes: 11 additions & 0 deletions docs/next/modules/en/pages/reference/CAPRKE2.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
= Cluster API Provider RKE2

== What is Cluster API Provider RKE2?

The link:https://cluster-api.sigs.k8s.io/[Cluster API] brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.

Cluster API Provider RKE2 (CAPRKE2) is a combination of 2 provider types, a Cluster API Control Plane Provider for provisioning Kubernetes control plane nodes and a Cluster API Bootstrap Provider for bootstrapping Kubernetes on a machine where link:https://docs.rke2.io/[RKE2] is used as the Kubernetes distro.

== Learn more

To learn more about CAPRKE2, visit its dedicated documentation link:https://caprke2.docs.rancher.com/[website].
Comment on lines +1 to +11
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a copy-paste of the introductory paragraph on CAPRKE2 website. I am not sure how much we want to add to the Turtles docs in terms of "general overview of CAPRKE2". Hence, the PR is a Draft.

@rancher/highlander please suggest what would be good to be added here.

1 change: 0 additions & 1 deletion docs/next/modules/en/pages/reference/architecture.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Architecture
:sidebar_position: 0

This guide offers a comprehensive overview of the core components and structure that power {product_name} and its integration within the Rancher ecosystem.

Expand Down
1 change: 0 additions & 1 deletion docs/next/modules/en/pages/reference/features.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Features
:sidebar_position: 0

This section describes features and feature stages in {product_name}.

Expand Down
1 change: 0 additions & 1 deletion docs/next/modules/en/pages/reference/glossary.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Glossary
:sidebar_position: 2

== Table of Contents

Expand Down