Skip to content

Commit 61dedd1

Browse files
author
Israel Blancas
authored
Merge branch 'main' into 3370
2 parents 967f9c1 + abbf360 commit 61dedd1

File tree

3 files changed

+67
-48
lines changed

3 files changed

+67
-48
lines changed

‎README.md

+3-47
Original file line numberDiff line numberDiff line change
@@ -790,53 +790,9 @@ The priority for setting resource attributes is as follows (first found wins):
790790
This priority is applied for each resource attribute separately, so it is possible to set some attributes via
791791
annotations and others via labels.
792792

793-
## Compatibility matrix
794-
795-
### OpenTelemetry Operator vs. OpenTelemetry Collector
796-
797-
The OpenTelemetry Operator follows the same versioning as the operand (OpenTelemetry Collector) up to the minor part of the version. For example, the OpenTelemetry Operator v0.18.1 tracks OpenTelemetry Collector 0.18.0. The patch part of the version indicates the patch level of the operator itself, not that of OpenTelemetry Collector. Whenever a new patch version is released for OpenTelemetry Collector, we'll release a new patch version of the operator.
798-
799-
By default, the OpenTelemetry Operator ensures consistent versioning between itself and the managed `OpenTelemetryCollector` resources. That is, if the OpenTelemetry Operator is based on version `0.40.0`, it will create resources with an underlying OpenTelemetry Collector at version `0.40.0`.
800-
801-
When a custom `Spec.Image` is used with an `OpenTelemetryCollector` resource, the OpenTelemetry Operator will not manage this versioning and upgrading. In this scenario, it is best practice that the OpenTelemetry Operator version should match the underlying core version. Given a `OpenTelemetryCollector` resource with a `Spec.Image` configured to a custom image based on underlying OpenTelemetry Collector at version `0.40.0`, it is recommended that the OpenTelemetry Operator is kept at version `0.40.0`.
802-
803-
### OpenTelemetry Operator vs. Kubernetes vs. Cert Manager vs Prometheus Operator
804-
805-
We strive to be compatible with the widest range of Kubernetes versions as possible, but some changes to Kubernetes itself require us to break compatibility with older Kubernetes versions, be it because of code incompatibilities, or in the name of maintainability. Every released operator will support a specific range of Kubernetes versions, to be determined at the latest during the release.
806-
807-
We use `cert-manager` for some features of this operator and the third column shows the versions of the `cert-manager` that are known to work with this operator's versions.
808-
809-
The Target Allocator supports prometheus-operator CRDs like ServiceMonitor, and it does so by using packages imported from prometheus-operator itself. The table shows which version is shipped with a given operator version.
810-
Generally speaking, these are backwards compatible, but specific features require the appropriate package versions.
811-
812-
The OpenTelemetry Operator _might_ work on versions outside of the given range, but when opening new issues, please make sure to test your scenario on a supported version.
813-
814-
| OpenTelemetry Operator | Kubernetes | Cert-Manager | Prometheus-Operator |
815-
|------------------------|----------------| ------------ |---------------------|
816-
| v0.111.0 | v1.23 to v1.31 | v1 | v0.76.0 |
817-
| v0.110.0 | v1.23 to v1.31 | v1 | v0.76.0 |
818-
| v0.109.0 | v1.23 to v1.31 | v1 | v0.76.0 |
819-
| v0.108.0 | v1.23 to v1.31 | v1 | v0.76.0 |
820-
| v0.107.0 | v1.23 to v1.30 | v1 | v0.75.0 |
821-
| v0.106.0 | v1.23 to v1.30 | v1 | v0.75.0 |
822-
| v0.105.0 | v1.23 to v1.30 | v1 | v0.74.0 |
823-
| v0.104.0 | v1.23 to v1.30 | v1 | v0.74.0 |
824-
| v0.103.0 | v1.23 to v1.30 | v1 | v0.74.0 |
825-
| v0.102.0 | v1.23 to v1.30 | v1 | v0.71.2 |
826-
| v0.101.0 | v1.23 to v1.30 | v1 | v0.71.2 |
827-
| v0.100.0 | v1.23 to v1.29 | v1 | v0.71.2 |
828-
| v0.99.0 | v1.23 to v1.29 | v1 | v0.71.2 |
829-
| v0.98.0 | v1.23 to v1.29 | v1 | v0.71.2 |
830-
| v0.97.0 | v1.23 to v1.29 | v1 | v0.71.2 |
831-
| v0.96.0 | v1.23 to v1.29 | v1 | v0.71.2 |
832-
| v0.95.0 | v1.23 to v1.29 | v1 | v0.71.2 |
833-
| v0.94.0 | v1.23 to v1.29 | v1 | v0.71.0 |
834-
| v0.93.0 | v1.23 to v1.29 | v1 | v0.71.0 |
835-
| v0.92.0 | v1.23 to v1.29 | v1 | v0.71.0 |
836-
| v0.91.0 | v1.23 to v1.29 | v1 | v0.70.0 |
837-
| v0.90.0 | v1.23 to v1.28 | v1 | v0.69.1 |
838-
| v0.89.0 | v1.23 to v1.28 | v1 | v0.69.1 |
839-
| v0.88.0 | v1.23 to v1.28 | v1 | v0.68.0 |
793+
## Compatibility
794+
795+
See [here](docs/compatibility.md).
840796

