Skip to content

Commit cda387d

Browse files
committed
📖Quickstart / add other sections
Signed-off-by: Vince Prignano <[email protected]>
1 parent ca112ae commit cda387d

File tree

9 files changed

+55
-12
lines changed

9 files changed

+55
-12
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- [Scope, objectives, goals and requirements](./docs/scope-and-objectives.md)
1313
- [Feature proposals](./docs/proposals)
1414
- [Reference use cases](./docs/staging-use-cases.md)
15-
- [Quick Start](https://cluster-api.sigs.k8s.io/quick-start.html)
15+
- [Quick Start](https://cluster-api.sigs.k8s.io/user/quick-start.html)
1616

1717
## What is the Cluster API?
1818

docs/book/src/SUMMARY.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,21 @@
22

33
[Introduction](./introduction.md)
44

5-
[Quick Start](./quick-start.md)
5+
- [User Guide](./user/guide.md)
6+
- [Concepts](./user/concepts.md)
7+
- [Quick Start](./user/quick-start.md)
68

7-
- [Architecture](./architecture/architecture.md)
9+
- [Developer Guide](./architecture/architecture.md)
810
- [Repository Layout](./architecture/repository-layout.md)
911
- [Controllers](./architecture/controllers.md)
1012
- [Cluster](./architecture/controllers/cluster.md)
1113
- [Machine](./architecture/controllers/machine.md)
1214
- [MachineSet](./architecture/controllers/machine-set.md)
1315
- [MachineDeployment](./architecture/controllers/machine-deployment.md)
14-
15-
- [Clusterctl](./clusterctl/clusterctl.md)
16-
17-
- [Provider Implementers](./providers/implementers.md)
16+
- [Provider Implementers](./providers/implementers.md)
17+
- [v1alpha1 to v1alpha2](./providers/v1alpha1-to-v1alpha2.md)
18+
- [Tooling](./tooling/tooling.md)
19+
- [Clusterctl](./tooling/clusterctl.md)
1820

1921
- [Reference](./reference/reference.md)
2022
- [Abbreviations](./reference/abbreviations.md)

docs/developer/v1alpha1-compared-to-v1alpha2.md renamed to docs/book/src/providers/v1alpha1-to-v1alpha2.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ controllers that are responsible for the core types:
2525
* Machine
2626
* MachineSet
2727
* MachineDeployment
28-
* [plus a few more](../../pkg/apis/cluster/v1alpha2)
2928

3029
Bootstrap providers are an entirely new concept aimed at reducing the amount of kubeadm boilerplate that every provider
3130
reimplemented in v1alpha1. The Bootstrap provider is responsible for running a controller that generates data necessary
@@ -41,7 +40,7 @@ bootstrap data to turn the infrastructure into a Kubernetes cluster.
4140

4241
Actuators are interfaces that the Cluster API controller calls. A provider pulls in the generic Cluster API controller
4342
and then registers actuators to run specific infrastructure logic (calls to the provider cloud).
44-
43+
4544
### v1alpha2
4645

4746
Actuators are not used in this version. Cluster API's controllers are no longer shared across providers and therefore
@@ -57,11 +56,11 @@ create a cloud instance for Kubernetes to run on.
5756

5857
`clusterctl` was a command line tool packaged with v1alpha1 providers. The goal of this tool was to go from nothing to a
5958
running management cluster in whatever environment the provider was built for. For example, Cluster-API-Provider-AWS
60-
packaged a `clusterctl` that created a Kubernetes cluster in EC2 and installed the necessary controllers to respond to
59+
packaged a `clusterctl` that created a Kubernetes cluster in EC2 and installed the necessary controllers to respond to
6160
Cluster API's APIs.
6261

6362
### v1alpha2
6463

65-
`clusterctl` is likely becoming provider-agnostic meaning one clusterctl is bundled with Cluster API and can be reused
64+
`clusterctl` is likely becoming provider-agnostic meaning one clusterctl is bundled with Cluster API and can be reused
6665
across providers. Work here is still being figured out but providers will not be packaging their own `clusterctl`
6766
anymore.

docs/book/src/quick-start.md

Lines changed: 0 additions & 1 deletion
This file was deleted.
File renamed without changes.

docs/book/src/tooling/tooling.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Tooling

docs/book/src/user/concepts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Concepts

docs/book/src/user/guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# User Guide

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

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Quick Start
2+
3+
In this tutorial we'll cover the basics of how to use Cluster API to create one or more Kubernetes clusters.
4+
5+
## Prerequisites
6+
7+
8+
- Install and setup [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) in your local environment.
9+
- A working Kubernetes cluster to be used as[management cluster](https://cluster-api.sigs.k8s.io/reference/glossary.html#management-cluster).
10+
11+
## Before we start
12+
13+
#### Picking Infrastructure and Bootstrap Providers
14+
15+
The [providers section](../reference/providers.md) offers a quick reference to some providers
16+
available and compatible with Cluster API _v1alpha2_.
17+
18+
<aside class="note">
19+
<h1>Following Along vs Jumping Ahead</h1>
20+
21+
If you're unfamiliar with the different providers types and how they interact with each other,
22+
please refer to the [user guide concepts].
23+
24+
[user guide concepts]: ../user/concepts.md
25+
</aside>
26+
27+
To proceed, we'll need to pick and choose a _Bootstrap_ and _Infrastructure_ provider.
28+
29+
#### What if I don't have a management cluster?
30+
In some cases, you might not have a Kubernetes Cluster available to be used
31+
as management cluster for Cluster API resources.
32+
33+
Services like Google Cloud GKE, Amazon EKS, Azure Kuberentes Service (AKS),
34+
or similar, are good examples of Kubernetes-as-a-service platforms
35+
that can be used for this purpose.
36+
37+
If you're looking for a temporary cluster for testing, development, or demos,
38+
we suggest you to use [KIND](https://sigs.k8s.io/kind) to create a
39+
local Kubernetes cluster using containers.
40+

0 commit comments

Comments
 (0)