Bug 1877487

Summary: ConsoleNotification API doc does not describe valid location values
Product: OpenShift Container Platform Reporter: Samuel Padgett <spadgett>
Component: Management ConsoleAssignee: Robb Hamilton <rhamilto>
Status: CLOSED ERRATA QA Contact: Yadan Pei <yapei>
Severity: medium Docs Contact:
Priority: medium    
Version: 4.6CC: aos-bugs, jhadvig, jokerman, yapei
Target Milestone: ---   
Target Release: 4.6.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Version: 4.6.0-0.nightly-2020-09-09-083207 Cluster ID: bc9c94b2-1adb-47e5-91d2-0b20739e8fb0 Browser: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:81.0) Gecko/20100101 Firefox/81.0
Last Closed: 2020-10-27 16:39:32 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Samuel Padgett 2020-09-09 18:01:57 UTC
ConsoleNotification has a `spec.location` property that lets you specify where the notification should appear. The API doc does not explain what the valid values are, however.


$ oc explain consolenotifications.spec
KIND:     ConsoleNotification
VERSION:  console.openshift.io/v1

RESOURCE: spec <Object>

DESCRIPTION:
     ConsoleNotificationSpec is the desired console notification configuration.

FIELDS:
   backgroundColor      <string>
     backgroundColor is the color of the background for the notification as CSS
     data type color.

   color        <string>
     color is the color of the text for the notification as CSS data type color.

   link <Object>
     link is an object that holds notification link details.

   location     <string>
     location is the location of the notification in the console.

   text <string> -required-
     text is the visible text of the notification.

Comment 2 Samuel Padgett 2020-09-22 15:30:26 UTC
Moving back to ASSIGNED. console-operator needs to vendor the openshift/api changes.

Comment 5 Yadan Pei 2020-10-09 09:19:18 UTC
# oc version
Client Version: openshift-clients-4.6.0-202006250705.p0-162-g074039a0a
Server Version: 4.6.0-0.nightly-2020-10-08-182439
Kubernetes Version: v1.19.0+db1fc96

# oc explain consolenotifications.spec
KIND:     ConsoleNotification
VERSION:  console.openshift.io/v1

RESOURCE: spec <Object>

DESCRIPTION:
     ConsoleNotificationSpec is the desired console notification configuration.

FIELDS:
   backgroundColor	<string>
     backgroundColor is the color of the background for the notification as CSS
     data type color.

   color	<string>
     color is the color of the text for the notification as CSS data type color.

   link	<Object>
     link is an object that holds notification link details.

   location	<string>
     location is the location of the notification in the console. Valid values
     are: "BannerTop", "BannerBottom", "BannerTopBottom".

   text	<string> -required-
     text is the visible text of the notification.


In `oc explain consolenotifications.spec` we can see valid values for 'location'

Moving to VERIFIED

Comment 7 errata-xmlrpc 2020-10-27 16:39:32 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 (OpenShift Container Platform 4.6 GA Images), 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:4196