Merge pull request #24 from sunilarjun/add-v0.12

Add v0.12 Documentation

playbook-remote.yml

@@ -1,13 +1,13 @@
 site:
   title: Cluster-API
   url: /
-  start_page: v0.11@cluster-api:en:index.adoc
+  start_page: v0.12@cluster-api:en:index.adoc
 
 content:
   sources:
     - url: https://github.com/rancher/turtles-product-docs.git
       branches: [main]
-      start_paths: [versions/v0.11, versions/v0.10]
+      start_paths: [versions/v0.12, versions/v0.11]
 
 
 ui: 

turtles-local-playbook.yml

@@ -1,12 +1,12 @@
 site:
   title: Cluster-API
   url: /
-  start_page: v0.11@cluster-api:en:index.adoc
+  start_page: v0.12@cluster-api:en:index.adoc
 
 content:
   sources:
     - url: ./
-      start_paths: [versions/v0.11, versions/v0.10]
+      start_paths: [versions/v0.12, versions/v0.11]
 
 # Description: SUSE UI bundle
 ui:

versions/v0.11/modules/en/pages/developer-guide/install_capi_operator.adoc

@@ -93,7 +93,7 @@ helm install ... --set infrastructure="docker:v1.7.3;aws:v2.6.1"
 
 The `infrastructure` flag is set to `docker:v1.7.3;aws:v2.6.1`, representing the desired provider names. This means that the `Cluster API Operator` will install and manage multiple providers, `Docker` and `AWS`, with versions `v1.7.3` and `v2.6.1` respectively.
 
-The cluster is now ready to install {product_name}. The default behavior when installing the chart is to install Cluster API Operator as a Helm dependency. Since we decided to install it manually before installing {product_name}, the feature `cluster-api-operator.enabled` must be explicitly disabled as otherwise it would conflict with the existing installation. You can refer to xref:../developer-guide/install_capi_operator.adoc#_install_rancher_turtles_without_cluster_api_operator_as_a_helm_dependency[Install {product_name} without Cluster API Operator] to see next steps.
+The cluster is now ready to install {product_name}. The default behavior when installing the chart is to install Cluster API Operator as a Helm dependency. Since we decided to install it manually before installing {product_name}, the feature `cluster-api-operator.enabled` must be explicitly disabled as otherwise it would conflict with the existing installation. You can refer to xref:../developer-guide/install_capi_operator.adoc#_install_suse_rancher_prime_cluster_api_without_cluster_api_operator_as_a_helm_dependency[Install {product_name} without Cluster API Operator] to see next steps.
 
 [TIP]
 ====

versions/v0.11/modules/en/pages/getting-started/install-rancher-turtles/using_helm.adoc

@@ -14,7 +14,7 @@ CAPI Operator allows handling the lifecycle of Cluster API Providers using a dec
 
 [IMPORTANT]
 ====
-Before <<_install_rancher_turtles_with_cluster_api_operator_as_a_helm_dependency,installing {product_name}>> in your Rancher environment, Rancher's `embedded-cluster-api` functionality must be disabled. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
+Before <<_install_suse_rancher_prime_cluster_api_with_cluster_api_operator_as_a_helm_dependency,installing {product_name}>> in your Rancher environment, Rancher's `embedded-cluster-api` functionality must be disabled. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
 
 To simplify setting up Rancher for installing {product_name}, the official {product_name} Helm chart includes a `pre-install` hook that applies these changes, making it transparent to the end user:
 

versions/v0.11/modules/en/pages/getting-started/install-rancher-turtles/using_rancher_dashboard.adoc

@@ -13,7 +13,7 @@ In case you need to review the list of prerequisites (including `cert-manager`),
 
 [IMPORTANT]
 ====
-Before xref:./using_helm.adoc#_install_rancher_turtles_with_cluster_api_operator_as_a_helm_dependency[installing {product_name}] in your Rancher environment, Rancher's `embedded-cluster-api` functionality must be disabled. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
+Before xref:./using_helm.adoc#_install_suse_rancher_prime_cluster_api_with_cluster_api_operator_as_a_helm_dependency[installing {product_name}] in your Rancher environment, Rancher's `embedded-cluster-api` functionality must be disabled. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
 
 To simplify setting up Rancher for installing {product_name}, the official {product_name} Helm chart includes a `pre-install` hook that applies these changes, making it transparent to the end user:
 

