From 0da2cc88eebf0c88c4954f72f90772ba0209b183 Mon Sep 17 00:00:00 2001 From: Muhammad Adil Ghaffar Date: Thu, 9 Jan 2025 12:21:10 +0200 Subject: [PATCH] Updating docs for release 1.9 Signed-off-by: Muhammad Adil Ghaffar --- CONTRIBUTING.md | 6 +++-- README.md | 69 +++++++++++++++++++++++++----------------------- docs/e2e-test.md | 41 ++++++++++++++-------------- 3 files changed, 61 insertions(+), 55 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5fee5b4df7..43efc3e30e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -171,8 +171,10 @@ is defined above. | Minor Release | API Version | Supported Until | | ------------- | ------------ | -------------------------------------------- | -| v1.7.x | **v1beta1** | when v1.9.0 will be released | -| v1.6.x | **v1beta1** | when v1.8.0 will be released | +| v1.9.x | **v1beta1** | when v1.11.0 will be released | +| v1.8.x | **v1beta1** | when v1.10.0 will be released | +| v1.7.x | **v1beta1** | EOL since 2024-12-19 | +| v1.6.x | **v1beta1** | EOL since 2024-09-04 | | v1.5.x | **v1beta1** | EOL since 2024-04-18 | | v1.4.x | **v1beta1** | EOL since 2024-01-10 | | v1.3.x | **v1beta1** | EOL since 2023-09-27 | diff --git a/README.md b/README.md index 980bf9c31b..a95b1ea148 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ Metal3. | v1beta1 | v1beta1 | v1.6.X |  v1.6.X        | | v1beta1 | v1beta1 | v1.7.X |  v1.7.X        | | v1beta1 | v1beta1 | v1.8.X |  v1.8.X        | +| v1beta1 | v1beta1 | v1.9.X |  v1.9.X        | ## Deploying the metal3 provider @@ -66,7 +67,7 @@ need to be manually installed. Example flow of installing Metal3 provider: provider name as follows: ```shell - clusterctl init --infrastructure metal3:v1.8.0 + clusterctl init --infrastructure metal3:v1.9.0 ``` 1. Deploy Baremetal Operator manifests and CRDs. You need to install @@ -144,6 +145,13 @@ To trigger e2e test on a PR, use the following phrases: - **/test-centos-e2e-integration-test-main** runs integration e2e tests with CAPM3 API version v1beta1 and branch main on CentOS +Release-1.9 branch: + +- **/test metal3-ubuntu-e2e-integration-test-release-1-9** runs integration e2e + tests with CAPM3 API version v1beta1 and branch release-1.9 on Ubuntu +- **/test metal3-centos-e2e-integration-test-release-1-9** runs integration e2e + tests with CAPM3 API version v1beta1 and branch release-1.9 on CentOS + Release-1.8 branch: - **/test metal3-ubuntu-e2e-integration-test-release-1-8** runs integration e2e @@ -158,13 +166,6 @@ Release-1.7 branch: - **/test metal3-centos-e2e-integration-test-release-1-7** runs integration e2e tests with CAPM3 API version v1beta1 and branch release-1.7 on CentOS -Release-1.6 branch: - -- **/test metal3-ubuntu-e2e-integration-test-release-1-6** runs integration e2e - tests with CAPM3 API version v1beta1 and branch release-1.6 on Ubuntu -- **/test metal3-centos-e2e-integration-test-release-1-6** runs integration e2e - tests with CAPM3 API version v1beta1 and branch release-1.6 on CentOS - ## Basic tests Unlike integration tests, basic tests focus on the target cluster creation @@ -172,6 +173,8 @@ without involving pivoting from the bootstrap cluster. To run basic tests use: - **/test metal3-ubuntu-e2e-basic-test-main** runs basic e2e tests with main branch on Ubuntu +- **/test metal3-centos-e2e-basic-test-release-1-9** runs basic e2e tests on + release-1.9 branch with centos - **/test metal3-centos-e2e-basic-test-release-1-8** runs basic e2e tests on release-1.8 branch with centos @@ -192,6 +195,27 @@ feature tests with CAPM3 API version v1beta1 and branch main on Ubuntu - **/test metal3-centos-e2e-feature-test-main-features** runs e2e non pivot based feature tests with CAPM3 API version v1beta1 and branch main on CentOS +Release-1.9 branch: + +- **/test metal3-ubuntu-e2e-feature-test-release-1-9-pivoting** runs e2e pivot + based feature tests with CAPM3 API version v1beta1 and branch release-1.9 + on Ubuntu +- **/test metal3-ubuntu-e2e-feature-test-release-1-9-remediation** runs e2e + remediation based feature tests with CAPM3 API version v1beta1 and branch + release-1.9 on Ubuntu +- **/test metal3-ubuntu-e2e-feature-test-release-1-9-features** runs e2e non + pivot based feature tests with CAPM3 API version v1beta1 and branch release-1.9 + on Ubuntu +- **/test metal3-centos-e2e-feature-test-release-1-9-pivoting** runs e2e pivot + based feature tests with CAPM3 API version v1beta1 and branch release-1.9 on + CentOS +- **/test metal3-centos-e2e-feature-test-release-1-9-remediation** runs e2e + remediation based feature tests with CAPM3 API version v1beta1 and branch + release-1.9 on CentOS +- **/test metal3-centos-e2e-feature-test-release-1-9-features** runs e2e non + pivot based feature tests with CAPM3 API version v1beta1 and branch + release-1.9 on CentOS + Release-1.8 branch: - **/test metal3-ubuntu-e2e-feature-test-release-1-8-pivoting** runs e2e pivot @@ -234,27 +258,6 @@ Release-1.7 branch: pivot based feature tests with CAPM3 API version v1beta1 and branch release-1.7 on CentOS -Release-1.6 branch: - -- **/test metal3-ubuntu-e2e-feature-test-release-1-6-pivoting** runs e2e pivot - based feature tests with CAPM3 API version v1beta1 and branch release-1.6 on - Ubuntu -- **/test metal3-ubuntu-e2e-feature-test-release-1-6-remediation** runs e2e - remediation based feature tests with CAPM3 API version v1beta1 and branch - release-1.6 on Ubuntu -- **/test metal3-ubuntu-e2e-feature-test-release-1-6-features** runs e2e non - pivot based feature tests with CAPM3 API version v1beta1 and branch - release-1.6 on Ubuntu -- **/test metal3-centos-e2e-feature-test-release-1-6-pivoting** runs e2e pivot - based feature tests with CAPM3 API version v1beta1 and branch release-1.6 on - CentOS -- **/test metal3-centos-e2e-feature-test-release-1-6-remediation** runs e2e - remediation based feature tests with CAPM3 API version v1beta1 and branch - release-1.6 on CentOS -- **/test metal3-centos-e2e-feature-test-release-1-6-features** runs e2e non - pivot based feature tests with CAPM3 API version v1beta1 and branch release-1.6 - on CentOS - ### Upgrade tests #### Clusterctl upgrade tests @@ -265,15 +268,15 @@ We run upgrade test on main branch from different releases: - **/test metal3-e2e-clusterctl-upgrade-test-main** runs e2e clusterctl upgrade tests on main with Ubuntu +- **/test metal3-e2e-clusterctl-upgrade-test-release-1-9** runs e2e clusterctl + upgrade tests on release-1.9 with Ubuntu + - **/test metal3-e2e-clusterctl-upgrade-test-release-1-8** runs e2e clusterctl upgrade tests on release-1.8 with Ubuntu - **/test metal3-e2e-clusterctl-upgrade-test-release-1-7** runs e2e clusterctl upgrade tests on release-1.7 with Ubuntu -- **/test metal3-e2e-clusterctl-upgrade-test-release-1-6** runs e2e clusterctl - upgrade tests on release-1.6 with Ubuntu - #### K8s upgrade tests CAPM3 tests upgrading kubernetes between last 3 releases. @@ -283,9 +286,9 @@ The trigger takes the format: - **/test metal3-e2e-1-29-1-30-upgrade-test-main** - **/test metal3-e2e-1-28-1-29-upgrade-test-main** - **/test metal3-e2e-1-27-1-28-upgrade-test-main** +- **/test metal3-e2e-1-31-1-32-upgrade-test-release-1-9** - **/test metal3-e2e-1-29-1-30-upgrade-test-release-1-8** - **/test metal3-e2e-1-29-1-30-upgrade-test-release-1-7** -- **/test metal3-e2e-1-28-1-29-upgrade-test-release-1-6** Note: diff --git a/docs/e2e-test.md b/docs/e2e-test.md index 02dfe0cf17..a75b7597fc 100644 --- a/docs/e2e-test.md +++ b/docs/e2e-test.md @@ -125,16 +125,19 @@ in the ephemeral cluster either before pivoting or after re-pivoting. - Upgrade Ironic - Upgrade CAPI/CAPM3 -| tests | CAPM3 from | CAPM3 to | CAPI from | CAPI to | -| --------------| ----------- | --------- | ---------- |---------------- | -| v1.7=>current | v1.7.0 | main | v1.7.3 | latest release | -| v1.6=>current | v1.6.1 | main | v1.6.3 | latest release | -| v1.5=>current | v1.5.3 | main | v1.5.7 | latest release | + + +| tests | CAPM3 from | CAPM3 to | CAPI from | CAPI to | +| --------------| ---------------------- | --------- | --------------------- |---------------- | +| v1.8=>current | v1.8 latest patch | main | v1.8 latest patch | latest release | +| v1.7=>current | v1.7 latest patch | main | v1.7 latest patch | latest release | + + ### K8s upgrade tests -Kubernetes version upgrade in target nodes. We run three latest version -upgrades in k8s-upgrade tests for main branch and one kubernetes upgrade +Kubernetes version upgrade in target nodes. We run latest version +upgrade in k8s-upgrade tests for main branch and one kubernetes upgrade version for each release branch. When a new Kubernetes minor release is available, we will try to support it in an upcoming CAPM3 patch release (only in the latest supported CAPM3 minor release). @@ -143,21 +146,19 @@ For example: Main branch k8s-upgrade tests: -- `v1.27` => `v1.28` -- `v1.28` => `v1.29` -- `v1.29` => `v1.30` +- `v1.31` => `v1.32` -Release 1.7 branch k8s-upgrade test: +Release 1.9 branch k8s-upgrade test: -- `v1.29` => `v1.30` +- `v1.31` => `v1.32` -Release 1.6 branch k8s-upgrade test: +Release 1.8 branch k8s-upgrade test: -- `v1.28` => `v1.29` +- `v1.29` => `v1.30` -Release 1.5 branch k8s-upgrade test: +Release 1.7 branch k8s-upgrade test: -- `v1.26` => `v1.27` +- `v1.29` => `v1.30` When Kubernetes 1.31 is released, k8s-upgrade `v1.30` => `v1.31` will be supported in v1.7.x (but not in v1.6.x) @@ -199,9 +200,9 @@ clusters: | tests | bootstrap cluster | metal3 cluster init | metal3 cluster final | | ------------------- | ----------------- | ------------------- | -------------------- | -| integration | v1.29.0 | v1.29.0 | x | -| remediation | v1.29.0 | v1.29.0 | x | -| pivot based feature | v1.29.0 | v1.28.1 | v1.29.0 | -| upgrade | v1.29.0 | v1.28.1 | v1.29.0 | +| integration | v1.32.0 | v1.32.0 | x | +| remediation | v1.32.0 | v1.31.2 | x | +| pivot based feature | v1.32.0 | v1.31.2 | v1.32.0 | +| upgrade | v1.32.0 | v1.31.2 | v1.32.0 |