Skip to content

Commit

Permalink
fix: update documentation for support matrix (#1370)
Browse files Browse the repository at this point in the history 
Signed-off-by: matttrach <[email protected]>
  • Loading branch information
@matttrach
matttrach authored Jul 16, 2024
1 parent 9e26756 commit 4c6ed7c
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 34 deletions.
17 changes: 11 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,27 +97,33 @@ See [test process](docs/test-process.md) for details on release testing (_Terraf
Branching the Provider
---------------------------

The provider is branched into three release lines with major version alignment with Rancher 2.6, 2.7, and 2.8. The `release/v2` branch with 2.0.0+ is aligned with Rancher 2.6, the `release/v3` branch with 3.0.0+ is aligned with Rancher 2.7, and the `master` branch with 4.0.0+ is aligned with Rancher 2.8. The lifecycle of each major provider version is aligned with the lifecycle of each Rancher minor version. For example, provider versions 4.0.x which are aligned with Rancher 2.8.x will only be actively maintained until the EOM for Rancher 2.8.x and supported until EOL for Rancher 2.8.x.
This provider is branched in correlation with minor versions of Rancher: 2.8, 2.9, etc.
The `release/v3` branch with 3.0.0+ is aligned with Rancher 2.7,
the `release/v4` branch with 4.0.0+ is aligned with Rancher 2.8,
and the `master` branch with 5.0.0+ is aligned with Rancher 2.9.
The lifecycle of each major provider version is aligned with the lifecycle of each Rancher minor version.
For example, provider versions 4.x are aligned with Rancher 2.8.x will only be actively maintained until the EOM for Rancher 2.8.x and supported until EOL for Rancher 2.8.x.

See the [Rancher support matrix](https://www.suse.com/lifecycle/#rancher) for details.

Aligning major provider releases with minor Rancher releases means,
Aligning major provider releases with minor Rancher releases means:

* We can follow semver
* We can cut patch/minor versions on an as-needed basis to fix bugs or add new resources
* We can cut patch/minor versions on an as-needed basis to fix bugs or add new resources
* We have 'out of band' flexibility and are only tied to releasing a new version of the provider when we get a new 2.x Rancher minor version.

See the [compatibility matrix](docs/compatibility-matrix.md) for details.

If you are using Terraform to provision clusters on instances of Rancher 2.7 and 2.8, you must have a separate configuration in a separate dir for each provider. Otherwise, Terraform will overwrite the `.tfstate` file every time you switch versions.
If you are using Terraform to provision clusters on instances of Rancher 2.7 and 2.8,
you must have a separate configuration in a separate dir for each provider.
Otherwise, Terraform will overwrite the `.tfstate` file every time you switch versions.

Releasing the Provider
---------------------------

As of Terraform 2.0.0 and 3.0.0, the provider is tied to Rancher minor releases but can be released 'out of band' within that minor version.
For example, 4.0.0 will be released 1-2 weeks after Rancher 2.8.x and fixes and features in the 4.0.0 release will be supported for clusters provisioned via Terraform on Rancher 2.8.x.
A critical bug fix can be released 'out of band' as 4.0.1 and backported to `release/v3` as 3.0.1.
A new feature can also be released 'out of band' as 4.1.0 but not backported.

To release the provider

Expand All @@ -126,4 +132,3 @@ To release the provider
* Push a tag to the release branch (`release/v2`, `release/v3`, or `master`) which does not have a `-rc` suffix
* The CI will build the provider and generate a release on GitHub
* Make sure to validate that the release is picked up by the Terraform registry, you may need to find the "resync" button to accomplish this.

43 changes: 15 additions & 28 deletions docs/compatibility-matrix.md
View file
Original file line number Diff line number Diff line change
@@ -1,35 +1,22 @@
# Rancher2 Provider

### Version compatibility matrix
## Version compatibility matrix

The version matrix specifies the Terraform provider version _recommended_ to use with the associated minor Rancher version that it was released for. When updating the version matrix, add a row for each Terraform version released with a minor Rancher release.
The version matrix specifies the Terraform provider version _recommended_ to use with the associated minor Rancher version that it was released for.
When updating the version matrix, add a row for each Terraform version released with a minor Rancher release.
This shouldn't be a changelog for every branch, each branch has its own CHANGELOG.md file which should be updated with changes.

#### Rancher 2.6
| Terraform provider version | Rancher version | Terraform provider branch |
|----------------------------|:---------------:|---------------------------|
| 2.x | 2.6.x | release/v2 |
| 3.x | 2.7.x | release/v3 |
| 4.x | 2.8.x | release/v4 |
| 5.x | 2.9.x | master |

| Terraform provider version | Rancher | Notes |
|----------------------------------------|:-------:|:-----------:|
| 2.0.0 | 2.6.11 | Bug fixes |
## FAQ

#### Rancher 2.7
**Can I use an earlier Terraform version?**
Yes, but Terraform may not support all features and fields supported in your Rancher version so provisioning may be limited.

| Terraform provider version | Rancher | Notes |
|----------------------------|:-------:|-----------------------------------------------------------------------------------------------------|
| 3.0.0 | 2.7.2 | Kubernetes 1.25 support, Azure / EKS / Harvester features<br/>and bug fixes |
| 3.0.1 | 2.7.4 | Fix to support old Harvester config |
| 3.0.2 | 2.7.4 | Fix Harvester disk_size default value |
| 3.1.0 | 2.7.5 | Cluster Agent customization, PSACT support for 1.25+ clusters,<br/>custom user tokens and bug fixes |
| 3.1.1 | 2.7.5 | Docs patch |
| 3.2.0 | 2.7.x | |

#### Rancher 2.8

| Terraform provider version | Rancher | Notes |
|----------------------------|:-------:|-------|
| 4.0.0 | 2.8.x | |
| 4.1.0 | 2.8.x | |

#### FAQ

**Can I use an earlier Terraform version?** Yes, but Terraform may not support all features and fields supported in your Rancher version so provisioning may be limited.

**Can I use a later Terraform version?** Yes, but you must NOT use any new features and fields that your Rancher version does not support.
**Can I use a later Terraform version?**
Yes, but you must NOT use any new features and fields that your Rancher version does not support.

0 comments on commit 4c6ed7c

Please sign in to comment.