versions/v0.11/modules/en/pages/reference/glossary.adoc

@@ -259,10 +259,6 @@ A component deployed by Rancher in each Kubernetes cluster it manages. Its prima
 
 The Rancher Manager (or Rancher Server) is where the Rancher UI and API are hosted, and it communicates with managed clusters through components like the <<_rancher_cluster_agent,Rancher Cluster Agent>>. It allows users to manage their Kubernetes clusters, applications, and Rancher-specific resources such as Catalogs, Users, Global Roles, and more.
 
-=== {product_name}
-
-A <<_kubernetes_operator,Kubernetes operator>> that provides integration between Rancher Manager and Cluster API (CAPI) with the aim of bringing full CAPI support to Rancher.
-
 === RKE2
 
 Rancher's next-generation, fully conformant Kubernetes distribution that focuses on security and compliance within the U.S. Federal Government sector. See https://docs.rke2.io/[documentation] for more details.
@@ -290,6 +286,10 @@ is running as a static pod.
 
 The infrastructure that backs a <<_machine,Machine Resource>>, typically either a cloud instance, virtual machine, or physical host.
 
+=== {product_name}
+
+A <<_kubernetes_operator,Kubernetes operator>> that provides integration between Rancher Manager and Cluster API (CAPI) with the aim of bringing full CAPI support to Rancher.
+
 == T
 
 === Topology
@@ -301,7 +301,7 @@ See <<_clusterclass,ClusterClass>>
 
 === Turtles
 
-Refers to <<_rancher_turtles,{product_name}>>
+Refers to <<_suse_rancher_prime_cluster_api,{product_name}>>
 
 == W
 

versions/v0.12/antora.yml

@@ -0,0 +1,10 @@
+name: cluster-api
+title: Cluster API
+version: v0.12
+display_version: '0.12'
+start_page: en:index.adoc
+asciidoc:
+  attributes:
+    product_name: SUSE® Rancher Prime Cluster API
+nav:
+  - modules/en/v0.12-sidebars.adoc

versions/v0.12/modules/en/pages/developer-guide/development.adoc

@@ -0,0 +1,57 @@
+= Development setup
+:sidebar_position: 3
+
+== Prerequisites:
+
+* https://kind.sigs.k8s.io/[kind]
+* https://helm.sh/[helm]
+* https://tilt.dev/[tilt]
+
+== Create a local development environment
+
+. Clone the https://github.com/rancher/turtles[{product_name}] repository locally
+. Create *tilt-settings.yaml*:
++
+[source,yaml]
+----
+{
+    "k8s_context": "k3d-rancher-test",
+    "default_registry": "ghcr.io/turtles-dev",
+    "debug": {
+        "turtles": {
+            "continue": true,
+            "port": 40000
+        }
+    }
+}
+----
++
+. Open a terminal in the root of the {product_name} repository
+. Run the following:
++
+[source,bash]
+----
+make dev-env
+
+# Or if you want to use a custom hostname for Rancher
+RANCHER_HOSTNAME=my.customhost.dev make dev-env
+----
++
+. When tilt has started, open a new terminal and start ngrok or inlets
++
+[source,bash]
+----
+kubectl port-forward --namespace cattle-system svc/rancher 10000:443
+ngrok http https://localhost:10000
+----
+
+== What happens when you run `make dev-env`?
+
+. A https://kind.sigs.k8s.io/[kind] cluster is created with the following https://github.com/rancher/turtles/blob/main/scripts/kind-cluster-with-extramounts.yaml[configuration].
+. xref:../developer-guide/install_capi_operator.adoc[Cluster API Operator] is installed using helm, which includes:
+ ** Core Cluster API controller
+ ** Kubeadm Bootstrap and Control Plane Providers
+ ** Docker Infrastructure Provider
+ ** Cert manager
+. `Rancher manager` is installed using helm.
+. `tilt up` is run to start the development environment.