Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug 1794825: Operator-defined namespace that requests monitoring should fully warn user of implications of enabling #4120

Merged
merged 1 commit into from Jan 31, 2020

Conversation

jhadvig
Copy link
Member

@jhadvig jhadvig commented Jan 30, 2020

Adding a warning alert to emphasise to the users what the implications of allowing any workload to contribute metrics are. The wording is taken from the bug's Doc Text.

Here I'm not really sure if it does make sense since the warning alert will be shown in case only when openshift-* namespace is selected as Installed Namespace. Is that on purpose

Also the Doc Text is pointing to 4.2 docs. Should we use 4.3 instead?

Last thing, wanted to ask if there shouldn’t also be a checkbox for enabling the monitoring when user picks from an existing namespace and the operator has openshift.io/cluster-monitoring annotation defined. Or there was an agreement that the checkbox will be only shown when using the recommended namespace ?

@shawn-hurley @itsptk could you help here?

Screen:
Screenshot 2020-01-30 at 11 03 41

/assign @spadgett

@openshift-ci-robot openshift-ci-robot added the bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. label Jan 30, 2020
@openshift-ci-robot
Copy link
Contributor

@jhadvig: This pull request references Bugzilla bug 1794825, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Bug 1794825: Operator-defined namespace that requests monitoring should fully warn user of implications of enabling

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci-robot openshift-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 30, 2020
@openshift-ci-robot openshift-ci-robot added component/olm Related to OLM approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 30, 2020
@jhadvig jhadvig force-pushed the bz1794825 branch 2 times, most recently from 0709853 to 08cc849 Compare January 30, 2020 11:53
@spadgett
Copy link
Member

Here I'm not really sure if it does make sense since the warning alert will be shown in case only when openshift-* namespace is selected as Installed Namespace. Is that on purpose

Yes, you can't currently enable monitoring for non-openshift namespaces.

Also the Doc Text is pointing to 4.2 docs. Should we use 4.3 instead?

Using openshiftHelpBase will point to the right version of the docs for the cluster.

Last thing, wanted to ask if there shouldn’t also be a checkbox for enabling the monitoring when user picks from an existing namespace and the operator has openshift.io/cluster-monitoring annotation defined. Or there was an agreement that the checkbox will be only shown when using the recommended namespace ?

We tried to keep it simple for 4.4 to get the basic implementation done.

@jhadvig
Copy link
Member Author

jhadvig commented Jan 30, 2020

@spadgett comments addressed.

Screen:
Screenshot 2020-01-30 at 15 08 59

@itsptk
Copy link

itsptk commented Jan 30, 2020

@jhadvig I was expecting this new text to replace the existing "Note: Enabling monitoring will allow any operator or workload running on this namespace to contribute metrics to the cluster metric set." I don't think we need both and not sure we need to use the inline alert control.

If we really wanted to use the alert I would say remove the existing "Note:" text and just show the inline alert when the user checks to Enable monitoring.

@jhadvig
Copy link
Member Author

jhadvig commented Jan 30, 2020

@itsptk if we want to emphasise the consequences from enabling the monitoring I would keep the Alert instead of the small note.
@spadgett thoughts ?

@spadgett
Copy link
Member

@bparees fyi

@spadgett
Copy link
Member

@shawn-hurley Is it reasonable to remove the warning if the provider type is Red Hat? Console currently reads the opsrc-provider label on the PackageManifest.

If we can hide it for Red Hat operators, I would vote for the stronger warning. Agree w/ @itsptk that we shouldn't show it twice :)

@shawn-hurley
Copy link

I think that was agreed upon @spadgett

I am also a +1 on the stronger message and only showing one.

@itsptk
Copy link

itsptk commented Jan 30, 2020

I agree that if we aren't always going to show this alert (only when the provider isn't Red Hat) then the alert would be best and the Note: should be removed.

I am changing my mind and thinking that we should show the alert regardless if the box is checked or not, so the user is aware of the implications of checking it before they check it, and not just surprised with a warning for something the UI said was recommended.

@@ -352,6 +354,22 @@ export const OperatorHubSubscribeForm: React.FC<OperatorHubSubscribeFormProps> =
Note: Enabling monitoring will allow any operator or workload running on this namespace
to contribute metrics to the cluster metric set.
</small>
<Alert
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Alert
{props.packageManifest.data[0].metadata.labels['opsrc-provider'] !== 'redhat' && <Alert

@kyoto
Copy link
Member

kyoto commented Jan 31, 2020

FYI @openshift/openshift-team-monitoring

Copy link

@lilic lilic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 👍

…ld fully warn user of implications of enabling
@jhadvig
Copy link
Member Author

jhadvig commented Jan 31, 2020

@spadgett comment addressed. Screen:

Screenshot 2020-01-31 at 11 27 52

PTAL

@itsptk
Copy link

itsptk commented Jan 31, 2020

There's definitely a lot going on in the UI in this scenario (namespace being created, requesting monitoring,) but I think it is worth being verbose so the user understands whats happening.

LGTM

@spadgett
Copy link
Member

/test analyze

Copy link
Member

@spadgett spadgett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve
/lgtm

Thanks @jhadvig

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 31, 2020
@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jhadvig, LiliC, spadgett

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit 46b8a85 into openshift:master Jan 31, 2020
@openshift-ci-robot
Copy link
Contributor

@jhadvig: All pull requests linked via external trackers have merged. Bugzilla bug 1794825 has been moved to the MODIFIED state.

In response to this:

Bug 1794825: Operator-defined namespace that requests monitoring should fully warn user of implications of enabling

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@spadgett spadgett added this to the v4.4 milestone Feb 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. component/olm Related to OLM lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants