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

Jump to bottom

[release-1.5] 📖 Add CAPI Operator Quickstart #9722

Merged
merged 1 commit into from
Nov 15, 2023
Merged

[release-1.5] 📖 Add CAPI Operator Quickstart #9722

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
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[Introduction](./introduction.md)
[Quick Start](./user/quick-start.md)
[Quick Start Operator](./user/quick-start-operator.md)
[Concepts](./user/concepts.md)
[Personas](./user/personas.md)
- [Tasks](./tasks/index.md)
Expand Down
6 changes: 6 additions & 0 deletions docs/book/src/user/quick-start-operator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Cluster API Operator Quickstart

This section provides a quickstart guide for using the Cluster API Operator to create a Kubernetes cluster.
To use the `clusterctl` quickstart path, visit [this quickstart guide](./quick-start.md).

{{#embed-github repo:"kubernetes-sigs/cluster-api-operator" path:"docs/quickstart.md" }}
11 changes: 11 additions & 0 deletions docs/book/src/user/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ 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 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.

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

- Install and setup [kubectl] in your local environment
Expand Down Expand Up @@ -1613,3 +1623,4 @@ kind delete cluster
[provider components]: ../reference/glossary.md#provider-components
[vSphere getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/master/docs/getting_started.md
[workload cluster]: ../reference/glossary.md#workload-cluster
[CAPI Operator quickstart]: ./quick-start-operator.md