Skip to content

Commit d115a37

Browse files
authored
Compatibility matrix cert manager (#503)
* Removing tag v0.26.0 because it doesn't exist. * Enabling users to choose the cert-manager version * Adding Compatibility Matrix between Opentelemetry and Cert-manager * Adding third column on Compatibility Matrix
1 parent 7adf261 commit d115a37

File tree

3 files changed

+25
-17
lines changed

3 files changed

+25
-17
lines changed

CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,11 @@ In general, it's just easier to deploy the manager in a Kubernetes cluster inste
4646
make cert-manager
4747
```
4848

49+
In pursuit of continuous improvement, a variable named `CERTMANAGER_VERSION` which can be run:
50+
```bash
51+
CERTMANAGER_VERSION=1.60 make cert-manager
52+
```
53+
4954
By default, it will generate an image following the format `quay.io/${USER}/opentelemetry-operator:${VERSION}`. You can set the following env vars in front of the `make` command to override parts or the entirety of the image:
5055

5156
* `IMG_PREFIX`, to override the registry, namespace and image name (`quay.io`)

Makefile

+3-1
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ endif
4545
KUBE_VERSION ?= 1.21
4646
KIND_CONFIG ?= kind-$(KUBE_VERSION).yaml
4747

48+
CERTMANAGER_VERSION ?= 1.6.0
49+
4850
ensure-generate-is-noop: VERSION=$(OPERATOR_VERSION)
4951
ensure-generate-is-noop: USER=opentelemetry
5052
ensure-generate-is-noop: set-image-controller generate bundle
@@ -138,7 +140,7 @@ start-kind:
138140
kind load docker-image local/opentelemetry-operator:e2e
139141

140142
cert-manager:
141-
kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v1.6.0/cert-manager.yaml
143+
kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v${CERTMANAGER_VERSION}/cert-manager.yaml
142144
kubectl wait --timeout=5m --for=condition=available deployment cert-manager -n cert-manager
143145
kubectl wait --timeout=5m --for=condition=available deployment cert-manager-cainjector -n cert-manager
144146
kubectl wait --timeout=5m --for=condition=available deployment cert-manager-webhook -n cert-manager

README.md

+17-16
Original file line numberDiff line numberDiff line change
@@ -195,31 +195,32 @@ The above CR can be queried by `kubectl get otelinst`.
195195

196196
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.
197197

198-
### OpenTelemetry Operator vs. Kubernetes
198+
### OpenTelemetry Operator vs. Kubernetes vs. Cert Manager
199199

200200
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.
201201

202202
Our promise is that we'll follow what's common practice in the Kubernetes world and support N-2 versions, based on the release date of the OpenTelemetry Operator.
203203

204204
For instance, when we released v0.27.0, the latest Kubernetes version was v1.21.1. As such, the minimum version of Kubernetes we support for OpenTelemetry Operator v0.27.0 is v1.19 and we tested it with up to 1.21.
205205

206+
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.
207+
206208
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.
207209

208-
| OpenTelemetry Operator | Kubernetes |
209-
|------------------------|----------------------|
210-
| v0.37.1 | v1.20 to v1.22 |
211-
| v0.37.0 | v1.20 to v1.22 |
212-
| v0.36.0 | v1.20 to v1.22 |
213-
| v0.35.0 | v1.20 to v1.22 |
214-
| v0.34.0 | v1.20 to v1.22 |
215-
| v0.33.0 | v1.20 to v1.22 |
216-
| v0.32.0 (skipped) | n/a |
217-
| v0.31.0 | v1.19 to v1.21 |
218-
| v0.30.0 | v1.19 to v1.21 |
219-
| v0.29.0 | v1.19 to v1.21 |
220-
| v0.28.0 | v1.19 to v1.21 |
221-
| v0.27.0 | v1.19 to v1.21 |
222-
| v0.26.0 | v1.18 to v1.20 |
210+
| OpenTelemetry Operator | Kubernetes | Cert-Manager |
211+
|------------------------|----------------------|----------------------|
212+
| v0.37.1 | v1.20 to v1.22 | v1.4.0 to v1.6.1 |
213+
| v0.37.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
214+
| v0.36.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
215+
| v0.35.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
216+
| v0.34.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
217+
| v0.33.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
218+
| v0.32.0 (skipped) | n/a | n/a |
219+
| v0.31.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |
220+
| v0.30.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |
221+
| v0.29.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |
222+
| v0.28.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |
223+
| v0.27.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |
223224

224225
## Contributing and Developing
225226

0 commit comments

Comments
 (0)