Skip to content

Commit

Permalink
docs: outline go support policy (#2839)
Browse files Browse the repository at this point in the history
Signed-off-by: Benedikt Bongartz <bongartz@klimlive.de>
  • Loading branch information
frzifus authored Oct 30, 2024
1 parent abbf360 commit 839da24
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The operator manages:

## Documentation

- [Compatibility & Support docs](./docs/compatibility.md)
- [API docs](./docs/api.md)
- [Offical Telemetry Operator page](https://opentelemetry.io/docs/kubernetes/operator/)

Expand Down Expand Up @@ -790,10 +791,6 @@ The priority for setting resource attributes is as follows (first found wins):
This priority is applied for each resource attribute separately, so it is possible to set some attributes via
annotations and others via labels.

## Compatibility

See [here](docs/compatibility.md).

## Contributing and Developing

Please see [CONTRIBUTING.md](CONTRIBUTING.md).
Expand Down
13 changes: 13 additions & 0 deletions docs/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

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

## Go

When productised as a go libary or custom distribution the OpenTelemetry Operator project attempts to follow the supported go versions as [defined by the Go team](https://go.dev/doc/devel/release#policy).

Similar to the [opentelemetry collector](https://github.com/open-telemetry/opentelemetry-collector?tab=readme-ov-file#compatibility), removing support for an unsupported Go version is not considered a breaking change.

Support for Go versions on the OpenTelemetry Operator is updated as follows:

The first release after the release of a new Go minor version N will add build and tests steps for the new Go minor version.
The first release after the release of a new Go minor version N will remove support for Go version N-2.

Official OpenTelemetry Operator binaries may be built with any supported Go version.

## Kubernetes

As a rule, the operator tries to be compatible with as wide a range of Kubernetes versions as possible.
Expand Down

0 comments on commit 839da24

Please sign in to comment.