From 0cf478ea1f0592df89c8b4da63689ad05b741bd0 Mon Sep 17 00:00:00 2001 From: Loc Nguyen Date: Mon, 25 Mar 2019 16:25:41 -0700 Subject: [PATCH] Add version support matrix against CAPI and k8s Added 3 tables showing a version compatibility matrix against CAPI (main cluster API), Kubernetes, and OSes. Currently, these were gathered manually. Resolves #222 --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c21d22c1b..002f5f0f18 100644 --- a/README.md +++ b/README.md @@ -21,4 +21,44 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of ### Quick Start -Go [here](docs/README.md) for an example of how to get up and going with the cluster api using vSphere. \ No newline at end of file +Go [here](docs/README.md) for an example of how to get up and going with the cluster api using vSphere. + +### Where to get the vSphere provider container + +The containers for this provider are currently hosted at `gcr.io/cnx-cluster-api/`. Each release of the +container are tagged with the release version appropriately. + +| release version | container url | +| --- | --- | +| 0.1 | gcr.io/cnx-cluster-api/vsphere-cluster-api-provider:v0.1 | +| 0.2 | gcr.io/cnx-cluster-api/vsphere-cluster-api-provider:0.2 | + +To use the appropriate version (instead of `:latest`), replace the version in the generated `provider-components.yaml` +described in the quick start guide. + +### Compatibility Matrix + +Below are tables showing the compatibility between versions of the vSphere provider, the main cluster api, +kubernetes versions, and OSes. Please note, this table only shows version 0.2 of the vSphere provider. Due +to the way this provider bootstrap nodes (e.g. using Ubuntu package manager to pull some components), there +were changes in some packages that broke version 0.1 (but may get resolved at some point) so the compatibility +tables for that provider version are not provided here. + +Compatibility matrix for Cluster API versions and the vSphere provider versions. + +| | Cluster API - v1alpha1 | +|--- | --- | +| vSphere Provider 0.2 | ✓ | + +Compatibility matrix for the vSphere provider versions and Kubernetes versions. + +| |k8s 1.11.x|k8s 1.12.x|k8s 1.13.x|k8s 1.14.x| +|---|---|---|---|---| +| vSphere Provider 0.2 | ✓ | ✓ | ✓ | ✓ | + +Compatibility matrix for the vSphere provider versions and node OS. Further OS support may be added in future releases. + +| | Ubuntu Xenial Cloud Image | Ubuntu Bionic Cloud Image | +| --- | --- | --- | +| vSphere Provider 0.2 | ✓ | ✓ | +