*: add v1beta1 for AlertmanagerConfig CRD #4709

simonpasquier · 2022-04-08T15:29:57Z

Description

This change implements #4677. It includes an extension of the webhook admission service that enables converting from v1alpha1 to v1beta1 (and vice-versa). The stored version is v1alpha1 to enable smooth migration.

As discussed during the project office hours and documented in the associated issue, v1beta1 is going to be opt-in for 2 releases. This is to let time for users to install the conversion webhook as long as they don't want/need to support v1beta1.

Implement v1beta1 as a 1:1 copy of v1alph1.
Implement conversion webhook.
Unit tests for conversion webhook.
Remove the regex field from the Matcher type.
Rename spec.muteTimeIntervals to spec.timeIntervals
Rename the MuteTimeInterval type to TimeInterval (and TimeInterval type to TimePeriod).
Replace v1.SecretKeySelector by SecretKeySelector (optional field removed + name and key required).
Update Documentation/user-guides/webhook.md
~~Fix Documentation/api.md~~ (edit: v1beta1 being opt-in, the documentation part can wait a bit and it would be best tackled as part of Support documenting different types in po-docgen #4376).

Type of change

What type of changes does your code introduce to the Prometheus operator? Put an x in the box that apply.

CHANGE (fix or feature that would cause existing functionality to not work as expected)
FEATURE (non-breaking change which adds functionality)
BUGFIX (non-breaking change which fixes an issue)
ENHANCEMENT (non-breaking change which improves existing functionality)
NONE (if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)

Changelog entry

Please put a one-line changelog entry below. This will be copied to the changelog file during the release process.

Added v1beta1 version of AlertmanagerConfig CRD.

simonpasquier · 2022-05-03T13:02:01Z

@philipgough @paulfantom @fpetkovski can you please review this?

Documentation/user-guides/webhook.md

philipgough · 2022-05-03T16:02:44Z

Documentation/user-guides/webhook.md

+      }
+   }
+}
+```


Makefile

simonpasquier · 2022-05-17T08:51:25Z

@prometheus-operator/prometheus-operator-reviewers please have a look. As discussed during our last office hours, this requires explicit action from cluster admins to expose the v1beta1 version so this is quite safe for the majority of users.

simonpasquier · 2022-05-19T15:14:17Z

@paulfantom @fpetkovski @philipgough I'd welcome a review on the PR. Ideally I'd like to have it in v0.57.0 so folks can start playing with it :)

Documentation/user-guides/webhook.md

philipgough

Nice work, LGTM on green!

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

…ySelector v1.SecretKeySelector has an `Optional` field which doesn't make sense in the context of the AlertmanagerConfig CRD. Not depending on an external type also means that we can enforce that key and name values are not empty. Signed-off-by: Simon Pasquier <spasquie@redhat.com>

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

Enabling by default AlertmanagerConfig v1beta1 by default means that users would have to configure the conversion webhook and it must be performed in advance or at the same time users upgrade to the latest operator version. To offer a smoother transition, we offer AlertmanagerConfig v1beta1 as an opt-in feature: it's neither included in the bundle.yaml file nor in the example/prometheus-operator-crd/ manifests. People that want to enable v1beta1 should use the example/prometheus-operator-crd-full manifests. For jsonnet users, the Prometheus operator jsonnet library has a new `enableAlertmanagerConfigV1beta1` configuration option that can be set to `true`. Signed-off-by: Simon Pasquier <spasquie@redhat.com>

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

paulfantom

Awesome work! 💯

The `followRedirects` field was missed in prometheus-operator#4709. Signed-off-by: Simon Pasquier <spasquie@redhat.com>

simonpasquier force-pushed the amconfig-v1beta1-poc branch 6 times, most recently from e3634ca to ad1f614 Compare April 19, 2022 09:34

simonpasquier marked this pull request as ready for review April 19, 2022 11:32

simonpasquier requested review from paulfantom and a team as code owners April 19, 2022 11:32

simonpasquier force-pushed the amconfig-v1beta1-poc branch 4 times, most recently from 74ed626 to 3682765 Compare April 20, 2022 14:36

simonpasquier force-pushed the amconfig-v1beta1-poc branch from 01fa281 to 642284d Compare May 3, 2022 13:01

philipgough reviewed May 3, 2022

View reviewed changes

Documentation/user-guides/webhook.md Show resolved Hide resolved

philipgough reviewed May 3, 2022

View reviewed changes

Documentation/user-guides/webhook.md

}

}

}

```