841797
## Contributing and Developing
842798

‎RELEASE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Steps to release a new version of the OpenTelemetry Operator:
1212
> DO NOT BUMP JAVA PAST `1.X.X` AND DO NOT BUMP .NET PAST `1.2.0`. Upgrades past these versions will introduce breaking HTTP semantic convention changes.
1313
1. Check if the compatible OpenShift versions are updated in the `Makefile`.
1414
1. Update the bundle by running `make bundle VERSION=$VERSION`.
15-
1. Change the compatibility matrix in the [readme](./README.md) file, using the OpenTelemetry Operator version to be released and the current latest Kubernetes version as the latest supported version. Remove the oldest entry.
15+
1. Change the compatibility matrix in the [compatibility doc](./docs/compatibility.md) file, using the OpenTelemetry Operator version to be released and the current latest Kubernetes version as the latest supported version. Remove the oldest entry.
1616
1. Update release schedule table, by moving the current release manager to the end of the table with updated release version.
1717
1. Add the changes to the changelog by running `make chlog-update VERSION=$VERSION`.
1818
1. Check the OpenTelemetry Collector's changelog and ensure migration steps are present in `pkg/collector/upgrade`

‎docs/compatibility.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Compatibility
2+
3+
This document details compatibility guarantees the OpenTelemetry Operator offers for its dependencies and platforms.
4+
5+
## Kubernetes
6+
7+
As a rule, the operator tries to be compatible with as wide a range of Kubernetes versions as possible.
8+
9+
We will *always* support all the versions maintained by the upstream Kubernetes project, as detailed on its [releases page][kubernetes_releases].
10+
11+
We will make every effort to support all Kubernetes versions maintained by popular distributions and hosted platforms. For example, you can realistically expect us to always support all versions offered by [OpenShift][openshift_support] and [AWS EKS][aws_support].
12+
13+
Whenever we do remove support for a Kubernetes version, we will give at least one month's notice beforehand.
14+
15+
The [compatibility matrix](#compatibility-matrix) below precisely shows the supported Kubernetes versions for each operator release.
16+
17+
## OpenTelemetry Operator vs. OpenTelemetry Collector
18+
19+
The OpenTelemetry Operator follows the same versioning as the operand (OpenTelemetry Collector) up to the minor part of the version. For example, the OpenTelemetry Operator v0.18.1 tracks OpenTelemetry Collector 0.18.0. The patch part of the version indicates the patch level of the operator itself, not that of OpenTelemetry Collector. Whenever a new patch version is released for OpenTelemetry Collector, we'll release a new patch version of the operator.
20+
21+
By default, the OpenTelemetry Operator ensures consistent versioning between itself and the managed `OpenTelemetryCollector` resources. That is, if the OpenTelemetry Operator is based on version `0.40.0`, it will create resources with an underlying OpenTelemetry Collector at version `0.40.0`.
22+
23+
When a custom `Spec.Image` is used with an `OpenTelemetryCollector` resource, the OpenTelemetry Operator will not manage this versioning and upgrading. In this scenario, it is best practice that the OpenTelemetry Operator version should match the underlying core version. Given a `OpenTelemetryCollector` resource with a `Spec.Image` configured to a custom image based on underlying OpenTelemetry Collector at version `0.40.0`, it is recommended that the OpenTelemetry Operator is kept at version `0.40.0`.
24+
25+
## Compatibility matrix
26+
27+
We use `cert-manager` for some features of this operator and the third column shows the versions of the `cert-manager` that are known to work with this operator's versions.
28+
29+
The Target Allocator supports prometheus-operator CRDs like ServiceMonitor, and it does so by using packages imported from prometheus-operator itself. The table shows which version is shipped with a given operator version.
30+
Generally speaking, these are backwards compatible, but specific features require the appropriate package versions.
31+
32+
The OpenTelemetry Operator _might_ work on versions outside of the given range, but when opening new issues, please make sure to test your scenario on a supported version.
33+
34+
| OpenTelemetry Operator | Kubernetes | Cert-Manager | Prometheus-Operator |
35+
|------------------------|----------------| ------------ |---------------------|
36+
| v0.111.0 | v1.23 to v1.31 | v1 | v0.76.0 |
37+
| v0.110.0 | v1.23 to v1.31 | v1 | v0.76.0 |
38+
| v0.109.0 | v1.23 to v1.31 | v1 | v0.76.0 |
39+
| v0.108.0 | v1.23 to v1.31 | v1 | v0.76.0 |
40+
| v0.107.0 | v1.23 to v1.30 | v1 | v0.75.0 |
41+
| v0.106.0 | v1.23 to v1.30 | v1 | v0.75.0 |
42+
| v0.105.0 | v1.23 to v1.30 | v1 | v0.74.0 |
43+
| v0.104.0 | v1.23 to v1.30 | v1 | v0.74.0 |
44+
| v0.103.0 | v1.23 to v1.30 | v1 | v0.74.0 |
45+
| v0.102.0 | v1.23 to v1.30 | v1 | v0.71.2 |
46+
| v0.101.0 | v1.23 to v1.30 | v1 | v0.71.2 |
47+
| v0.100.0 | v1.23 to v1.29 | v1 | v0.71.2 |
48+
| v0.99.0 | v1.23 to v1.29 | v1 | v0.71.2 |
49+
| v0.98.0 | v1.23 to v1.29 | v1 | v0.71.2 |
50+
| v0.97.0 | v1.23 to v1.29 | v1 | v0.71.2 |
51+
| v0.96.0 | v1.23 to v1.29 | v1 | v0.71.2 |
52+
| v0.95.0 | v1.23 to v1.29 | v1 | v0.71.2 |
53+
| v0.94.0 | v1.23 to v1.29 | v1 | v0.71.0 |
54+
| v0.93.0 | v1.23 to v1.29 | v1 | v0.71.0 |
55+
| v0.92.0 | v1.23 to v1.29 | v1 | v0.71.0 |
56+
| v0.91.0 | v1.23 to v1.29 | v1 | v0.70.0 |
57+
| v0.90.0 | v1.23 to v1.28 | v1 | v0.69.1 |
58+
| v0.89.0 | v1.23 to v1.28 | v1 | v0.69.1 |
59+
| v0.88.0 | v1.23 to v1.28 | v1 | v0.68.0 |
60+
61+
[kubernetes_releases]: https://kubernetes.io/releases/
62+
[openshift_support]: https://access.redhat.com/support/policy/updates/openshift
63+
[aws_support]: https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html

0 commit comments

Comments
 (0)