-
Bug
-
Resolution: Unresolved
-
Major
-
3.20.0.GA
-
False
-
-
False
-
-
Openshift Monitoring Documentation about Support considerations for monitoring contains Ambiguous statements regarding Service Monitor which leads to confusion among customers.
For instance, as per Openshift Dev Spaces Documentation, for Monitoring the Dev Workspace Operator, it is possible to create ServiceMonitor in openshift-* namespace, which by default is `openshift-devspaces` namespace.
While Installing Dev Spaces on OpenShift, customers can create a namespace called `openshift-devspaces` ( or they are free to choose any other name too) for che-cluster installation. This flexibility was granted to customers because the che-cluster pods are actually not a user workload instead the Openshift Dev Spaces Operator related pods.
And Since the pods running in openshift-devspaces namespace is part of che-cluster which is actually not a user workload instead the operator related pods, customers can create the the service monitor inside openshift-devspace namespace for configuring monitoring for Dev Workspace Operator. The steps are even outlined in our Openshift Dev Spaces Official Documentation too - (Monitoring the Dev Workspace Operator).
However, our Official Documentation for Monitoring mentions that "Creating additional ServiceMonitor, PodMonitor, and PrometheusRule objects in the openshift- and kube- projects is explicitly not supported"
This discrepancy between the two official documentations is causing confusions among customers.
Hence, it is better to update the monitoring documentation[1] to clarify that adding ServiceMonitor in openshift-* namespace for user-workload is not supported. However, creating ServiceMonitor for RedHat Provided Operator Components within openshift-* namespaces are permitted.
[1] Openshift Monitoring Documenation for Service Monitor - https://docs.redhat.com/en/documentation/red_hat_openshift_dev_spaces/3.18/html/administration_guide/configuring-devspaces#monitoring-the-dev-workspace-operator
[2] Openshift Dev Spaces Documentation for Service Monitor creation - https://docs.redhat.com/en/documentation/red_hat_openshift_dev_spaces/3.18/html/administration_guide/configuring-devspaces#monitoring-the-dev-workspace-operator
[3] Documenation for Red Hat Openshift Dev Spaces Installation - https://docs.redhat.com/en/documentation/red_hat_openshift_dev_spaces/3.13/html/administration_guide/installing-devspaces#installing-devspaces-on-openshift-using-the-web-console