Bug 1877487 - ConsoleNotification API doc does not describe valid location values
Summary: ConsoleNotification API doc does not describe valid location values
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Management Console
Version: 4.6
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: 4.6.0
Assignee: Robb Hamilton
QA Contact: Yadan Pei
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-09-09 18:01 UTC by Samuel Padgett
Modified: 2020-10-27 16:39 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
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
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift api pull 735 0 None closed Bug 1877487: add valid values for ConsoleNotification location 2020-10-12 14:13:05 UTC
Github openshift console-operator pull 473 0 None closed Bug 1877487: Bump vendor to pick fix from openshift/api 2020-10-12 14:13:05 UTC
Red Hat Product Errata RHBA-2020:4196 0 None None None 2020-10-27 16:39:48 UTC

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


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