CNV-37570: Doc: use pipelines to manage VMs and boot sources

[sbeskin-redhat]

Resolves: https://issues.redhat.com/browse/CNV-37570

OCP 4.16
CNV 4.16

Preview:
https://77640--ocpdocs-pr.netlify.app/openshift-dedicated/latest/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.html#virt-creating-vm-instancetype_virt-creating-vms-from-instance-types

[openshift-ci-robot]

@sbeskin-redhat: This pull request references CNV-37570 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:

Resolves: https://issues.redhat.com/browse/CNV-37570

OCP 4.16
CNV 4.16

Preview:

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 openshift-eng/jira-lifecycle-plugin repository.

[ocpdocs-previewbot]

🤖 Wed Jul 03 21:53:10 - Prow CI generated the docs preview:

https://77640--ocpdocs-pr.netlify.app/openshift-dedicated/latest/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.html
https://77640--ocpdocs-pr.netlify.app/openshift-dedicated/latest/virt/virtual_machines/virt-accessing-vm-ssh.html
https://77640--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.html
https://77640--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/virtual_machines/virt-accessing-vm-ssh.html
https://77640--ocpdocs-pr.netlify.app/openshift-rosa/latest/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.html
https://77640--ocpdocs-pr.netlify.app/openshift-rosa/latest/virt/virtual_machines/virt-accessing-vm-ssh.html

[openshift-ci-robot]

@sbeskin-redhat: This pull request references CNV-37570 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:

Resolves: https://issues.redhat.com/browse/CNV-37570

OCP 4.16
CNV 4.16

Preview:
https://77640--ocpdocs-pr.netlify.app/openshift-dedicated/latest/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.html#virt-creating-vm-instancetype_virt-creating-vms-from-instance-types

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 openshift-eng/jira-lifecycle-plugin repository.

[yfrimanm]

Hi @sbeskin-redhat
In the second bullet:

Click Add volume to upload a new volume or use an existing persistent volume claim (PVC), volume snapshot, or data source. Then click Save.

I think we can simplify it and say “Click Add volume to upload a new volume or use an existing persistent volume claim (PVC). Then click Save.”
@dominikholler should we specify that this must be a DataSource?

I also think that this paragraph is too complexed:

If bootable volumes for a certain operating system (Windows, RHEL, or Linux) are missing in the list, this is indicated by the operating system logo that appears under the list. The logo is followed by a suggestion to add a volume for the missing operating system by clicking the Add volume link. In addition, there is a link to the Create a Windows boot source quick start. The same link appears in a popover if you hover the pointer over the question mark icon next to the Select volume to boot from line.

Maybe we can simplify it by saying something like "Logos of operating systems that are not available in the cluster are shown at the bottom of the list to hint the user that they can be added."

[dominikholler]

I think we can simplify it and say “Click Add volume to upload a new volume or use an existing persistent volume claim (PVC). Then click Save.”

The current doc matches the first line in the Add volume dialog. Technically correct would be
"Click 'Add volume' to upload a new volume or use an existing volume (PVC), snapshot or a containerdisk. Then click Save."
This might be adjusted also in the UI.

@dominikholler should we specify that this must be a DataSource?

The "Add volume" UI will ensure that a DataSource will be created, like expected, no need to explain this to the user.

[yfrimanm]

@dominikholler I am aware this matches the current text we currently have in the Add volume dialog.
We were thinking to simplify it and make it more user-friendly in the UI as well. WDYT?
cc @ronensdeor

[dominikholler]

I am aware this matches the current text we currently have in the Add volume dialog.
We were thinking to simplify it and make it more user-friendly in the UI as well. WDYT?

I like to support this idea. Would a generalization/abstraction instead of a list of examples be simpler?

“Click Add volume to use an already existing disk image”

[yfrimanm]

+1 on generalizing it.
I think we need to make it clear in the sentence that they have 2 options. Maybe something like:
“Click Add volume to upload a new volume or use an existing disk image from the volumes list. Then click Save.”

[sbeskin-redhat]

+1 on generalizing it. I think we need to make it clear in the sentence that they have 2 options. Maybe something like: “Click Add volume to upload a new volume or use an existing disk image from the volumes list. Then click Save.”

@yfrimanm Which list are you referring to here? Is it inside the 'Add volume' dialog?

[yfrimanm]

I meant the "Volumes list" that is shown in the 1st step "Select volume to boot from", but maybe I went too "high-level" here.

[sbeskin-redhat]

I meant the "Volumes list" that is shown in the 1st step "Select volume to boot from", but maybe I went too "high-level" here.

@yfrimanm I am a bit confused here. The user has 2 options - to choose a volume from the list displayed in the instanceTypes tab or to click 'Add volume'. If he clicks 'Add volume', the first line of the dialog says: Upload a new volume or use an existing PVC, snapshot or DataSource. Where are those 'existing' volumes appear? Is there an additional list somewhere?

[yfrimanm]

@sbeskin-redhat from the dialog users can select the source type: they can upload a new volume, they can use existing volume or volume snapshot and they can also import from URL or registry (but I'm not sure we need to mention the last option of the import).
The volumes list is under the "Show all" button, but they can also use the dialog as I mentioned above.

[sbeskin-redhat]

@yfrimanm
So when the dialog says 'existing volumes', it refers to the volumes of the list displayed in the instanceTypes tab? How does it make sense? The procedure looked logical up to this point - either you chose a volume from the list or you add a volume. But then, if you choose the option of adding a volume, you are again given the option of choosing a volume from the same list? Or am I missing something?

[ronensdeor]

'existing volumes' means volumes (or volume snapshots) that are on the cluster, or volumes that reside in a registry and the user needs to set the url to it. It will not show volumes that are already in the list

…

On Tue, Jun 25, 2024 at 6:30 PM Sasha Beskin ***@***.***> wrote: @yfrimanm <https://github.com/yfrimanm> So when the dialog says 'existing volumes', it refers to the volumes of the list displayed in the instanceTypes tab? How does it make sense? The procedure looked logical up to this point - either you chose a volume from the list or you add a volume. But then, if you choose the option of adding a volume, you are again given the option of choosing a volume from the same list? Or am I missing something? — Reply to this email directly, view it on GitHub <#77640 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AQZTZAS4Y5INKCMTQPT7FGLZJGEKZAVCNFSM6AAAAABJQBXOBKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCOBZGI3DQNBYGU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[sbeskin-redhat]

@ronensdeor Oh, I see, thank you.

[sbeskin-redhat]

/label peer-review-needed

[jldohmann]

It's looking good! just some minor comments and suggestions below

[sbeskin-redhat]

@jldohmann Thank you for the review!

[openshift-ci]

@sbeskin-redhat: all tests passed!

Full PR test history. Your PR dashboard.

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-sigs/prow repository. I understand the commands that are listed here.

[sbeskin-redhat]

/label merge-review-needed

[sheriff-rh]

Changes LGTM, merging to 4.16+.

[sheriff-rh]

/cherrypick enterprise-4.17

[sheriff-rh]

/cherrypick enterprise-4.16

[openshift-cherrypick-robot]

@sheriff-rh: new pull request created: #78546

In response to this:

/cherrypick enterprise-4.17

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-sigs/prow repository.

[openshift-cherrypick-robot]

@sheriff-rh: new pull request created: #78547

In response to this:

/cherrypick enterprise-4.16

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-sigs/prow repository.

[sbeskin-redhat]

@sheriff-rh Thank you!