Bug 1799051 - Logging operator should make use of suggested namespace and cluster monitoring annotations
Summary: Logging operator should make use of suggested namespace and cluster monitorin...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Logging
Version: 4.4
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: 4.4.0
Assignee: Jeff Cantrill
QA Contact: Anping Li
URL:
Whiteboard: groom
Depends On:
Blocks: 1794825 1800794
TreeView+ depends on / blocked
 
Reported: 2020-02-06 14:27 UTC by Samuel Padgett
Modified: 2020-05-13 21:56 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: No Doc Update
Doc Text:
Clone Of:
Environment:
Version: 4.4.0-0.ci-2020-02-05-054333 Cluster ID: 81518fe6-b369-4934-80e0-1f2a793bce71 Browser: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:72.0) Gecko/20100101 Firefox/72.0
Last Closed: 2020-05-13 21:56:33 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift cluster-logging-operator pull 358 0 None closed Bug 1799051: Add OLM annotations for ui hints 2020-04-17 16:57:17 UTC
Github openshift elasticsearch-operator pull 233 0 None closed Bug 1799051: Add OLM annotations for ui hints 2020-04-17 16:57:17 UTC
Github openshift elasticsearch-operator pull 236 0 None closed Bug 1799051: Add OLM annotations for ui hints 2020-04-17 16:57:17 UTC
Red Hat Product Errata RHBA-2020:0581 0 None None None 2020-05-13 21:56:37 UTC

Description Samuel Padgett 2020-02-06 14:27:08 UTC
In 4.4, OpenShift console added support for two ClusterServiceVersion annotations:

* operatorframework.io/suggested-namespace - console will suggest and create the suggested namespace for the operator
* operatorframework.io/cluster-monitoring=true - console will ask the user if they want to enable monitoring the operator and apply the label to the created namespace

Operators that require a specific namespace and need to enable monitoring should add these annotations to give the UI hints. This will avoid extra steps requiring users to create and label the namespace outside of the UI.

More details in this enhancement:

https://github.com/openshift/enhancements/blob/master/enhancements/olm/olm-managed-operator-metrics.md#fulfilling-namespace-and-rbac-requirements

Here is the console PR:

https://github.com/openshift/console/pull/3862

Comment 1 Alexander Greene 2020-02-10 15:00:07 UTC
The suggested namespace annotation and cluster monitoring annotation documentation can be found here [1].

[1] https://docs.google.com/document/d/1Mru7pqkpx2gmxMxK6AYOLVphWW0mzwZG-R8_HBVxLwI/edit

Comment 3 Anping Li 2020-02-18 14:46:51 UTC
Verified.
anli@preserve-docker-slave 81366]$ oc get csv elasticsearch-operator.4.4.0-202002142031 -o json |jq '.metadata.annotations."olm.operatorNamespace"'
"openshift-operators-redhat"
[anli@preserve-docker-slave 81366]$ oc get csv clusterlogging.4.4.0-202002170216 -o json |jq '.metadata.annotations."olm.operatorNamespace"'
"openshift-logging"

Comment 4 Anping Li 2020-02-18 14:52:38 UTC
#oc get csv clusterlogging.4.4.0-202002170216 -o json |jq '.metadata.annotations."operatorframework.io/suggested-namespace"'
"openshift-logging"
#oc get csv elasticsearch-operator.4.4.0-202002142031 -o json |jq '.metadata.annotations."operatorframework.io/suggested-namespace"'
"openshift-operators-redhat"

Comment 6 errata-xmlrpc 2020-05-13 21:56:33 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2020:0581


Note You need to log in before you can comment on or make changes to this bug.