Skip to content

Commit

Permalink
Implement Fabrizio suggestions
Browse files Browse the repository at this point in the history
Co-authored-by: Fabrizio Pandini <fabrizio.pandini@gmail.com>
  • Loading branch information
dtzar and fabriziopandini committed Nov 13, 2023
1 parent 40fd75e commit 973c6a0
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/book/src/user/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 973c6a0

Please sign in to comment.