Skip to content

Commit 6a11206

Browse files
committed
Update version support docs.
Add list of jobs to the book.
1 parent 8f04b85 commit 6a11206

File tree

8 files changed

+120
-20
lines changed

8 files changed

+120
-20
lines changed

README.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -50,32 +50,17 @@ cluster on AWS.
5050

5151
## Compatibility with Cluster API and Kubernetes Versions
5252

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

55-
56-
| | v1alpha3 (v0.3) | v1alpha4 (v0.4) | v1beta1 (v1.0) |
56+
| | v1alpha3 (v0.3) | v1alpha4 (v0.4) | v1beta1 (v1.x) |
5757
| ---------------------------- | --------------- | --------------- | -------------- |
58-
| AWS Provider v1alpha3 (v0.5) || | |
5958
| AWS Provider v1alpha3 (v0.6) || | |
6059
| AWS Provider v1alpha4 (v0.7) | || |
61-
| AWS Provider v1beta1 (v1.0) | | ||
62-
63-
64-
This provider's versions are able to install and manage the following versions of Kubernetes:
65-
66-
| | v1.16 | v 1.17 | v1.18 | v1.19 | v1.20 | v1.21 | v1.22 |
67-
| ---------------------------- | ----- | ------ | ----- | ----- | ----- | ----- | ----- |
68-
| AWS Provider v1alpha3 (v0.5) |||||| | |
69-
| AWS Provider v1alpha3 (v0.6) |||||||* |
70-
| AWS Provider v1alpha4 (v0.7) | | |* |||||
71-
| AWS Provider v1beta1 (v1.0) | | | |||||
72-
73-
\* Not management clusters
60+
| AWS Provider v1beta1 (v1.x) | | ||
7461

75-
Each version of Cluster API for AWS will attempt to support two Kubernetes versions; e.g., Cluster API for AWS `v0.3` supports Kubernetes 1.16, 1.17, 1.18 etc.
7662

77-
**NOTE:** As the versioning for this project is tied to the versioning of Cluster API, future modifications to this
78-
policy may be made to more closely align with other providers in the Cluster API ecosystem.
63+
(See [Kubernetes support matrix][cluster-api-supported-v] of Cluster API versions).
7964

8065
------
8166

@@ -220,3 +205,4 @@ All the CAPA contributors:
220205
[amis]: https://cluster-api-aws.sigs.k8s.io/topics/images/amis.html
221206
[published_amis]: https://cluster-api-aws.sigs.k8s.io/topics/images/built-amis.html
222207
[eks_support]: https://cluster-api-aws.sigs.k8s.io/topics/eks/index.html
208+
[cluster-api-supported-v]: https://cluster-api.sigs.k8s.io/reference/versions.html

