From bb6fdcb0783355b4f37effe8edf0b134242980b0 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Mon, 30 Aug 2021 18:29:03 -0700 Subject: [PATCH] Respond to feedback on cluster templates doc --- .../cluster-templates/_index.md | 23 +++++++++---------- 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/content/rancher/v2.6/en/admin-settings/cluster-templates/_index.md b/content/rancher/v2.6/en/admin-settings/cluster-templates/_index.md index 5ba175bd59b..2be5e058afb 100644 --- a/content/rancher/v2.6/en/admin-settings/cluster-templates/_index.md +++ b/content/rancher/v2.6/en/admin-settings/cluster-templates/_index.md @@ -6,11 +6,11 @@ weight: 100 Cluster templates encompass both Kubernetes configuration and node pool configuration, allowing a single template to contain all the information Rancher needs to provision new nodes in a cloud provider and install Kubernetes on those nodes. - [Overview](#overview) +- [RKE2 Cluster Template](#rke2-cluster-template) - [Adding a Cluster Template to Rancher](#adding-a-cluster-template-to-rancher) - [Creating a Cluster from a Cluster Template](#creating-a-cluster-from-a-cluster-template) - [Uninstalling Cluster Templates](#uninstalling-cluster-templates) - [Configuration Options](#configuration-options) -- [Cluster Template Example Repository](#cluster-template-example-repository) # Overview @@ -26,13 +26,17 @@ Cluster templates can use any Kubernetes distribution. For now, we provide an ex Rancher doesn't manage version control for cluster templates. Version control is handled in the repository containing the template's Helm chart. +# RKE2 Cluster Template + +The example repository for an RKE2 cluster template is [here](https://github.com/rancher/cluster-template-examples). As of Rancher v2.6.0, we provide an RKE2 cluster template and may add more in the future. + # Adding a Cluster Template to Rancher > **Prerequisite:** You will need permission to configure a Helm chart repository in Rancher. 1. Go to a cluster template example repository. Rancher's examples are in [this GitHub repository.](https://github.com/rancher/cluster-template-examples) As of Rancher v2.6.0, we provide an RKE2 cluster template and add to more in the future. 1. Fork the repository. -1. Optional: Edit the cluster options by editing the `values.yaml` file. For help editing the file, see the cluster template's Helm chart README. +1. Optional: Edit the cluster options by editing the `values.yaml` file. For help editing the file, see the cluster template's Helm chart README. Note that in order for the chart to appear in the form for creating new clusters, the chart must have the annotation `catalog.cattle.io/type: cluster-template`. 1. Add the chart repository to Rancher. Click **☰ > Cluster Management**. 1. Go to the `local` cluster and click **Explore.** 1. In the left navigation bar, click **Apps & Marketplace > Chart Repositories.** @@ -52,14 +56,13 @@ Rancher doesn't manage version control for cluster templates. Version control is > - You will need permission to provision new Kubernetes clusters. > - You will need permission to install Helm charts on the `local` Kubernetes cluster that the Rancher management server is installed on. > - In order to use a template as part of continuous delivery/GitOps, the cluster template needs to be deployed in the `fleet-local` namespace of the `local` cluster. +> - In order to show in the form for creating new clusters, the cluster template's Helm chart must have the `catalog.cattle.io/type: cluster-template` annotation. 1. Click **☰ > Cluster Management**. -1. Go to the `local` cluster and click **Apps & Marketplace > Charts.** -1. In the dropdown menu under **Charts**, select the chart repository for your cluster template. -1. Install the Helm chart onto the cluster. -1. When the cluster resource is created, the new cluster is provisioned. +1. On the **Clusters** page, click **Create.** +1. Click **Create Cluster from Template.** -**Result:** The new cluster is managed in the same way as any other Rancher-launched Kubernetes cluster. +**Result:** After Rancher provisions the new cluster, it is managed in the same way as any other Rancher-launched Kubernetes cluster. # Uninstalling Cluster Templates @@ -92,8 +95,4 @@ Cluster templates are flexible enough that they can be used to configure all of - Add-ons - Kubernetes options, including configurations for Kubernetes components such as kube-api, kube-controller, kubelet, and services -For details on how to configure the template, refer to the cluster template's Helm chart README. - -# Cluster Template Example Repository - -The example repo is [here](https://github.com/rancher/cluster-template-examples). As of Rancher v2.6.0, we provide an RKE2 cluster template and add to more in the future. \ No newline at end of file +For details on how to configure the template, refer to the cluster template's Helm chart README. \ No newline at end of file