Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update version support documentation #3230

Merged
merged 1 commit into from
Feb 18, 2022
Merged

Update version support documentation #3230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 47 additions & 13 deletions docs/book/src/topics/reference/versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,62 @@
# CAPA Version Support

## Supported Versions
## Release Versioning

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

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

- Cluster API Provider for AWS
- clusterawsadm client
**Example versions:**

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

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

## Compatibility with Cluster API Versions

| | v1alpha3 (v0.3) | v1alpha4 (v0.4) | v1beta1 (v1.x) |
CAPA's versions are compatible with the following versions of Cluster API

| API Version | Cluster API v1alpha3 (v0.3) | Cluster API v1alpha4 (v0.4) |
| ---------------------------- | --------------------------- | --------------------------- |
| AWS Provider v1alpha3 (v0.6) | ✓ | |
| AWS Provider v1alpha4 (v0.7) | | ✓ |


CAPA v1beta1 versions are not released in lock-step with Cluster API releases.
Multiple CAPA minor releases can use the same Cluster API minor release.

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.

For example:
- CAPA v1.0.x, v1.1.x, v1.2.x is compatible with Cluster API v1.0.x
- CAPA v1.3.x is compatible with Cluster API v1.1.x

## End-of-Life Timeline

CAPA team maintains branches for **v1.x (v1beta1)**, **v0.7 (v1alpha4)**, and **v0.6 (v1alpha3)**.

CAPA branches follow their compatible Cluster API branch EOL date.

| API Version | Branch | Supported Until |
| ------------- |-------------|-----------------|
| **v1alpha4** | release-0.7 | 2022-04-06 |
| **v1alpha3** | release-0.6 | 2022-02-23 |

## Compatibility with Kubernetes Versions

CAPA API versions support all Kubernetes versions that is supported by its compatible Cluster API version:

| API Versions | CAPI v1alpha3 (v0.3) | CAPI v1alpha4 (v0.4) | CAPI v1beta1 (v1.x) |
| ---------------------------- | --------------- | --------------- | -------------- |
| AWS Provider v1alpha3 (v0.6) | ✓ | | |
| AWS Provider v1alpha4 (v0.7) | | ✓ | |
| AWS Provider v1beta1 (v1.x) | | | ✓ |
| CAPA v1alpha3 (v0.6) | ✓ | | |
| CAPA v1alpha4 (v0.7) | | ✓ | |
| CAPA v1beta1 (v1.x) | | | ✓ |


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

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