Bug 2221939 - Help user find where to add static public SSH key
Summary: Help user find where to add static public SSH key
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: User Experience
Version: 4.14.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: 4.14.0
Assignee: Hilda Stastna
QA Contact: Guohua Ouyang
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-07-11 10:46 UTC by Avital Pinnick
Modified: 2023-07-27 08:16 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-07-25 15:11:46 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
Adding dynamic SSH key (14.16 KB, image/png)
2023-07-11 10:46 UTC, Avital Pinnick
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Github kubevirt-ui kubevirt-plugin pull 1395 0 None open Bug 2221939: Add help icon with text to SSH key field in M Sctips tab 2023-07-11 18:45:09 UTC
Github kubevirt-ui kubevirt-plugin pull 1425 0 None open Bug 2221939: Remove help icon for SSH key field in VM Sctips tab 2023-07-25 15:28:20 UTC
Red Hat Issue Tracker CNV-30864 0 None None None 2023-07-11 10:49:12 UTC

Description Avital Pinnick 2023-07-11 10:46:26 UTC
Created attachment 1975117 [details]
Adding dynamic SSH key

In 4.14, on the VM details page, only dynamic SSH key management appears on the Configuration > Scripts tab. The user has no way of knowing how to add a static key unless they read the docs. 

This is high priority because this is a major change from 4.13, where user adds key on the VM Scripts tab.

I recommend adding a tooltip on the Scripts tab saying that static SSH keys can be added on Overview > Settings > User > Manage SSH keys.

Comment 2 Hilda Stastna 2023-07-11 11:49:29 UTC
Hi Avital, what should be the exact help text for the tooltip being added to VM Configuration > Scripts tab?
Yifat, do you agree on adding "?" icon with the help text to the appropriate place? Thanks in advance!

Comment 3 Yifat Menchik 2023-07-11 12:40:50 UTC
Thanks @hstastna yes, please do.

Comment 4 Aviv Turgeman 2023-07-19 08:53:23 UTC
Hi @apinnick 

2 things changed regarding keys between 4.13 to 4.14 from UI perspective:
1. Some VMs in some conditions can add a dynamic SSH key to the VM after the initial boot.
1. We added an option to make a default ssh key in a namespace which will be defined as a static key on VM creation.
beyond that static keys remain as they were, if one wasn't defined on the initial boot, it wouldn't work.
Since this bug is not presenting any critical flow errors nor any new regressions I move the priority on this bug to 'medium' as it's nice to have.

Comment 5 Avital Pinnick 2023-07-20 09:55:53 UTC
You moved a function, "Adding static key", from VM details > Scripts tab (adding static key to a single VM) to Overview page > Settings tab > User tab (adding static key to future VMs created in namespace). 

If a user tries to follow the 4.13 workflow (Create VM on "Template catalog" tab without booting it immediately, so that static key can be added), how will they know where to find the setting? 

The InstanceType tab has the "Authorized SSH key" setting close to the "Dynamic SSH key" injection setting on the "VM details section", so figuring out where to add the static key will not be a problem for users who enable the InstanceType tab. However, the InstanceType tab is TP in 4.14, so it will not be enabled in production environments.

When a UI function changes between versions, it is a frustrating user experience. I am not sure how a user would figure out where to add a static key, which is required for every OS except RHEL9, which supports dynamic keys. Maybe add yet another help text saying that the "Authorized SSH key" setting is now called "Manage SSH keys" and is in a different place.

Comment 6 Tal Tobias 2023-07-20 11:37:46 UTC
Hi @apinnick I think we need to make a short call to be aligned with the design if this is not clear-

We *didn't move the function to add a static key. It remains the same as the 4.13 workflow- When the user creates a VM on "Template Catalog", he can add it before the VM creation under the Customize VM, Scripts tab.

What we're adding is the InstanceTypes and it will have the same behavior as the Template catalog. 

Another thing we're adding is the "User settings", that will give users a centralized place to manage all of their keys. this is a bonus thing, and the user not have to use this in order to add a key to a VM.

I hope it was clear, and if not let me know and we'll make a short call.

Thank you.

Comment 7 Avital Pinnick 2023-07-20 13:27:23 UTC
I met with Tal and now things are much clearer. I see how the user can add a static key when customizing the template, before creating the VM. I do think that the second page of "Customize VirtualMachine" should have a different title because "Review and create VirtualMachine" implies that the user can only review the changes and create the VM. In reality, the user can make more changes on the tabs of this page of the modal. BTW, I think most users do not expect a wizard inside a modal. Usually a user just makes a change and clicks a button on a modal.

I will do the following:
- Update the static key documentation in my current PR.
- Create a docs task to add more info about "Customize VM"
- Create a bug to change the title "Review and create..." to something that indicates that there are more configurations.

Comment 8 Guohua Ouyang 2023-07-25 05:40:25 UTC
Hi Hilda,
Do you think should we also apply the changes to the catalog -> VM scripts tab and template scripts tab?

Comment 9 Hilda Stastna 2023-07-25 13:02:14 UTC
Hi Yifat, WDYT about the question in Comment 8? Thanks in advance!

Comment 10 Tal Tobias 2023-07-25 13:12:52 UTC
@

Comment 11 Tal Tobias 2023-07-25 13:19:59 UTC
Hey guys, this bug needs to be closed.

In my talk with Avital, I explained to her that we don't need to help users find where to add a static public SSH key, since it remains in the same place.

Adding a static key is still on the Configuration > Scripts tab. Therefore, no change or tooltip is needed.



*Regarding the "Manage SSH keys" this is something else, a new way to let users manage their SSH keys across the all cluster.

Comment 12 Avital Pinnick 2023-07-25 13:24:12 UTC
I agree with Tal, that nothing more needs to be done. I updated the documentation for adding a static key to VM while creating it in UI (4.14), created a docs task to mention the "Customize VM" options. I see that the changes for renaming the "Review and create VM" have been started. So I will close this bug.

Comment 13 Hilda Stastna 2023-07-25 13:41:32 UTC
Tal, Avital,

I already added a popover to VM Scripts 2 weeks ago, regarding this task, see: https://github.com/kubevirt-ui/kubevirt-plugin/pull/1395
Are you saying we need to remove it? Thanks.

Comment 14 Tal Tobias 2023-07-25 14:12:09 UTC
@hstastna Yes, this should be removed.
Thanks

Comment 15 Hilda Stastna 2023-07-25 15:11:13 UTC
So if the change I've made should be removed, it means this ticket is not done. However I am not sure how to change its status.

Comment 16 Hilda Stastna 2023-07-25 15:27:49 UTC
PR that is removing the popover: https://github.com/kubevirt-ui/kubevirt-plugin/pull/1425


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