From 6a1120652caedb63e575ad8dba8b5df41cc4c650 Mon Sep 17 00:00:00 2001 From: Sedef Savas Date: Wed, 15 Dec 2021 07:21:14 -0800 Subject: [PATCH] Update version support docs. Add list of jobs to the book. --- README.md | 26 ++----- docs/book/src/SUMMARY_SUFFIX.md | 6 ++ .../book/src/topics/reference/contributing.md | 1 + docs/book/src/topics/reference/glossary.md | 3 + docs/book/src/topics/reference/jobs.md | 67 +++++++++++++++++++ docs/book/src/topics/reference/ports.md | 8 +++ docs/book/src/topics/reference/reference.md | 1 + docs/book/src/topics/reference/versions.md | 28 ++++++++ 8 files changed, 120 insertions(+), 20 deletions(-) create mode 100644 docs/book/src/topics/reference/contributing.md create mode 100644 docs/book/src/topics/reference/glossary.md create mode 100644 docs/book/src/topics/reference/jobs.md create mode 100644 docs/book/src/topics/reference/ports.md create mode 100644 docs/book/src/topics/reference/reference.md create mode 100644 docs/book/src/topics/reference/versions.md diff --git a/README.md b/README.md index 32216751cd..ab5f2f6e8a 100644 --- a/README.md +++ b/README.md @@ -50,32 +50,17 @@ cluster on AWS. ## Compatibility with Cluster API and Kubernetes Versions -This provider's versions are compatible with the following versions of Cluster API: +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: - -| | v1alpha3 (v0.3) | v1alpha4 (v0.4) | v1beta1 (v1.0) | +| | v1alpha3 (v0.3) | v1alpha4 (v0.4) | v1beta1 (v1.x) | | ---------------------------- | --------------- | --------------- | -------------- | -| AWS Provider v1alpha3 (v0.5) | ✓ | | | | AWS Provider v1alpha3 (v0.6) | ✓ | | | | AWS Provider v1alpha4 (v0.7) | | ✓ | | -| AWS Provider v1beta1 (v1.0) | | | ✓ | - - -This provider's versions are able to install and manage the following versions of Kubernetes: - -| | v1.16 | v 1.17 | v1.18 | v1.19 | v1.20 | v1.21 | v1.22 | -| ---------------------------- | ----- | ------ | ----- | ----- | ----- | ----- | ----- | -| AWS Provider v1alpha3 (v0.5) | ✓ | ✓ | ✓ | ✓ | ✓ | | | -| AWS Provider v1alpha3 (v0.6) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓* | -| AWS Provider v1alpha4 (v0.7) | | | ✓* | ✓ | ✓ | ✓ | ✓ | -| AWS Provider v1beta1 (v1.0) | | | | ✓ | ✓ | ✓ | ✓ | - -\* Not management clusters +| AWS Provider v1beta1 (v1.x) | | | ✓ | -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. -**NOTE:** As the versioning for this project is tied to the versioning of Cluster API, future modifications to this -policy may be made to more closely align with other providers in the Cluster API ecosystem. +(See [Kubernetes support matrix][cluster-api-supported-v] of Cluster API versions). ------ @@ -220,3 +205,4 @@ All the CAPA contributors: [amis]: https://cluster-api-aws.sigs.k8s.io/topics/images/amis.html [published_amis]: https://cluster-api-aws.sigs.k8s.io/topics/images/built-amis.html [eks_support]: https://cluster-api-aws.sigs.k8s.io/topics/eks/index.html +[cluster-api-supported-v]: https://cluster-api.sigs.k8s.io/reference/versions.html diff --git a/docs/book/src/SUMMARY_SUFFIX.md b/docs/book/src/SUMMARY_SUFFIX.md index ea73433684..8d5ecc700a 100644 --- a/docs/book/src/SUMMARY_SUFFIX.md +++ b/docs/book/src/SUMMARY_SUFFIX.md @@ -2,4 +2,10 @@ - [Development with Tilt](./development/tilt-setup.md) - [Coding Conventions](./development/conventions.md) - [CRD Reference](./crd/index.md) +- [Reference](./topics/reference/reference.md) + - [Glossary](./topics/reference/glossary.md) + - [Ports](./topics/reference/ports.md) + - [Jobs](./topics/reference/jobs.md) + - [Version Support](./topics/reference/versions.md) + - [Contributing](./topics/reference/contributing.md) - [Roadmap](./roadmap.md) diff --git a/docs/book/src/topics/reference/contributing.md b/docs/book/src/topics/reference/contributing.md new file mode 100644 index 0000000000..aa4408bf2e --- /dev/null +++ b/docs/book/src/topics/reference/contributing.md @@ -0,0 +1 @@ +{{#include ../../../../../CONTRIBUTING.md}} diff --git a/docs/book/src/topics/reference/glossary.md b/docs/book/src/topics/reference/glossary.md new file mode 100644 index 0000000000..f30358b9e8 --- /dev/null +++ b/docs/book/src/topics/reference/glossary.md @@ -0,0 +1,3 @@ +# Glossary + +{{#embed-github repo:"kubernetes-sigs/cluster-api"path:"docs/book/src/reference/glossary.md"}} diff --git a/docs/book/src/topics/reference/jobs.md b/docs/book/src/topics/reference/jobs.md new file mode 100644 index 0000000000..9c28b14e07 --- /dev/null +++ b/docs/book/src/topics/reference/jobs.md @@ -0,0 +1,67 @@ +# Jobs + +This document intends to provide an overview over our jobs running via Prow, GitHub actions and Google Cloud Build. + +## Builds and Tests running on the main branch + +> 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]. + +### Presubmits + +Prow Presubmits: + +* [pull-cluster-api-provider-aws-test] `./scripts/ci-test.sh` +* [pull-cluster-api-provider-aws-build] `./scripts/ci-build.sh` +* [pull-cluster-api-provider-aws-verify] `make verify` +* [pull-cluster-api-provider-aws-e2e-conformance] `./scripts/ci-conformance.sh` +* [pull-cluster-api-provider-aws-e2e-conformance-with-ci-artifacts] `./scripts/ci-conformance.sh` + * E2E_ARGS: `-kubetest.use-ci-artifacts` +* [pull-cluster-api-provider-aws-e2e-blocking] `./scripts/ci-e2e.sh` + * E2E_FOCUS: `[PR-Blocking]` +* [pull-cluster-api-provider-aws-e2e] `./scripts/ci-e2e.sh` +* [pull-cluster-api-provider-aws-e2e-eks] `./scripts/ci-e2e-eks.sh` + +[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= +[pull-cluster-api-provider-aws-e2e]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-e2e-main&show-stale-tests= +[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= +[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= +[pull-cluster-api-provider-aws-e2e-conformance]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-conformance&show-stale-tests= +[pull-cluster-api-provider-aws-verify]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-verify&show-stale-tests= +[pull-cluster-api-provider-aws-test]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-test&show-stale-tests= +[pull-cluster-api-provider-aws-build]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#pr-build&show-stale-tests= + +### Postsubmits + +Prow Postsubmits: + +* [ci-cluster-api-provider-aws-e2e] `./scripts/ci-e2e.sh` +* [ci-cluster-api-provider-aws-eks-e2e] `./scripts/ci-e2e-eks.sh` +* [ci-cluster-api-provider-aws-e2e-conformance] `./scripts/ci-conformance.sh` + +[ci-cluster-api-provider-aws-e2e-conformance]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#postsubmit-conformance-main&show-stale-tests= +[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= +[ci-cluster-api-provider-aws-e2e]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#postsubmit-e2e-main&show-stale-tests= + +* [post-cluster-api-provider-aws-push-images] Google Cloud Build: `make release-staging` + +[post-cluster-api-provider-aws-push-images]: https://testgrid.k8s.io/sig-cluster-lifecycle-image-pushes#post-cluster-api-provider-aws-push-images + +### Periodics + +Prow Periodics: +* [periodic-cluster-api-provider-aws-e2e] `./scripts/ci-e2e.sh` +* [periodic-cluster-api-provider-aws-eks-e2e] `/scripts/ci-e2e-eks.sh` +* [periodic-cluster-api-provider-aws-e2e-conformance] `./scripts/ci-conformance.sh` +* [periodic-cluster-api-provider-aws-e2e-conformance-with-k8s-ci-artifacts] `./scripts/ci-conformance.sh` + * E2E_ARGS: `-kubetest.use-ci-artifacts` +* [periodic-cluster-api-provider-aws-coverage] `./scripts/ci-test-coverage.sh` + +[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 +[periodic-cluster-api-provider-aws-coverage]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#periodic-test-coverage +[periodic-cluster-api-provider-aws-e2e-conformance]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#periodic-conformance-main +[periodic-cluster-api-provider-aws-eks-e2e]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#periodic-eks-e2e-main +[periodic-cluster-api-provider-aws-e2e]: https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-aws#periodic-e2e-main + +* [cluster-api-provider-aws-push-images-nightly] Google Cloud Build: `make release-staging-nightly` + +[cluster-api-provider-aws-push-images-nightly]: https://testgrid.k8s.io/sig-cluster-lifecycle-image-pushes#cluster-api-provider-aws-push-images-nightly diff --git a/docs/book/src/topics/reference/ports.md b/docs/book/src/topics/reference/ports.md new file mode 100644 index 0000000000..74361c1523 --- /dev/null +++ b/docs/book/src/topics/reference/ports.md @@ -0,0 +1,8 @@ +# Ports used by CAPA + +Name | Port Number | Description | +--- | --- | --- +`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` +`webhook` | `9443` | Webhook server port. To disable this set `--webhook-port` flag to `0`. +`health` | `9440` | Port that exposes the health endpoint. This can be customized by setting the `--health-addr` flag when starting the manager. +`profiler`| | Expose the pprof profiler. By default is not configured. Can set the `--profiler-address` flag. e.g. `--profiler-address 6060` diff --git a/docs/book/src/topics/reference/reference.md b/docs/book/src/topics/reference/reference.md new file mode 100644 index 0000000000..cf5aa07416 --- /dev/null +++ b/docs/book/src/topics/reference/reference.md @@ -0,0 +1 @@ +# Reference diff --git a/docs/book/src/topics/reference/versions.md b/docs/book/src/topics/reference/versions.md new file mode 100644 index 0000000000..dd5fb5ca0e --- /dev/null +++ b/docs/book/src/topics/reference/versions.md @@ -0,0 +1,28 @@ +# CAPA Version Support + +## Supported Versions + +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. + +Releases include these components: + +- Cluster API Provider for AWS +- clusterawsadm client + +## Compatibility with Cluster API and Kubernetes Versions + +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: + + +| | v1alpha3 (v0.3) | v1alpha4 (v0.4) | v1beta1 (v1.x) | +| ---------------------------- | --------------- | --------------- | -------------- | +| AWS Provider v1alpha3 (v0.6) | ✓ | | | +| AWS Provider v1alpha4 (v0.7) | | ✓ | | +| AWS Provider 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