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.

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

Compatibility matrix cert manager #503

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ In general, it's just easier to deploy the manager in a Kubernetes cluster inste
make cert-manager
```

In pursuit of continuous improvement, a variable named `CERTMANAGER_VERSION` which can be run:
```bash
CERTMANAGER_VERSION=1.60 make cert-manager
```

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:

* `IMG_PREFIX`, to override the registry, namespace and image name (`quay.io`)
Expand Down
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ endif
KUBE_VERSION ?= 1.21
KIND_CONFIG ?= kind-$(KUBE_VERSION).yaml

CERTMANAGER_VERSION ?= 1.6.0

ensure-generate-is-noop: VERSION=$(OPERATOR_VERSION)
ensure-generate-is-noop: USER=opentelemetry
ensure-generate-is-noop: set-image-controller generate bundle
Expand Down Expand Up @@ -138,7 +140,7 @@ start-kind:
kind load docker-image local/opentelemetry-operator:e2e

cert-manager:
kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v1.6.0/cert-manager.yaml
kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v${CERTMANAGER_VERSION}/cert-manager.yaml
kubectl wait --timeout=5m --for=condition=available deployment cert-manager -n cert-manager
kubectl wait --timeout=5m --for=condition=available deployment cert-manager-cainjector -n cert-manager
kubectl wait --timeout=5m --for=condition=available deployment cert-manager-webhook -n cert-manager
Expand Down
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,31 +200,32 @@ The above CR can be queried by `kubectl get otelinst`.

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.

### OpenTelemetry Operator vs. Kubernetes
### OpenTelemetry Operator vs. Kubernetes vs. Cert Manager

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.

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.

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.

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.

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.

| OpenTelemetry Operator | Kubernetes |
|------------------------|----------------------|
| v0.37.1 | v1.20 to v1.22 |
| v0.37.0 | v1.20 to v1.22 |
| v0.36.0 | v1.20 to v1.22 |
| v0.35.0 | v1.20 to v1.22 |
| v0.34.0 | v1.20 to v1.22 |
| v0.33.0 | v1.20 to v1.22 |
| v0.32.0 (skipped) | n/a |
| v0.31.0 | v1.19 to v1.21 |
| v0.30.0 | v1.19 to v1.21 |
| v0.29.0 | v1.19 to v1.21 |
| v0.28.0 | v1.19 to v1.21 |
| v0.27.0 | v1.19 to v1.21 |
| v0.26.0 | v1.18 to v1.20 |
| OpenTelemetry Operator | Kubernetes | Cert-Manager |
|------------------------|----------------------|----------------------|
| v0.37.1 | v1.20 to v1.22 | v1.4.0 to v1.6.1 |
| v0.37.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
| v0.36.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
| v0.35.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
| v0.34.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
| v0.33.0 | v1.20 to v1.22 | v1.4.0 to v1.5.4 |
| v0.32.0 (skipped) | n/a | n/a |
| v0.31.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |
| v0.30.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |
| v0.29.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |
| v0.28.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |
| v0.27.0 | v1.19 to v1.21 | v1.4.0 to v1.5.4 |

## Contributing and Developing

Expand Down