Bug 2196912

Summary:

Missing and confusing help texts for CPU number calculations

Product:

Container Native Virtualization (CNV)

Reporter:

Hilda Stastna <hstastna>

Component:

User Experience

Assignee:

Hilda Stastna <hstastna>

Status:

VERIFIED ---

QA Contact:

Guohua Ouyang <gouyang>

Severity:

low

Docs Contact:

Priority:

unspecified

Version:

4.13.0

CC:

apinnick, gouyang, yfrimanm

Target Milestone:

---

Target Release:

4.14.0

Hardware:

Unspecified

OS:

Unspecified

Whiteboard:

Fixed In Version:

Doc Type:

If docs needed, set a value

Doc Text:

Story Points:

---

Clone Of:

Environment:

Last Closed:

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:

Attachments:

Description	Flags
Correct help text present in VM Details tab	none

Description Hilda Stastna 2023-05-10 18:50:59 UTC

Created attachment 1963829 [details]
Correct help text present in VM Details tab

Description of problem:
There's missing help text explaining CPU calculations in Catalog drawer
for "CPU | Memory" field and misleading help texts for the same field
present in more places:
- Template Details tab
- Review and create VirtualMachine page (customize VM)
- VirtualMachineInstance Details tab

Version-Release number of selected component (if applicable):
4.13

How reproducible:
always

Steps to Reproduce:
1. Access Catalog drawer or any of the problematic places mentioned above
2. Check "CPU | Memory" field in the page

Actual results:
Missing help text explaining CPU calculations in Catalog drawer.
And in the misleading help texts, it says "This VirtualMachine ..."
although it's for the other resource, not a VM, or a VM is just being
created, not existing yet, which is confusing. 
That means 4 places with presence of "CPU | Memory" waiting for improvement.

Expected results:
The expected results for Templates and for VMIs are not clear yet. But it's
clear that the help texts shouldn't be confusing. They shouldn't display
"This VirtualMachine has ..." anywhere else except VM Details page.

For missing help text in the drawer and incorrect help text when
customizing VM, "The VirtualMachine will have ..." could be displayed instead.
See https://bugzilla.redhat.com/show_bug.cgi?id=2172390#c16

Additional info:

Possible solutions for Templates and VMIs:
The help text may reflect the resource that is related to the provided information.
Maybe "This Template has..."... or "This VirtualMachineInstance has...".

Another solution is to make it more universal by NOT mentioning "VirtualMachine"
or any specific resource at all, so we could use the same help text for
"CPU | Memory" field anywhere in the whole UI.
Maybe we could display "This resource has 1 sockets, 1 threads, and 3 cores."
That would be the best, IMO.

Comment 5 Yifat Menchik 2023-05-24 07:25:53 UTC

I would vote for avoiding "This resource" terminology. I think users would expect something more concrete and easy to understand, so I like the first suggestion much better ("This Template has..."... or "This VirtualMachineInstance has..."). It's also more aligned with what we have for this bug https://bugzilla.redhat.com/show_bug.cgi?id=2172390#c16

Comment 6 Hilda Stastna 2023-05-24 09:40:46 UTC

(In reply to Yifat Menchik from comment #5)
> I would vote for avoiding "This resource" terminology. I think users would
> expect something more concrete and easy to understand, so I like the first
> suggestion much better ("This Template has..."... or "This
> VirtualMachineInstance has..."). It's also more aligned with what we have
> for this bug https://bugzilla.redhat.com/show_bug.cgi?id=2172390#c16

Makes sense, just it would make the code more complicated, as we use the same component for VMs, Templates, etc..

Comment 7 Yifat Menchik 2023-05-24 09:52:46 UTC

@apinnick can you please advise? Thank you.

Comment 8 Avital Pinnick 2023-05-24 10:17:51 UTC

(In reply to Yifat Menchik from comment #7)
> @apinnick can you please advise? Thank you.

I also prefer the first option, to have the help text say "Template" or "VirtualMachineInstance" instead of "Resource". Can the component detect its context so that the correct resource name would appear?

Comment 9 Hilda Stastna 2023-05-24 10:34:13 UTC

(In reply to Avital Pinnick from comment #8)
> (In reply to Yifat Menchik from comment #7)
> > @apinnick can you please advise? Thank you.
> 
> I also prefer the first option, to have the help text say "Template" or
> "VirtualMachineInstance" instead of "Resource". Can the component detect its
> context so that the correct resource name would appear?

I don't know yet. But it should be doable somehow.

Comment 10 Hilda Stastna 2023-05-30 10:21:03 UTC

Hi Avital,

and what would you suggest for VirtualMachineTemplate resource help text? Which option is better?
 'The VirtualMachineTemplate has {{sockets}} sockets, {{threads}} threads, and {{cores}} cores.'
or
 'The Template has {{sockets}} sockets, {{threads}} threads, and {{cores}} cores.'
Thanks.

Comment 11 Hilda Stastna 2023-05-31 11:21:53 UTC

Hi Avital,

another, 3rd option for templates help text could also be:
'The template has {{sockets}} sockets, {{threads}} threads, and {{cores}} cores.'
- see the small 't' for template.

Comment 12 Avital Pinnick 2023-06-06 13:47:15 UTC

(In reply to Hilda Stastna from comment #11)
> Hi Avital,
> 
> another, 3rd option for templates help text could also be:
> 'The template has {{sockets}} sockets, {{threads}} threads, and {{cores}}
> cores.'
> - see the small 't' for template.

LGTM

Comment 13 Guohua Ouyang 2023-07-14 03:23:46 UTC

verified on kubevirt-console-plugin-rhel9:v4.14.0-2121