-
Notifications
You must be signed in to change notification settings - Fork 579
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3199 from sedefsavas/somedocs
Add list of Prow jobs to the book
- Loading branch information
Showing
8 changed files
with
120 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {{#include ../../../../../CONTRIBUTING.md}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Glossary | ||
|
|
||
| {{#embed-github repo:"kubernetes-sigs/cluster-api"path:"docs/book/src/reference/glossary.md"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Reference |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |