Bug 1735728

Summary: [sriov] should add the description for the CR when using 'oc explain'
Product: OpenShift Container Platform Reporter: zhaozhanqi <zzhao>
Component: NetworkingAssignee: Peng Liu <pliu>
Status: CLOSED ERRATA QA Contact: zhaozhanqi <zzhao>
Severity: low Docs Contact:
Priority: medium    
Version: 4.2.0CC: aos-bugs, cdc
Target Milestone: ---   
Target Release: 4.2.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-10-16 06:34:15 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 zhaozhanqi 2019-08-01 10:42:58 UTC
Description of problem:
some filed of sriov CR is <empty> when using `oc explain`, eg

 oc explain sriovnetworks.spec.vlan
KIND:     SriovNetwork
VERSION:  sriovnetwork.openshift.io/v1

FIELD:    vlan <integer>

DESCRIPTION:
     <empty>


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


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 2 zhaozhanqi 2019-08-27 09:09:27 UTC
Verified this bug on latest csv

oc explain sriovnetworks.spec
KIND:     SriovNetwork
VERSION:  sriovnetwork.openshift.io/v1

RESOURCE: spec <Object>

DESCRIPTION:
     Specification describing how a NetworkAttachmentDefinition custom resource
     shall be defined for SR-IOV CNI plugin.

FIELDS:
   ipam	<string>
     IPAM configuration to be used for this network.

   networkNamespace	<string>
     Namespace of the NetworkAttachmentDefinition custom resource

   resourceName	<string> -required-
     SRIOV Network device plugin endpoint resource name

   spoofChk	<boolean>
     VF spoof check

   trust	<boolean>
     VF trust mode

   vlan	<integer>
     VLAN ID to assign for the VF. Defaults to 0.

Comment 3 errata-xmlrpc 2019-10-16 06:34:15 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, 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/RHBA-2019:2922