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

📖 Updating docs for release 1.9 #2232

Merged
merged 1 commit into from
Jan 9, 2025
Merged

📖 Updating docs for release 1.9 #2232

Show file tree
Hide file tree
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
69 changes: 36 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -158,20 +166,15 @@ 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
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

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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:

Expand Down
41 changes: 21 additions & 20 deletions docs/e2e-test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
<!-- markdownlint-disable MD013 -->

| 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 |

<!-- markdownlint-disable MD013 -->

### 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).
Expand All @@ -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)
Expand Down Expand Up @@ -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 |

<!-- markdownlint-enable MD013 -->
Loading