Skip to content

Commit a167556

Browse files
committed
clean up and simplify project README
Signed-off-by: Andrew Sy Kim <[email protected]>
1 parent 211e21f commit a167556

File tree

1 file changed

+2
-53
lines changed

1 file changed

+2
-53
lines changed

README.md

Lines changed: 2 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -19,57 +19,6 @@ You can reach the maintainers of this project at:
1919

2020
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
2121

22-
### Quick Start
22+
### Getting Started
2323

24-
Go [here](docs/README.md) for an example of how to get up and going with the cluster api using vSphere.
25-
26-
### Where to get the containers
27-
28-
The containers for this provider are currently hosted at `gcr.io/cnx-cluster-api/`. Each release of the
29-
container are tagged with the release version appropriately. Please note, the release tagging changed to
30-
stay uniform with the main cluster api repo. Also note, these are docker containers. A container runtime
31-
must pull them. They cannot simply be downloaded.
32-
33-
| vSphere provider version | container url |
34-
| --- | --- |
35-
| 0.1.0 | gcr.io/cnx-cluster-api/vsphere-cluster-api-provider:v0.1 |
36-
| 0.2.0 | gcr.io/cnx-cluster-api/vsphere-cluster-api-provider:0.2.0 |
37-
38-
| main Cluster API version | container url |
39-
| --- | --- |
40-
| 0.1.0 | gcr.io/k8s-cluster-api/cluster-api-controller:0.1.0 |
41-
42-
To use the appropriate version (instead of `:latest`), replace the version in the generated `provider-components.yaml`,
43-
described in the quick start guide.
44-
45-
### Compatibility Matrix
46-
47-
Below are tables showing the compatibility between versions of the vSphere provider, the main cluster api,
48-
kubernetes versions, and OSes. Please note, this table only shows version 0.2 of the vSphere provider. Due
49-
to the way this provider bootstrap nodes (e.g. using Ubuntu package manager to pull some components), there
50-
were changes in some packages that broke version 0.1 (but may get resolved at some point) so the compatibility
51-
tables for that provider version are not provided here.
52-
53-
Compatibility matrix for Cluster API versions and the vSphere provider versions.
54-
55-
| | Cluster API 0.1.0 |
56-
|--- | --- |
57-
| vSphere Provider 0.2.0 ||
58-
59-
Compatibility matrix for the vSphere provider versions and Kubernetes versions.
60-
61-
| |k8s 1.11.x|k8s 1.12.x|k8s 1.13.x|k8s 1.14.x|
62-
|---|---|---|---|---|
63-
| vSphere Provider 0.2.0 |||||
64-
65-
Compatibility matrix for the vSphere provider versions and node OS. Further OS support may be added in future releases.
66-
67-
| | Ubuntu Xenial Cloud Image | Ubuntu Bionic Cloud Image |
68-
| --- | --- | --- |
69-
| vSphere Provider 0.2.0 |||
70-
71-
Users may download the cloud images here:
72-
73-
[Ubuntu Xenial (16.04)](https://cloud-images.ubuntu.com/xenial/current/)
74-
75-
[Ubuntu Bionic (18.04)](https://cloud-images.ubuntu.com/bionic/current/)
24+
See the [Getting Started](docs/getting_started.md) guide to get up and going with Cluster API for vSphere.

0 commit comments

Comments
 (0)