Copy link

Contributor

philipgough May 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

philipgough reviewed May 3, 2022

View reviewed changes

Makefile Show resolved Hide resolved

simonpasquier force-pushed the amconfig-v1beta1-poc branch 3 times, most recently from ec21d9a to 9b11b69 Compare May 16, 2022 13:52

simonpasquier mentioned this pull request May 17, 2022

[WIP] v1beta1 AlertmanagerConfig CRD openshift/prometheus-operator#183

Closed

simonpasquier force-pushed the amconfig-v1beta1-poc branch 2 times, most recently from 9a83cc3 to 5a70542 Compare May 30, 2022 07:24

philipgough reviewed May 30, 2022

View reviewed changes

Documentation/user-guides/webhook.md Outdated Show resolved Hide resolved

philipgough approved these changes May 30, 2022

View reviewed changes

*: add v1beta1 for AlertmanagerConfig CRD

ef57ab5

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

simonpasquier added 16 commits May 31, 2022 09:17

*: implement conversion webhook for AlertmanagerConfig

d5e01dc

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

*: add jsonnet support for CRD conversion webhook

58feab2

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

test: configure conversion webhook for AlertmanagerConfig

fc2cac0

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

test/e2e: add test for v1alpha1<->v1beta1 conversion

f977dc6

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

Documentation: update webhook documentation

fc7f1ec

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

pkg/apis/monitoring/v1beta1: remove Regex field from Matcher type

35a953a

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

*: rename muteTimeIntervals field to timeIntervals (v1beta1)

6ee76eb

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

*: restore short name for AlertmanagerConfig

bf54b81

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

pkg/admission: add unit test for conversion webhook

03fcce3

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

*: regenerate

7547246

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

*: add Telegram support in v1beta1

9072ce5

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

*: synchronize with latest main changes

8ca7973

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

Documentation/user-guides/webhook.md: clarify mutation webhook

b422bda

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

example: regenerate

14a345e

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

simonpasquier force-pushed the amconfig-v1beta1-poc branch from fd4f3fa to 14a345e Compare May 31, 2022 07:19

paulfantom approved these changes May 31, 2022

View reviewed changes

simonpasquier merged commit 1829e37 into prometheus-operator:main May 31, 2022

simonpasquier deleted the amconfig-v1beta1-poc branch May 31, 2022 09:16

simonpasquier mentioned this pull request Jun 16, 2022

pkg/apis/monitoring/v1beta1: fix httpConfig conversion #4854

Merged

5 tasks

This was referenced Jul 20, 2022

Add v1beta1 AlertmanagerConfig CRD #4677

Open

Add support for active time intervals in AlertmanagerConfig CRD #4656

Closed

iceman91176 mentioned this pull request Sep 23, 2022

Support for AlertManager active_time_intervals #5048

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

*: add v1beta1 for AlertmanagerConfig CRD #4709

*: add v1beta1 for AlertmanagerConfig CRD #4709

simonpasquier commented Apr 8, 2022 •

edited

simonpasquier commented May 3, 2022

philipgough May 3, 2022

simonpasquier commented May 17, 2022

simonpasquier commented May 19, 2022

philipgough left a comment

paulfantom left a comment

*: add v1beta1 for AlertmanagerConfig CRD #4709

*: add v1beta1 for AlertmanagerConfig CRD #4709

Conversation

simonpasquier commented Apr 8, 2022 • edited

Description

Type of change

Changelog entry

simonpasquier commented May 3, 2022

philipgough May 3, 2022

Choose a reason for hiding this comment

simonpasquier commented May 17, 2022

simonpasquier commented May 19, 2022

philipgough left a comment

Choose a reason for hiding this comment

paulfantom left a comment

Choose a reason for hiding this comment

simonpasquier commented Apr 8, 2022 •

edited