Skip to content

Commit 0f992ba

Browse files
committed
Add Kubernetes support policy
1 parent 443cabc commit 0f992ba

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

docs/compatibility.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
This document details compatibility guarantees the OpenTelemetry Operator offers for its dependencies and platforms.
44

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+
517
## OpenTelemetry Operator vs. OpenTelemetry Collector
618

719
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.
@@ -12,8 +24,6 @@ When a custom `Spec.Image` is used with an `OpenTelemetryCollector` resource, th
1224

1325
## Compatibility matrix
1426

15-
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.
16-
1727
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.
1828

1929
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.
@@ -46,4 +56,8 @@ The OpenTelemetry Operator _might_ work on versions outside of the given range,
4656
| v0.91.0 | v1.23 to v1.29 | v1 | v0.70.0 |
4757
| v0.90.0 | v1.23 to v1.28 | v1 | v0.69.1 |
4858
| v0.89.0 | v1.23 to v1.28 | v1 | v0.69.1 |
49-
| v0.88.0 | v1.23 to v1.28 | v1 | v0.68.0 |
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)