Skip to content

Commit 67bae89

Browse files
authored
Merge pull request #2730 from CecileRobertMichon/quickstart-order
📖 clarify order of steps in quickstart to deploy workload cluster
2 parents 038c619 + aca0fb0 commit 67bae89

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

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

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ Please visit the [Metal3 getting started guide].
374374

375375
For the purpose of this tutorial, we’ll name our cluster capi-quickstart.
376376

377-
```
377+
```bash
378378
clusterctl config cluster capi-quickstart --kubernetes-version v1.17.3 --control-plane-machine-count=3 --worker-machine-count=3 > capi-quickstart.yaml
379379
```
380380

@@ -389,13 +389,13 @@ See `[clusterctl config cluster]` for more details.
389389

390390
When ready, run the following command to apply the cluster manifest.
391391

392-
```
392+
```bash
393393
kubectl apply -f capi-quickstart.yaml
394394
```
395395

396396
The output is similar to this:
397397

398-
```
398+
```bash
399399
cluster.cluster.x-k8s.io/capi-quickstart created
400400
awscluster.infrastructure.cluster.x-k8s.io/capi-quickstart created
401401
kubeadmcontrolplane.controlplane.cluster.x-k8s.io/capi-quickstart-control-plane created
@@ -407,19 +407,34 @@ kubeadmconfigtemplate.bootstrap.cluster.x-k8s.io/capi-quickstart-md-0 created
407407

408408
#### Accessing the workload cluster
409409

410-
To verify the control plane is up, check if the control plane is ready.
410+
The cluster will now start provisioning. You check status with:
411+
412+
```bash
413+
kubectl get cluster --all-namespaces
411414
```
415+
416+
To verify the first control plane is up:
417+
418+
```bash
412419
kubectl get kubeadmcontrolplane --all-namespaces
413420
```
414421

415-
If the control plane is deployed using a control plane provider, such as
416-
[KubeadmControlPlane] ensure the control plane is
417-
ready.
418-
```
419-
kubectl get clusters --output jsonpath="{range .items[*]} [{.metadata.name} {.status.ControlPlaneInitialized} {.status.ControlPlaneReady}] {end}"
422+
You should see an output is similar to this:
423+
424+
```bash
425+
NAME READY INITIALIZED REPLICAS READY REPLICAS UPDATED REPLICAS UNAVAILABLE REPLICAS
426+
capi-quickstart-control-plane true 3 3 3
420427
```
421428

422-
After the control plane node is up and ready, we can retrieve the [workload cluster] Kubeconfig:
429+
<aside class="note warning">
430+
431+
<h1> Warning </h1>
432+
433+
The control planes won't be `Ready` until we install a CNI in the next step.
434+
435+
</aside>
436+
437+
After the first control plane node is up and running, we can retrieve the [workload cluster] Kubeconfig:
423438

424439
```bash
425440
kubectl --namespace=default get secret/capi-quickstart-kubeconfig -o jsonpath={.data.value} \
@@ -431,7 +446,6 @@ kubectl --namespace=default get secret/capi-quickstart-kubeconfig -o jsonpath={.
431446

432447
Calico is used here as an example.
433448

434-
435449
```bash
436450
kubectl --kubeconfig=./capi-quickstart.kubeconfig \
437451
apply -f https://docs.projectcalico.org/v3.12/manifests/calico.yaml

0 commit comments

Comments
 (0)