Skip to content

Commit e91bc41

Browse files
Address feedback
1 parent 9550758 commit e91bc41

File tree

1 file changed

+32
-13
lines changed

1 file changed

+32
-13
lines changed

README.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,17 @@ Check out the [getting started guide](./docs/getting_started.md) for launching a
3232
# CAPV release support
3333

3434
A Cluster API provider vSphere release correspond to a release in the GitHub repository for this project, and the corresponding images published in the Kubernetes docker registry.
35-
The CAPV release calendar will be aligned as much as possible to the Kubernetes and the Cluster API release release dates plus an offset for
35+
The CAPV release calendar will be aligned as much as possible to the Kubernetes and the Cluster API release dates plus an offset for
3636
performing test/validation after K8s/CAPI release are available (tentatively one or two weeks after both K8s and CAPI release are available).
3737

3838
The CAPV team actively supports the latest two minor releases (N, N-1); support in this context means that we:
3939

4040
- Have CI signal with E2E tests, unit tests, CVE scans etc.
4141
- Accept bug fixes, perform golang or dependency bumps, etc.
42-
- Periodically cut patch releases
42+
- Cut patch releases when necessary.
4343
- On top of supporting the N and N-1 releases, the CAPV team also maintains CI signal for the CAPV N-2 releases in case we have to do an emergency patch release.
4444

45-
If there is a need for an emergency patch, e.g. to fix a critical security issue, please bring this up to maintainers and it will be considered on a case-by-case basis.
45+
If there is a need for an patch or an emergency patch, e.g. to fix a critical security issue, please bring this up to maintainers and it will be considered on a case-by-case basis.
4646

4747
All considered, each CAPV minor release is supported for a period of roughly 12 months:
4848

@@ -61,11 +61,26 @@ The table below documents support matrix for Cluster API provider vSphere versio
6161
| v1.10.x | EOL | EOL since v1.13.0 release date |
6262
| v1.9.x | EOL | EOL since v1.12.0 release date |
6363

64-
## Compatibility with Cluster API and Kubernetes Versions
64+
## Compatibility with Cluster API
6565

66-
Compatibility between CAPV releases and Cluster API depends on which Cluster API contract versions supported by CAPI and by which contract version is implemented in CAPV.
66+
Only a limited set of combinations between releases of CAPV and Cluster API are tested on CI and thus actively
67+
supported:
6768

68-
CAPV implements following Cluster API contract versions:
69+
| CAPV version | CAPI version used in CI |
70+
|--------------|:-----------------------:|
71+
| CAPV v1.12 | CAPI v1.9 |
72+
| CAPV v1.13 | CAPI v1.10 |
73+
| CAPV v1.14 | CAPI v1.11 |
74+
75+
Other CAPV/CAPI version combinations might work, but it is up to the users to validate those combinations;
76+
also please be aware that in case of a CAPI/CAPV combination not listed above, support will be provided at best effort.
77+
78+
Following info should be used when identifying possible CAPV/CAPI version combinations outside the table above:
79+
80+
Compatibility between CAPV and Cluster API depends on which Cluster API contract versions is supported by CAPI and by
81+
which contract version is implemented in CAPV.
82+
83+
The following table documents the Cluster API contract versions implemented by supported CAPV versions:
6984

7085
| | Cluster API contract version v1beta1 | Cluster API contract version v1beta1 |
7186
|------------|:------------------------------------:|:------------------------------------:|
@@ -75,14 +90,18 @@ CAPV implements following Cluster API contract versions:
7590

7691
Contract versions supported by Cluster API are documented in the [versions](https://cluster-api.sigs.k8s.io/reference/versions#cluster-api-release-vs-contract-versions) page in the [Cluster API book](https://cluster-api.sigs.k8s.io).
7792

78-
Also, please note that this project is not validating all the permutations between Cluster API versions and CAPV versions;
79-
below you can find the combinations that are tested in CI:
93+
Additionally, each version of CAPV requires a specific API version to served by Cluster API, and this
94+
further reduces the number of valid combinations.
8095

81-
| CAPV version | CAPI version used in CI |
82-
|--------------|:-----------------------:|
83-
| CAPV v1.12 | CAPI v1.9 |
84-
| CAPV v1.13 | CAPI v1.10 |
85-
| CAPV v1.14 | CAPI v1.11 |
96+
The table below documents CAPI API version required by supported CAPV versions.
97+
98+
| CAPV version | Requires CAPI API version |
99+
|--------------|:-------------------------:|
100+
| CAPV v1.12 | v1beta1 |
101+
| CAPV v1.13 | v1beta1 |
102+
| CAPV v1.14 | v1beta2 |
103+
104+
API versions supported by Cluster API are documented in the [versions](https://cluster-api.sigs.k8s.io/reference/versions#cluster-api-release-vs-api-versions) page in the [Cluster API book](https://cluster-api.sigs.k8s.io).
86105

87106
## Compatibility with Kubernetes Versions
88107

0 commit comments

Comments
 (0)