Bug 2096285 - KubeVirt CR API documentation is missing docs for many fields
Summary: KubeVirt CR API documentation is missing docs for many fields
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: Virtualization
Version: 4.10.0
Hardware: Unspecified
OS: Unspecified
high
medium
Target Milestone: ---
: 4.12.0
Assignee: Jed Lejosne
QA Contact: Akriti Gupta
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-06-13 12:41 UTC by Fabian Deutsch
Modified: 2023-01-24 13:36 UTC (History)
2 users (show)

Fixed In Version: hco-bundle-registry-container- v4.12.0-561
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-01-24 13:36:39 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github kubevirt kubevirt pull 8208 0 None open Add CR API documentation for developer and migration configuration 2022-09-28 10:28:32 UTC
Red Hat Issue Tracker CNV-19081 0 None None None 2022-12-15 08:39:08 UTC
Red Hat Product Errata RHSA-2023:0408 0 None None None 2023-01-24 13:36:49 UTC

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
Note You need to log in before you can comment on or make changes to this bug.