Skip to content

Commit 93d6e79

Browse files
authored
Merge pull request kubernetes-sigs#9706 from dtzar/operator-quickstart
📖 Add CAPI Operator Quickstart
2 parents 0a01d30 + 1cb66fb commit 93d6e79

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[Introduction](./introduction.md)
44
[Quick Start](./user/quick-start.md)
5+
[Quick Start Operator](./user/quick-start-operator.md)
56
[Concepts](./user/concepts.md)
67
[Personas](./user/personas.md)
78
- [Tasks](./tasks/index.md)
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Cluster API Operator Quickstart
2+
3+
This section provides a quickstart guide for using the Cluster API Operator to create a Kubernetes cluster.
4+
To use the `clusterctl` quickstart path, visit [this quickstart guide](./quick-start.md).
5+
6+
{{#embed-github repo:"kubernetes-sigs/cluster-api-operator" path:"docs/quickstart.md" }}

docs/book/src/user/quick-start.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ If using a [provider] that does not support v1beta1 or v1alpha4 yet, please foll
1212

1313
## Installation
1414

15+
There are two major quickstart paths: Using clusterctl or the Cluster API Operator.
16+
17+
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).
18+
19+
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.
20+
21+
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.
22+
23+
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.
24+
1525
### Common Prerequisites
1626

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

0 commit comments

Comments
 (0)