Bug 1732329 - Virtual Machine is missing documentation of its properties in yaml editor
Summary: Virtual Machine is missing documentation of its properties in yaml editor
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: Virtualization
Version: 2.1.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: 2.6.0
Assignee: lpivarc
QA Contact: Israel Pinto
URL:
Whiteboard:
Depends On: 1860714
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-07-23 07:41 UTC by Radim Hrazdil
Modified: 2021-03-10 11:17 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-03-10 11:16:12 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
VM and Pod Yaml editor pages (322.52 KB, application/zip)
2019-07-23 07:41 UTC, Radim Hrazdil
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Github kubevirt kubevirt issues 2530 0 'None' closed description and properties are missing in swagger JSON 2020-12-15 02:03:48 UTC
Github kubevirt kubevirt pull 3257 0 None closed Explain vm/i 2020-12-15 02:03:19 UTC
Red Hat Product Errata RHSA-2021:0799 0 None None None 2021-03-10 11:17:36 UTC

Description Radim Hrazdil 2019-07-23 07:41:31 UTC
Created attachment 1592788 [details]
VM and Pod Yaml editor pages

Description of problem:
OCP Management console provides documentation of properties of created resources in YAML editor page. See attached screenshots of VM and Pod YAML editor pages.
 
This documentation is currently missing for Virtual Machines.

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

How reproducible:
100%

Steps to Reproduce:
1. Create a VM and navigate to its yaml page
2.
3.

Actual results:
Side panel with documentation is empty

Expected results:
there should be documentation of VM properties to keep the UI consistent

Additional info:

Comment 1 Filip Krepinsky 2019-07-25 17:43:21 UTC
this is not caused by UI but the missing information is propagated from the API. I filed a bug against kubevirt: https://github.com/kubevirt/kubevirt/issues/2530

Comment 2 Tomas Jelinek 2019-07-31 11:45:48 UTC
moving this to virt group to since the work will be done there.

Comment 3 Marc Sluiter 2019-08-08 06:48:00 UTC
I finally found out what is causing this:

a) we don't have a openapi validation schema on our CRDs (wasn't needed until now, validation is done by our apiserver/webhook)
b) even if we have, this is a feature gated alpha feature in k8s 1.14, see https://github.com/kubernetes/enhancements/issues/692

Before I go on with this, I see if I get acks for this.

Comment 6 sgott 2019-11-06 14:07:49 UTC
This depends on https://github.com/kubernetes/enhancements/issues/692 which was released as stable in k8s 1.16

Comment 8 Kedar Bidarkar 2020-09-09 12:20:55 UTC
  Fix for this https://bugzilla.redhat.com/show_bug.cgi?id=1860714 bug would also cover this bug.

Comment 10 zhe peng 2020-12-15 06:44:59 UTC
Verify with CNV2.6.0
$ oc version
Client Version: 4.6.0-0.nightly-2020-07-25-091217
Server Version: 4.7.0-0.nightly-2020-12-14-165231
Kubernetes Version: v1.19.2+e386040

step:
1. create vm 
2. check vm side panel
there have documentation of VM properties

Virtual Machine
Schema
VirtualMachine handles the VirtualMachines that are not running or are in a stopped state The VirtualMachine 
contains the template to create the VirtualMachineInstance. It also mirrors the running state of the created 
VirtualMachineInstance in its status.
apiVersion
....

Comment 13 errata-xmlrpc 2021-03-10 11:16:12 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: OpenShift Virtualization 2.6.0 security and bug fix update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2021:0799


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