Bug 2096285

Summary:	KubeVirt CR API documentation is missing docs for many fields
Product:	Container Native Virtualization (CNV)	Reporter:	Fabian Deutsch <fdeutsch>
Component:	Virtualization	Assignee:	Jed Lejosne <jlejosne>
Status:	CLOSED ERRATA	QA Contact:	Akriti Gupta <akrgupta>
Severity:	medium	Docs Contact:
Priority:	high
Version:	4.10.0	CC:	acardace, jlejosne
Target Milestone:	---
Target Release:	4.12.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	hco-bundle-registry-container- v4.12.0-561	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2023-01-24 13:36:39 UTC	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:

Description Fabian Deutsch 2022-06-13 12:41:06 UTC

Description of problem:
http://kubevirt.io/api-reference/main/definitions.html#_v1_kubevirtconfiguration is missing documentation for many fields in the KubeVirt CR

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

How reproducible:
Always

Steps to Reproduce:
1. Visit http://kubevirt.io/api-reference/main/definitions.html#_v1_kubevirtconfiguration
2. Explain the semantics of i.e the cpuModel field based on the documentation
3.

Actual results:
Doc for cpuModel is empty

Expected results:
API Doc for all fields is available

Additional info:
This is about upstream API documentation which is missing for i.e. KubeVirt CR

Comment 1 sgott 2022-06-13 21:15:14 UTC

This BZ appears to be about an upstream issue. Does this also affect the OpenShift Virtualization product?

Comment 2 Fabian Deutsch 2022-06-14 07:32:44 UTC

Indirectly. There will be no API suggestions/help in the UI, as it relies on OpenAPI (relying on the same source the upstream API docs use) and the docs team will have no good point to learn about these fields.

Comment 3 Jed Lejosne 2022-07-28 19:06:55 UTC

Opened a PR to add some of the missing descriptions, but definitely not all:
https://github.com/kubevirt/kubevirt/pull/8208

Comment 4 Akriti Gupta 2022-10-11 18:27:32 UTC

API Doc for all for the KubeVirt CR fields is available here http://kubevirt.io/api-reference/main/definitions.html#_v1_kubevirtconfiguration

Comment 8 errata-xmlrpc 2023-01-24 13:36:39 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 (Important: OpenShift Virtualization 4.12.0 Images security 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-2023:0408