Skip to content

Commit 6513bec

Browse files
authored
Merge pull request #3230 from sedefsavas/EOL
Update version support documentation
2 parents da25e4b + 2b54254 commit 6513bec

File tree

1 file changed

+47
-13
lines changed

1 file changed

+47
-13
lines changed
Lines changed: 47 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,62 @@
11
# CAPA Version Support
22

3-
## Supported Versions
3+
## Release Versioning
44

5-
The Cluster API Provider AWS team maintains branches for **v1.x (v1beta1)**, **v0.7 (v1alpha4)**, and **v0.6 (v1alpha3)**.
6-
These branches end of support follows their compatible Cluster API branch support.
5+
CAPA follows the [semantic versionining][semver] specification:
76

8-
Releases include these components:
7+
MAJOR version release for incompatible API changes,
8+
MINOR version release for backwards compatible feature additions,
9+
and PATCH version release for only bug fixes.
910

10-
- Cluster API Provider for AWS
11-
- clusterawsadm client
11+
**Example versions:**
1212

13-
## Compatibility with Cluster API and Kubernetes Versions
13+
- Minor release: `v0.1.0`
14+
- Patch release: `v0.1.1`
15+
- Major release: `v1.0.0`
1416

15-
This provider's versions are compatible with the following versions of Cluster API
16-
and support all Kubernetes versions that is supported by its compatible Cluster API version:
1717

18+
## Compatibility with Cluster API Versions
1819

19-
| | v1alpha3 (v0.3) | v1alpha4 (v0.4) | v1beta1 (v1.x) |
20+
CAPA's versions are compatible with the following versions of Cluster API
21+
22+
| API Version | Cluster API v1alpha3 (v0.3) | Cluster API v1alpha4 (v0.4) |
23+
| ---------------------------- | --------------------------- | --------------------------- |
24+
| AWS Provider v1alpha3 (v0.6) || |
25+
| AWS Provider v1alpha4 (v0.7) | ||
26+
27+
28+
CAPA v1beta1 versions are not released in lock-step with Cluster API releases.
29+
Multiple CAPA minor releases can use the same Cluster API minor release.
30+
31+
For compatibility, check the release notes [here](https://github.com/kubernetes-sigs/cluster-api-provider-aws/releases/) to see which v1beta1 Cluster API version each CAPA version is compatible with.
32+
33+
For example:
34+
- CAPA v1.0.x, v1.1.x, v1.2.x is compatible with Cluster API v1.0.x
35+
- CAPA v1.3.x is compatible with Cluster API v1.1.x
36+
37+
## End-of-Life Timeline
38+
39+
CAPA team maintains branches for **v1.x (v1beta1)**, **v0.7 (v1alpha4)**, and **v0.6 (v1alpha3)**.
40+
41+
CAPA branches follow their compatible Cluster API branch EOL date.
42+
43+
| API Version | Branch | Supported Until |
44+
| ------------- |-------------|-----------------|
45+
| **v1alpha4** | release-0.7 | 2022-04-06 |
46+
| **v1alpha3** | release-0.6 | 2022-02-23 |
47+
48+
## Compatibility with Kubernetes Versions
49+
50+
CAPA API versions support all Kubernetes versions that is supported by its compatible Cluster API version:
51+
52+
| API Versions | CAPI v1alpha3 (v0.3) | CAPI v1alpha4 (v0.4) | CAPI v1beta1 (v1.x) |
2053
| ---------------------------- | --------------- | --------------- | -------------- |
21-
| AWS Provider v1alpha3 (v0.6) || | |
22-
| AWS Provider v1alpha4 (v0.7) | || |
23-
| AWS Provider v1beta1 (v1.x) | | ||
54+
| CAPA v1alpha3 (v0.6) || | |
55+
| CAPA v1alpha4 (v0.7) | || |
56+
| CAPA v1beta1 (v1.x) | | ||
2457

2558

2659
(See [Kubernetes support matrix][cluster-api-supported-v] of Cluster API versions).
2760

2861
[cluster-api-supported-v]: https://cluster-api.sigs.k8s.io/reference/versions.html
62+
[semver]: https://semver.org/#semantic-versioning-200

0 commit comments

Comments
 (0)