docs/book/src/SUMMARY_SUFFIX.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,10 @@
22
- [Development with Tilt](./development/tilt-setup.md)
33
- [Coding Conventions](./development/conventions.md)
44
- [CRD Reference](./crd/index.md)
5+
- [Reference](./topics/reference/reference.md)
6+
- [Glossary](./topics/reference/glossary.md)
7+
- [Ports](./topics/reference/ports.md)
8+
- [Jobs](./topics/reference/jobs.md)
9+
- [Version Support](./topics/reference/versions.md)
10+
- [Contributing](./topics/reference/contributing.md)
511
- [Roadmap](./roadmap.md)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{#include ../../../../../CONTRIBUTING.md}}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Glossary
2+
3+
{{#embed-github repo:"kubernetes-sigs/cluster-api"path:"docs/book/src/reference/glossary.md"}}
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Jobs
2+
3+
This document intends to provide an overview over our jobs running via Prow, GitHub actions and Google Cloud Build.
4+
5+
## Builds and Tests running on the main branch
6+
7+
> NOTE: To see which test jobs execute which tests or e2e tests, you can click on the links which lead to the respective test overviews in [test-grid].
8+
9+
### Presubmits
10+
11+
Prow Presubmits:
12+
13+
* [pull-cluster-api-provider-aws-test] `./scripts/ci-test.sh`
14+
* [pull-cluster-api-provider-aws-build] `./scripts/ci-build.sh`
15+
* [pull-cluster-api-provider-aws-verify] `make verify`
16+
* [pull-cluster-api-provider-aws-e2e-conformance] `./scripts/ci-conformance.sh`
17+
* [pull-cluster-api-provider-aws-e2e-conformance-with-ci-artifacts] `./scripts/ci-conformance.sh`
18+
* E2E_ARGS: `-kubetest.use-ci-artifacts`
19+
* [pull-cluster-api-provider-aws-e2e-blocking] `./scripts/ci-e2e.sh`
20+
* E2E_FOCUS: `[PR-Blocking]`
21+
* [pull-cluster-api-provider-aws-e2e] `./scripts/ci-e2e.sh`
22+
* [pull-cluster-api-provider-aws-e2e-eks] `./scripts/ci-e2e-eks.sh`
23+
24+
[pull-cluster-api-provider-aws-e2e-eks]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-e2e-eks-main&show-stale-tests=
25+
[pull-cluster-api-provider-aws-e2e]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-e2e-main&show-stale-tests=
26+
[pull-cluster-api-provider-aws-e2e-blocking]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-quick-e2e-main&show-stale-tests=
27+
[pull-cluster-api-provider-aws-e2e-conformance-with-ci-artifacts]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-conformance-main-k8s-main&show-stale-tests=
28+
[pull-cluster-api-provider-aws-e2e-conformance]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-conformance&show-stale-tests=
29+
[pull-cluster-api-provider-aws-verify]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-verify&show-stale-tests=
30+
[pull-cluster-api-provider-aws-test]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-test&show-stale-tests=
31+
[pull-cluster-api-provider-aws-build]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-build&show-stale-tests=
32+
33+
### Postsubmits
34+
35+
Prow Postsubmits:
36+
37+
* [ci-cluster-api-provider-aws-e2e] `./scripts/ci-e2e.sh`
38+
* [ci-cluster-api-provider-aws-eks-e2e] `./scripts/ci-e2e-eks.sh`
39+
* [ci-cluster-api-provider-aws-e2e-conformance] `./scripts/ci-conformance.sh`
40+
41+
[ci-cluster-api-provider-aws-e2e-conformance]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#postsubmit-conformance-main&show-stale-tests=
42+
[ci-cluster-api-provider-aws-eks-e2e]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#postsubmit-eks-e2e-main&show-stale-tests=
43+
[ci-cluster-api-provider-aws-e2e]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#postsubmit-e2e-main&show-stale-tests=
44+
45+
* [post-cluster-api-provider-aws-push-images] Google Cloud Build: `make release-staging`
46+
47+
[post-cluster-api-provider-aws-push-images]: https://testgrid.k8s.io/sig-cluster-lifecycle-image-pushes#post-cluster-api-provider-aws-push-images
48+
49+
### Periodics
50+
51+
Prow Periodics:
52+
* [periodic-cluster-api-provider-aws-e2e] `./scripts/ci-e2e.sh`
53+
* [periodic-cluster-api-provider-aws-eks-e2e] `/scripts/ci-e2e-eks.sh`
54+
* [periodic-cluster-api-provider-aws-e2e-conformance] `./scripts/ci-conformance.sh`
55+
* [periodic-cluster-api-provider-aws-e2e-conformance-with-k8s-ci-artifacts] `./scripts/ci-conformance.sh`
56+
* E2E_ARGS: `-kubetest.use-ci-artifacts`
57+
* [periodic-cluster-api-provider-aws-coverage] `./scripts/ci-test-coverage.sh`
58+
59+
[periodic-cluster-api-provider-aws-e2e-conformance-with-k8s-ci-artifacts]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#periodic-conformance-main-k8s-main
60+
[periodic-cluster-api-provider-aws-coverage]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#periodic-test-coverage
61+
[periodic-cluster-api-provider-aws-e2e-conformance]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#periodic-conformance-main
62+
[periodic-cluster-api-provider-aws-eks-e2e]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#periodic-eks-e2e-main
63+
[periodic-cluster-api-provider-aws-e2e]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#periodic-e2e-main
64+
65+
* [cluster-api-provider-aws-push-images-nightly] Google Cloud Build: `make release-staging-nightly`
66+
67+
[cluster-api-provider-aws-push-images-nightly]: https://testgrid.k8s.io/sig-cluster-lifecycle-image-pushes#cluster-api-provider-aws-push-images-nightly
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Ports used by CAPA
2+
3+
Name | Port Number | Description |
4+
--- | --- | ---
5+
`metrics` | | Port that exposes the metrics. This can be customized by setting the `--metrics-bind-addr` flag when starting the manager. The default is to only listen on `localhost:8080`
6+
`webhook` | `9443` | Webhook server port. To disable this set `--webhook-port` flag to `0`.
7+
`health` | `9440` | Port that exposes the health endpoint. This can be customized by setting the `--health-addr` flag when starting the manager.
8+
`profiler`| | Expose the pprof profiler. By default is not configured. Can set the `--profiler-address` flag. e.g. `--profiler-address 6060`
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Reference
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# CAPA Version Support
2+
3+
## Supported Versions
4+
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.
7+
8+
Releases include these components:
9+
10+
- Cluster API Provider for AWS
11+
- clusterawsadm client
12+
13+
## Compatibility with Cluster API and Kubernetes Versions
14+
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:
17+
18+
19+
| | v1alpha3 (v0.3) | v1alpha4 (v0.4) | v1beta1 (v1.x) |
20+
| ---------------------------- | --------------- | --------------- | -------------- |
21+
| AWS Provider v1alpha3 (v0.6) || | |
22+
| AWS Provider v1alpha4 (v0.7) | || |
23+
| AWS Provider v1beta1 (v1.x) | | ||
24+
25+
26+
(See [Kubernetes support matrix][cluster-api-supported-v] of Cluster API versions).
27+
28+
[cluster-api-supported-v]: https://cluster-api.sigs.k8s.io/reference/versions.html

0 commit comments

Comments
 (0)