Skip to content

Commit 52d9cb4

Browse files
authored
Merge pull request #4892 from CecileRobertMichon/quickstart-0.4
📖 Update quickstart clusterctl install instructions to v0.4
2 parents 16e3698 + ad4b4e8 commit 52d9cb4

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

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

+18-18
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
In this tutorial we'll cover the basics of how to use Cluster API to create one or more Kubernetes clusters.
44

5+
<aside class="note warning">
6+
7+
<h1>Warning</h1>
8+
9+
If using a [provider] that does not yet support v1alpha4, please follow [the release 0.3 quickstart instructions](https://release-0-3.cluster-api.sigs.k8s.io/user/quick-start.html) instead.
10+
11+
</aside>
12+
513
## Installation
614

715
### Common Prerequisites
@@ -90,9 +98,9 @@ The clusterctl CLI tool handles the lifecycle of a Cluster API management cluste
9098
{{#tab linux}}
9199
92100
#### Install clusterctl binary with curl on linux
93-
Download the latest release; for example, to download version v0.3.0 on linux, type:
101+
Download the latest release; on linux, type:
94102
```
95-
curl -L {{#releaselink gomodule:"sigs.k8s.io/cluster-api" asset:"clusterctl-linux-amd64" version:"0.3.x"}} -o clusterctl
103+
curl -L {{#releaselink gomodule:"sigs.k8s.io/cluster-api" asset:"clusterctl-linux-amd64" version:"0.4.x"}} -o clusterctl
96104
```
97105
Make the clusterctl binary executable.
98106
```
@@ -111,9 +119,9 @@ clusterctl version
111119
{{#tab macOS}}
112120
113121
##### Install clusterctl binary with curl on macOS
114-
Download the latest release; for example, to download version v0.3.0 on macOS, type:
122+
Download the latest release; on macOS, type:
115123
```
116-
curl -L {{#releaselink gomodule:"sigs.k8s.io/cluster-api" asset:"clusterctl-darwin-amd64" version:"0.3.x"}} -o clusterctl
124+
curl -L {{#releaselink gomodule:"sigs.k8s.io/cluster-api" asset:"clusterctl-darwin-amd64" version:"0.4.x"}} -o clusterctl
117125
```
118126
Make the clusterctl binary executable.
119127
```
@@ -310,12 +318,12 @@ The output of `clusterctl init` is similar to this:
310318
311319
```shell
312320
Fetching providers
313-
Installing cert-manager
321+
Installing cert-manager Version="v1.1.0"
314322
Waiting for cert-manager to be available...
315-
Installing Provider="cluster-api" Version="v0.3.0" TargetNamespace="capi-system"
316-
Installing Provider="bootstrap-kubeadm" Version="v0.3.0" TargetNamespace="capi-kubeadm-bootstrap-system"
317-
Installing Provider="control-plane-kubeadm" Version="v0.3.0" TargetNamespace="capi-kubeadm-control-plane-system"
318-
Installing Provider="infrastructure-aws" Version="v0.5.0" TargetNamespace="capa-system"
323+
Installing Provider="cluster-api" Version="v0.4.0" TargetNamespace="capi-system"
324+
Installing Provider="bootstrap-kubeadm" Version="v0.4.0" TargetNamespace="capi-kubeadm-bootstrap-system"
325+
Installing Provider="control-plane-kubeadm" Version="v0.4.0" TargetNamespace="capi-kubeadm-control-plane-system"
326+
Installing Provider="infrastructure-docker" Version="v0.4.0" TargetNamespace="capd-system"
319327
320328
Your management cluster has been initialized successfully!
321329
@@ -679,15 +687,6 @@ clusterctl get kubeconfig capi-quickstart > capi-quickstart.kubeconfig
679687
680688
<h1>Warning</h1>
681689
682-
The `clusterctl get kubeconfig` command is available on for clusterctl v0.3.9 or newer. See [clusterctl get kubeconfig] for more details. If you are running older
683-
version you can use the following command:
684-
685-
```bash
686-
kubectl --namespace=default get secret capi-quickstart-kubeconfig \
687-
-o jsonpath={.data.value} | base64 --decode \
688-
> capi-quickstart.kubeconfig
689-
```
690-
691690
If you are using docker on MacOS, you will need to do a couple of additional
692691
steps to get the correct kubeconfig for a workload cluster created with the docker provider.
693692
See [Additional Notes for the Docker Provider](../clusterctl/developers.md#additional-notes-for-the-docker-provider).
@@ -774,6 +773,7 @@ See the [clusterctl] documentation for more detail about clusterctl supported ac
774773
[Metal3 getting started guide]: https://github.com/metal3-io/cluster-api-provider-metal3/blob/master/docs/getting-started.md
775774
[Metal3 provider]: https://github.com/metal3-io/cluster-api-provider-metal3/
776775
[Packet getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-packet#using
776+
[provider]:../reference/providers.md
777777
[provider components]: ../reference/glossary.md#provider-components
778778
[vSphere getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/master/docs/getting_started.md
779779
[workload cluster]: ../reference/glossary.md#workload-cluster

0 commit comments

Comments
 (0)