From 973c6a071149830c8bcfc99bbb2d231adba225d9 Mon Sep 17 00:00:00 2001 From: David Tesar Date: Mon, 13 Nov 2023 10:49:30 -0800 Subject: [PATCH] Implement Fabrizio suggestions Co-authored-by: Fabrizio Pandini --- docs/book/src/user/quick-start.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/book/src/user/quick-start.md b/docs/book/src/user/quick-start.md index b72894b6cef3..56d519e68992 100644 --- a/docs/book/src/user/quick-start.md +++ b/docs/book/src/user/quick-start.md @@ -13,10 +13,14 @@ If using a [provider] that does not support v1beta1 or v1alpha4 yet, please foll ## Installation There are two major quickstart paths: Using clusterctl or the Cluster API Operator. + + This article describes a path that uses the `clusterctl` CLI tool to handle the lifecycle of a Cluster API [management cluster](https://cluster-api.sigs.k8s.io/reference/glossary#management-cluster). -The Cluster API Operator is a Kubernetes Operator designed to empower cluster administrators to handle the lifecycle of Cluster API providers within a management cluster using a declarative approach. It aims to improve user experience in deploying and managing Cluster API, making it easier to handle day-to-day tasks and automate workflows with GitOps. +The clusterctl command line interface is specifically designed for providing a simple “day 1 experience” and a quick start with Cluster API. It automates fetching the YAML files defining [provider components](https://cluster-api.sigs.k8s.io/reference/glossary#provider-components) and installing them. -Continue on with this article for the `clusterctl` path or visit the [CAPI Operator quickstart] instead. +Additionally it encodes a set of best practices in managing providers, that helps the user in avoiding mis-configurations or in managing day 2 operations such as upgrades. + +The Cluster API Operator is a Kubernetes Operator built on top of clusterctl and designed to empower cluster administrators to handle the lifecycle of Cluster API providers within a management cluster using a declarative approach. It aims to improve user experience in deploying and managing Cluster API, making it easier to handle day-to-day tasks and automate workflows with GitOps. Visit the [CAPI Operator quickstart] if you want to experiment with this tool. ### Common Prerequisites