Add Prometheus configuration to bundle OCP #305

clobrano · 2024-03-21T08:37:31Z

Why we need this PR

To allow User Workload Prometheus (UWP) metrics scraping for NHC, we need to modify existing bundle configuration as well as and deploy new configuration.

Changes made

Currently, only in OCP we are sure to have Prometheus installed, so this PR affects the bundle created for OCP only.

created a config/optional/prometheus-ocp directory to hold the new configuration and documentation
- ca-configmap.yaml: the ConfigMap which will have the CA bundle injected for usage in the client
- monitor.yaml: the ServiceMonitor (to be installed manually by the user, see more in the readme) which will make the NHC prometheus endpoint visibile
- readme.md: the complete UWP configuration guide
modified config/manifests/ocp/
- auth_proxy_service_patch.yaml: to modify NHC Service with the annotation to create the serving-cert-secret Secret node-healthcheck-tls
- deployment_patch.yaml: to modify NHC deployment to mount the required configuration as volumes

Which issue(s) this PR fixes

https://issues.redhat.com/browse/ECOPROJECT-1760

Test plan

To configure NHC with UWP follow the steps in config/optional/prometheus-ocp/readme.md.
To ease the test process, the script hack/ocp/test_create_bundle_ocp_image_in_quay.sh build the bundle image and pushes it to quay.io.

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

- restored `config/manifests/metrics` and `config/optional/prometheus` from main. - created a new `config/manifests/metrics-ocp` and `config/optional/prometheus-ocp` with the new User Workload Prometheus (UWP) monitoring configuration from this PR. - updated documentation under `config/manifests/readme.md` with all the steps to create the bundle predisposed for UWP and configure UWP itself. Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

- Moved config/manifests/metrics-ocp configuration files to config/manifests/ocp, since this configuration will always be part of OCP bundle - Moved readme in config/manifests/metrics-ocp into config/optional/prometheus-ocp Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

openshift-ci · 2024-03-21T08:37:35Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

clobrano · 2024-03-21T09:38:12Z

/test 4.15-openshift-e2e

The target was already building OCP bundle. Changing the name to reflect this behavior. Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

razo7 · 2024-03-21T15:28:56Z

The test didn't start. Lets try again
/test 4.15-openshift-e2e

Add a test script to build the OCP bundle with prometheus metrics, but pushing the images to quay.io/username (not medik8s!) for testing. Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

Makefile

config/manifests/ocp/deployment_patch.yaml

config/optional/prometheus-ocp/readme.md

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

OCP Metrics configuration was moved in config/manifests/ocp and config/manifests/metrics-ocp removed, so this target is not useful anymore. Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

slintes · 2024-03-28T15:55:15Z

Makefile

@@ -375,11 +375,6 @@ bundle-metrics: bundle-base ## Generate bundle manifests and metadata with metri
 	$(KUSTOMIZE) build config/manifests/metrics | $(OPERATOR_SDK) generate --verbose bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
 	$(MAKE) bundle-validate

-.PHONY: bundle-metrics-ocp


there still is bundle-build-metrics-ocp and container-build-metrics-ocp

removed also bundle-metrics 👍

removed also bundle-metrics

hm, IIRC the idea was that it can be used to manually create a k8s bundle some non OCP specific prometheus bits... 🤔

other than that lgtm! 🙂

oops, let me check again

so, IIUC

bundle-metrics + bundle-build-metrics + container-build-metrics

should to be restored (or at least the first two)

razo7

NIT: Can you be (in a few places) more specific about which build/bundle are you building or testing?
Considering that upstream we are more K8s front, thus the general tests in upstream CI might be more relevant for K8s and less to OCP Prometheus

.github/workflows/pre-submit.yaml

razo7 · 2024-03-31T06:17:17Z

.github/workflows/pre-submit.yaml

@@ -30,7 +30,7 @@ jobs:
      run: make manifests bundle-k8s bundle-reset test


bundle-k8s?
If we are testing upstream OCP then it should be bundle-metrics-ocp, otherwise the Test container build OCP Prometheus should be changed to Test container build Kubernetes and the target below as well

This is for unittests and catching unwanted bundle changes (see ea5e7be), so it looks right to me. I'll make it clearer changing the name.

Regarding the "Test container build", while it is true we are more keen on k8s here, I think it would be better to test both, as it would be relevant to catch breaking changes at this early stage. For this reason I'd test both k8s and ocp container builds

wdyt?

Makefile

hack/ocp/test_create_bundle_ocp_image_in_quay.sh

razo7 · 2024-04-02T08:55:16Z

/lgtm
Giving a chance to get more reviews
/hold

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

…unittest action Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

slintes

👍🏼 🙂

openshift-ci · 2024-04-03T07:27:01Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: clobrano, slintes

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [clobrano,slintes]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

clobrano · 2024-04-03T10:02:56Z

/retest

clobrano · 2024-04-03T10:03:56Z

/unhold

clobrano added 3 commits March 20, 2024 10:52

Add optional bundle to enable user workload Prometheus

afccd3a

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

openshift-ci bot added the do-not-merge/work-in-progress label Mar 21, 2024

openshift-ci bot added the approved label Mar 21, 2024

