Skip to content

Commit 1420004

Browse files
authoredDec 19, 2019
Merge pull request #702 from akutz/feature/r5-docs
Update getting started doc to use release-0.5
2 parents d233b2f + 8296d2e commit 1420004

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed
 

‎docs/getting_started.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
This is a guide on how to get started with CAPV (Cluster API Provider vSphere). To learn more about cluster API in more depth, check out the the [cluster api docs page](https://cluster-api.sigs.k8s.io/).
44

5-
- [Getting Started](#getting-started)
6-
- [Bootstrapping a Management Cluster with clusterctl](#bootstrapping-a-management-cluster-with-clusterctl)
7-
- [Install Requirements](#install-requirements)
8-
- [clusterctl](#clusterctl)
9-
- [Docker](#docker)
10-
- [Kind](#kind)
11-
- [kubectl](#kubectl)
12-
- [vSphere Requirements](#vsphere-requirements)
13-
- [vCenter Credentials](#vcenter-credentials)
14-
- [Uploading the CAPV Machine Image](#uploading-the-capv-machine-image)
15-
- [Generating YAML for the Bootstrap Cluster](#generating-yaml-for-the-bootstrap-cluster)
16-
- [Using clusterctl](#using-clusterctl)
17-
- [Managing Workload Clusters using the Management Cluster](#managing-workload-clusters-using-the-management-cluster)
5+
* [Getting Started](#getting-started)
6+
* [Bootstrapping a Management Cluster with clusterctl](#bootstrapping-a-management-cluster-with-clusterctl)
7+
* [Install Requirements](#install-requirements)
8+
* [clusterctl](#clusterctl)
9+
* [Docker](#docker)
10+
* [Kind](#kind)
11+
* [kubectl](#kubectl)
12+
* [vSphere Requirements](#vsphere-requirements)
13+
* [vCenter Credentials](#vcenter-credentials)
14+
* [Uploading the CAPV Machine Image](#uploading-the-capv-machine-image)
15+
* [Generating YAML for the Bootstrap Cluster](#generating-yaml-for-the-bootstrap-cluster)
16+
* [Using clusterctl](#using-clusterctl)
17+
* [Managing Workload Clusters using the Management Cluster](#managing-workload-clusters-using-the-management-cluster)
1818

1919
## Bootstrapping a Management Cluster with clusterctl
2020

@@ -99,15 +99,15 @@ EOF
9999

100100
With the above environment variable file it is now possible to generate the manifests needed to bootstrap the management cluster. The following command uses Docker to run an image that has all of the necessary templates and tools to generate the YAML manifests. Additionally, the `envvars.txt` file created above is mounted inside the the image in order to provide the generation routine with its default values.
101101

102-
**Note** It's important to ensure you are leveraging an up to date version of the manifests container image below. Problems with this typically manifest themselves on workstations that have tested previous versions of CAPV. You can delete your existing manifest image by using ```docker rmi gcr.io/cluster-api-provider-vsphere/release/manifests``` or change the below command to use a specific manifest image version (i.e. `release/manifests:0.5.2-beta.0`)
102+
**Note** It's important to ensure you are leveraging an up to date version of the manifests container image below. Problems with this typically manifest themselves on workstations that have tested previous versions of CAPV. You can delete your existing manifest image by using ```docker rmi gcr.io/cluster-api-provider-vsphere/release/manifests``` or change the below command to use a specific manifest image version (i.e. `release/manifests:v0.5.4`)
103103

104104
You can issue the below command to generate the required manifest files.
105105

106106
```shell
107107
$ docker run --rm \
108108
-v "$(pwd)":/out \
109109
-v "$(pwd)/envvars.txt":/envvars.txt:ro \
110-
gcr.io/cluster-api-provider-vsphere/release/manifests:latest \
110+
gcr.io/cluster-api-provider-vsphere/release/manifests:v0.5.4 \
111111
-c management-cluster
112112

113113
Generated ./out/management-cluster/cluster.yaml
@@ -149,7 +149,7 @@ Using the same Docker command as above, generate resources for a new cluster, th
149149
$ docker run --rm \
150150
-v "$(pwd)":/out \
151151
-v "$(pwd)/envvars.txt":/envvars.txt:ro \
152-
gcr.io/cluster-api-provider-vsphere/release/manifests:latest \
152+
gcr.io/cluster-api-provider-vsphere/release/manifests:v0.5.4 \
153153
-c workload-cluster-1
154154
```
155155

0 commit comments

Comments
 (0)
Please sign in to comment.