openshift-ci-robot
commented
4 months ago @jhadvig: This pull request references CONSOLE-4163 which is a valid jira issue.
Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.17.0" version, but no target version was set.
In response to [this](https://github.com/openshift/api/pull/1956):
>Adding new `widgets` field into the `ConsoleCustomization` struct.
>The purpose of this field is to have set of predefined UI widgets, in this case the Lightspeed button, and their state.
>The Lightspeed button should serve as a cluster wide setting for showing/hidding the button to all cluster users. The `widgets` field can also be easily extended with additional widgets (buttons, icons, ...)
>Pros:
>- the `lightspeedButton` field will be part of the config by default
>- `widgets` can be easily extended with new UI widgets/elements
>
>Cons:
> - downside of this solution is if we decide to get rid of the Lightspeed button, or any predefined widget, we would need to deprecate the particular widget field, and we will set its default value to a different state (... that said, im not sure if that wont be a breaking change...)
>
>
>Other possible solution would be to have an array of widgets:
>```go
>// WidgetState defines the state of the widget.
>type WidgetState string
>
>const (
> WidgetShow WidgetState = "Show"
> WidgetHide WidgetState = "Hide"
>)
>
>// Widgets contains set of UI widgets in the console UI.
>type Widget struct {
> // +kubebuilder:validation:Enum:="Show";"Hide";
> // +kubebuilder:default:="Show"
> // +kubebuilder:validation:Required
> State WidgetState `json:"lightspeedButton"`
> // id of the widget
> // +kubebuilder:validation:Required
> ID string `json:"id"`
>}
>
>// ConsoleCustomization defines a list of optional configuration for the console UI.
>type ConsoleCustomization struct {
> // widgets define set of widgets that can be interacted with in the console UI.
> // +kubebuilder:validation:Optional
> Widgets []Widget `json:"widgets"`
>```
>In this case we wont need to worry about the deprecation of any predefined widget, simply if we wont need it anymore, or there will be a particular change ,we can just leave it out of the `widgets` array.
>On the other hand the Lightspeed button wont be part of the default config, instead it will need to be part of all the console-operator's config when creating cluster.
>
>/assign @JoelSpeed
>
>cc'ing @spadgett @rhamilto
>
>
Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=openshift%2Fapi). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.
openshift-ci[bot]
jhadvig
JoelSpeed
yapei
openshift-bot
Adding new
widgetsfield into theConsoleCustomizationstruct. The purpose of this field is to have set of predefined UI widgets, in this case the Lightspeed button, and their state. The Lightspeed button should serve as a cluster wide setting for showing/hidding the button to all cluster users. Thewidgetsfield can also be easily extended with additional widgets (buttons, icons, ...) Pros:lightspeedButtonfield will be part of the config by defaultwidgetscan be easily extended with new UI widgets/elementsCons:
Other possible solution would be to have an array of widgets:
In this case we wont need to worry about the deprecation of any predefined widget, simply if we wont need it anymore, or there will be a particular change ,we can just leave it out of the
widgetsarray. On the other hand the Lightspeed button wont be part of the default config, instead it will need to be part of all the console-operator's config when creating cluster./assign @JoelSpeed
cc'ing @spadgett @rhamilto