Skip to content

CNV-9030 New UI for Virtual Machine Templates#28478

Merged
sjhala-ccs merged 1 commit intoopenshift:masterfrom
lmandavi:CNV-9030-vm-templates
Jan 29, 2021
Merged

CNV-9030 New UI for Virtual Machine Templates#28478
sjhala-ccs merged 1 commit intoopenshift:masterfrom
lmandavi:CNV-9030-vm-templates

Conversation

@lmandavi
Copy link
Copy Markdown
Contributor

@lmandavi lmandavi commented Jan 9, 2021

This PR is associated with CNV-9030. In the OpenShift Virtualization web console, a new UI has been introduced with major new features for virtual machine templates. We now provide preconfigured Red Hat templates for Linux, Windows, and Fedora. Users can open a preconfigured Red Hat template, customize it by adding a boot source, and create a customized template for creating multiple virtual machines.

The Templates tab lists all of the Red Hat templates and any custom templates created by users. Users have the flexibility to use either Red Hat templates or the interactive wizard to create virtual machine templates. By offering preconfigured Red Hat templates to our users, we make it easy for them to choose a template and quickly customize it for their needs.

Virtual machine templates provided by Red Hat cannot be edited or deleted. Users can, however, delete templates that they have created.

This new UI also impacts how our users use Red Hat templates to create virtual machines. The tasks applying to the creation of virtual machines by using Red Hat templates and custom templates are covered by a different Jira story that will be released for review when that PR is ready.

@openshift-ci-robot openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 9, 2021
@openshift-docs-preview-bot
Copy link
Copy Markdown

The preview will be available shortly at:

@lmandavi
Copy link
Copy Markdown
Contributor Author

lmandavi commented Jan 9, 2021

@jelkosz @yaacov
Requesting SME review and comments for this PR:

Creating virtual machine templates
https://cnv-9030-vm-templates--ocpdocs.netlify.app/openshift-enterprise/latest/virt/vm_templates/virt-creating-vm-template.html

Editing virtual machine templates
https://cnv-9030-vm-templates--ocpdocs.netlify.app/openshift-enterprise/latest/virt/vm_templates/virt-editing-vm-template.html

Enabling dedicated resources for virtual machines
https://cnv-9030-vm-templates--ocpdocs.netlify.app/openshift-enterprise/latest/virt/vm_templates/virt-dedicated-resources-vm-template.html

Deleting a virtual machine template
https://cnv-9030-vm-templates--ocpdocs.netlify.app/openshift-enterprise/latest/virt/vm_templates/virt-deleting-vm-template.html

For validating the doc content that I developed, I have used this build that Guohua has provided:

https://console-openshift-console.apps.uit02.cnv-qe.rhcloud.com/k8s/ns/openshift/virtualization

Please note that doc content for virtual machines will be provided through a different Jira story. This particular Jira story focuses only on virtual machine templates.

Comment thread modules/virt-creating-template-redhat-web.adoc Outdated
Comment thread modules/virt-template-fields-for-boot-source.adoc Outdated
Comment thread modules/virt-understanding-vm-templates.adoc Outdated
@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch from 7d14ae5 to 62133b7 Compare January 10, 2021 18:56
@yaacov
Copy link
Copy Markdown
Member

yaacov commented Jan 10, 2021

LGTM

@lmandavi
Copy link
Copy Markdown
Contributor Author

SME review was completed - many thanks to @yaacov for moving quickly with the SME review. @gouyang - requesting QE review.

Comment thread modules/virt-creating-template-wizard-web.adoc Outdated
Comment thread modules/virt-template-fields-for-boot-source.adoc Outdated
Comment thread modules/virt-template-fields-for-boot-source.adoc Outdated
Comment thread modules/virt-creating-template-redhat-web.adoc Outdated
@gouyang
Copy link
Copy Markdown

gouyang commented Jan 11, 2021

Some content on the preview page are not precisely any more, not sure whether it beyonds the PR. Just mention it here:

  1. https://cnv-9030-vm-templates--ocpdocs.netlify.app/openshift-enterprise/latest/virt/vm_templates/virt-editing-vm-template.html#virt-vm-edit-cdrom_virt-editing-vm-template

CDROM is not available in VM/VM template any more, should remove the whole section

  1. https://cnv-9030-vm-templates--ocpdocs.netlify.app/openshift-enterprise/latest/virt/vm_templates/virt-creating-vm-template.html#virt-vm-wizard-fields-web_virt-creating-vm-template

The bottom line of the table is missing.
Description of Persistent Volume Claim project is not correct

  1. https://cnv-9030-vm-templates--ocpdocs.netlify.app/openshift-enterprise/latest/virt/vm_templates/virt-creating-vm-template.html#virt-cloud-init-fields-web_virt-creating-vm-template

Authenticated SSH Keys renamed to Authorized SSH Keys

@lmandavi
Copy link
Copy Markdown
Contributor Author

@gouyang - Responding:

  1. I will run the build again, so you can see the updated HTML content.
  2. I am seeing CD-ROM in the VM Template screen, therefore I have retained the information about CD-ROM. See attached screenshot. (Also sent email to @yaacov and mentioning that I am seeing CD-ROM)
  3. I am looking into fixing the bottom line for the table.
  4. Please provide a correct description for Persistent Volume Claim project.