clobrano changed the title ~~Add Prometheus configuration to bundle OCP~~ [WIP} Add Prometheus configuration to bundle OCP Mar 21, 2024

clobrano changed the title ~~[WIP} Add Prometheus configuration to bundle OCP~~ [WIP] Add Prometheus configuration to bundle OCP Mar 21, 2024

clobrano force-pushed the bundle-ocp-metrics-1 branch 6 times, most recently from bf283de to acb8d03 Compare March 21, 2024 08:55

clobrano changed the title ~~[WIP] Add Prometheus configuration to bundle OCP~~ Add Prometheus configuration to bundle OCP Mar 21, 2024

Renamed container-build target into container-build-ocp

e306893

The target was already building OCP bundle. Changing the name to reflect this behavior. Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

clobrano force-pushed the bundle-ocp-metrics-1 branch from acb8d03 to 12edc4d Compare March 21, 2024 09:42

Add test script to build OCP bundle with metrics in quay

8ecfe98

Add a test script to build the OCP bundle with prometheus metrics, but pushing the images to quay.io/username (not medik8s!) for testing. Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

clobrano force-pushed the bundle-ocp-metrics-1 branch from 12edc4d to 8ecfe98 Compare March 22, 2024 09:09

slintes requested changes Mar 22, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

config/manifests/ocp/deployment_patch.yaml Outdated Show resolved Hide resolved

config/optional/prometheus-ocp/readme.md Show resolved Hide resolved

config/optional/prometheus-ocp/readme.md Show resolved Hide resolved

openshift-ci bot assigned slintes Mar 22, 2024

clobrano added 4 commits March 22, 2024 15:55

Replace deprecated bearerTokenSecret with authorization

82b6c26

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

Remove target bundle-metrics-ocp

764b322

OCP Metrics configuration was moved in config/manifests/ocp and config/manifests/metrics-ocp removed, so this target is not useful anymore. Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

Better deployment_patch metadata.name

ac5c2d8

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

Improved prometheus-ocp readme

25e724f

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

slintes reviewed Mar 28, 2024

View reviewed changes

razo7 reviewed Mar 31, 2024

View reviewed changes

hack/ocp/test_create_bundle_ocp_image_in_quay.sh Outdated Show resolved Hide resolved

clobrano force-pushed the bundle-ocp-metrics-1 branch from aee9de0 to 9bce039 Compare April 2, 2024 08:35

openshift-ci bot assigned razo7 Apr 2, 2024

openshift-ci bot added do-not-merge/hold lgtm labels Apr 2, 2024

clobrano added 4 commits April 2, 2024 18:01

Removed unused Makefile targets

dc81a81

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

Fix typo

9316c31

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

pre-submit actions: test both k8s and ocp bundles builds and clarify …

72c8ff1

…unittest action Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

Makefile: improve targets descriptions

df551f1

Signed-off-by: Carlo Lobrano <c.lobrano@gmail.com>

clobrano force-pushed the bundle-ocp-metrics-1 branch from 9bce039 to df551f1 Compare April 2, 2024 16:01

openshift-ci bot removed the lgtm label Apr 2, 2024

slintes approved these changes Apr 3, 2024

View reviewed changes

openshift-ci bot added the lgtm label Apr 3, 2024

clobrano marked this pull request as ready for review April 3, 2024 08:04

openshift-ci bot removed the do-not-merge/work-in-progress label Apr 3, 2024

openshift-ci bot requested review from beekhof and mshitrit April 3, 2024 08:04

openshift-ci bot removed the do-not-merge/hold label Apr 3, 2024

openshift-merge-bot bot merged commit 1133f71 into medik8s:main Apr 3, 2024
19 checks passed

clobrano deleted the bundle-ocp-metrics-1 branch April 3, 2024 12:24

mshitrit mentioned this pull request Apr 9, 2024

leftovers from renaming container-build to container-build-ocp #317

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Prometheus configuration to bundle OCP #305

Add Prometheus configuration to bundle OCP #305

clobrano commented Mar 21, 2024

openshift-ci bot commented Mar 21, 2024

clobrano commented Mar 21, 2024

razo7 commented Mar 21, 2024

slintes Mar 28, 2024

clobrano Mar 28, 2024

slintes Apr 2, 2024

slintes Apr 2, 2024

clobrano Apr 2, 2024

clobrano Apr 2, 2024

razo7 left a comment

razo7 Mar 31, 2024

clobrano Apr 2, 2024

razo7 Apr 2, 2024

razo7 commented Apr 2, 2024

slintes left a comment

openshift-ci bot commented Apr 3, 2024

clobrano commented Apr 3, 2024

clobrano commented Apr 3, 2024

		@@ -30,7 +30,7 @@ jobs:
		run: make manifests bundle-k8s bundle-reset test

Add Prometheus configuration to bundle OCP #305

Add Prometheus configuration to bundle OCP #305

Conversation

clobrano commented Mar 21, 2024

Why we need this PR

Changes made

Which issue(s) this PR fixes

Test plan

openshift-ci bot commented Mar 21, 2024

clobrano commented Mar 21, 2024

razo7 commented Mar 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

razo7 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

razo7 commented Apr 2, 2024

slintes left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Apr 3, 2024

clobrano commented Apr 3, 2024

clobrano commented Apr 3, 2024