@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch from 62133b7 to 488af92 Compare January 11, 2021 16:23
Comment thread modules/virt-add-disk-to-vm.adoc Outdated
@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch from 488af92 to 58c0aae Compare January 11, 2021 19:07
@lmandavi
Copy link
Copy Markdown
Contributor Author

@gouyang I responded to your comments by email. CD-ROM stays in the Add source dialog. Please refer to my email and review the changes. Thanks, Lavanya

@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch from 58c0aae to eafc746 Compare January 11, 2021 19:42
@lmandavi
Copy link
Copy Markdown
Contributor Author

Comment thread modules/virt-template-fields-for-boot-source.adoc Outdated
Comment thread modules/virt-vm-wizard-fields-web.adoc Outdated
@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch from eafc746 to 9cd7d86 Compare January 12, 2021 15:59
@lmandavi
Copy link
Copy Markdown
Contributor Author

@gouyang Please review the doc content changes and advise if the changes look good for QE review completion.

@gouyang
Copy link
Copy Markdown

gouyang commented Jan 12, 2021

LGTM

@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch from 9cd7d86 to 16ee81e Compare January 13, 2021 21:40
@lmandavi
Copy link
Copy Markdown
Contributor Author

@gouyang Please review and approve the minor changes. Thanks!

@gouyang
Copy link
Copy Markdown

gouyang commented Jan 14, 2021

LGTM

@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch from 16ee81e to 5413b55 Compare January 14, 2021 15:27
@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch 2 times, most recently from 1ded0f9 to 55039b1 Compare January 22, 2021 18:23
@lmandavi
Copy link
Copy Markdown
Contributor Author

@yaacov @jelkosz I updated the topic heading to be: "Adding a boot source..." This was done to ensure that this was a generic topic that could be reused in our customer doc. Could you please review and approve. Thanks!

@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch from 55039b1 to 23c1f12 Compare January 23, 2021 21:57
@sjhala-ccs sjhala-ccs added the peer-review-done Signifies that the peer review team has reviewed this PR label Jan 27, 2021
Comment thread modules/virt-vm-wizard-fields-web.adoc Outdated
Copy link
Copy Markdown
Contributor

@aburdenthehand aburdenthehand left a comment

Choose a reason for hiding this comment

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

Some notes re: shared and conditionalised content.

Comment thread modules/virt-add-disk-to-vm.adoc Outdated
Comment thread modules/virt-vm-wizard-fields-web.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This now means that this text only appears in the Template wizard field, which doesn't seem right ("Template from which to create the virtual machine").
However it also no longer seems relevant to the VM wizard fields due to the workflow change. If true, we can remove this entirely.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Template, Template provider, Template support - these 3 items display only if the user selects Create virtual Machine Template. Therefore, they are embedded within the conditional expressions.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These seem to be the only differences between the VM and the Template wizard fields - and they seem to be marked up correctly for conditionals - but this is now a separate module.
This means that the conditionals here aren't doing anything, but also we have two locations to update in the future.
I highly recommend not duplicating this table, but including these conditionalised rows in the virt-vm-wizard-felds-web.adoc
Again - the conditionals here look correct, so you should be able to just copy lines 30-43 and pasting them at line 30 in the virt-vm-wizard-fields-web.adoc <-- in fact it looks like lines 30-34 are already there ready to go.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated virt-vm-wizard-fields-web.adoc and adding it to the assembly. Removing virt-vm-template-wizard-fields-web.adoc.

@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch 3 times, most recently from d0f6200 to e5b9a94 Compare January 28, 2021 22:24
@lmandavi
Copy link
Copy Markdown
Contributor Author

@aburdenthehand - please review the conditionals. Thanks.

@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch 8 times, most recently from f17861d to f6ecb08 Compare January 29, 2021 19:07
@openshift-ci-robot openshift-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 29, 2021
CNV-9030 New UI for Virtual Machine Templates

interactive and panes
@lmandavi lmandavi force-pushed the CNV-9030-vm-templates branch from f6ecb08 to ecae03e Compare January 29, 2021 19:17
@sjhala-ccs sjhala-ccs merged commit 4451682 into openshift:master Jan 29, 2021
@sjhala-ccs
Copy link
Copy Markdown
Contributor

sjhala-ccs commented Jan 29, 2021

/cherrypick enterprise-4.7

@openshift-cherrypick-robot
Copy link
Copy Markdown

openshift-cherrypick-robot commented Jan 29, 2021

@sjhala-ccs: new pull request created: #28976

Details

In response to this:

/cherrypick enterprise-4.7

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.

aburdenthehand added a commit to aburdenthehand/openshift-docs that referenced this pull request Feb 12, 2021
openshift-cherrypick-robot pushed a commit to openshift-cherrypick-robot/openshift-docs that referenced this pull request Feb 15, 2021
@yuvalk yuvalk mentioned this pull request Mar 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.7 CNV Label for all CNV PRs peer-review-done Signifies that the peer review team has reviewed this PR size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants