Bug 1769015 - Missing openapi CRD definitions for oc explain to work
Summary: Missing openapi CRD definitions for oc explain to work
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Networking
Version: 4.3.0
Hardware: Unspecified
OS: Unspecified
Target Milestone: ---
: 4.4.0
Assignee: Aniket Bhat
QA Contact: zhaozhanqi
Depends On:
Blocks: 1777707 1782303 1798142
TreeView+ depends on / blocked
Reported: 2019-11-05 18:27 UTC by Maciej Szulik
Modified: 2020-05-13 21:52 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
: 1782303 (view as bug list)
Last Closed: 2020-05-13 21:52:17 UTC
Target Upstream Version:

Attachments (Terms of Use)

System ID Private Priority Status Summary Last Updated
Github openshift api pull 527 0 'None' closed Bug 1769015: Add kubebuilder annotations to the network types 2020-05-07 12:11:34 UTC
Github openshift cluster-network-operator pull 398 0 'None' closed Bug 1769015: Bump library go 2020-05-07 12:11:34 UTC
Github openshift cluster-network-operator pull 458 0 None closed Bug 1769015: Add preserveUnknownFields to CRDs 2020-05-07 12:11:33 UTC
Github openshift origin pull 24222 0 'None' closed Bug 1769015: Uncomment the lines to verify oc explain for networking related CRDs 2020-05-07 12:11:33 UTC
Red Hat Product Errata RHBA-2020:0581 0 None None None 2020-05-13 21:52:22 UTC

Description Maciej Szulik 2019-11-05 18:27:46 UTC
The following PR https://github.com/openshift/origin/pull/22696 introduced an e2e which is verifying that all the operators provide descriptive information as part of their schema which is then available through oc explain command. 
This was recently updated and brought back in https://github.com/openshift/origin/pull/24058. 

Your component has a few missing bits, see the commented out lines from the PR.

This should be fixed similarly to https://github.com/openshift/cluster-kube-controller-manager-operator/pull/302, 
iow. it should be using openshift/api's generated CRD yamls. 

Once done update origin's e2e test and uncomment the lines from your components.

Comment 1 Casey Callendrello 2019-12-12 13:37:20 UTC
*** Bug 1777707 has been marked as a duplicate of this bug. ***

Comment 3 Weibin Liang 2020-01-27 20:01:23 UTC
Verification failed on 4.4.0-0.nightly-2020-01-24-141203 which description is still empty.

[root@dhcp-41-193 FILE]# oc explain clusternetwork
KIND:     ClusterNetwork
VERSION:  network.openshift.io/v1

Comment 5 Weibin Liang 2020-01-30 16:48:22 UTC
Tested and verified on openshift-sdn using 4.4.0-0.nightly-2020-01-30-123556:
[root@dhcp-41-193 FILE]#  oc explain clusternetwork
KIND:     ClusterNetwork
VERSION:  network.openshift.io/v1

     ClusterNetwork describes the cluster network. There is normally only one
     object of this type, named "default", which is created by the SDN network
     plugin based on the master configuration when the cluster is brought up for
     the first time.

   apiVersion	<string>
     APIVersion defines the versioned schema of this representation of an
     object. Servers should convert recognized schemas to the latest internal
     value, and may reject unrecognized values. More info:

   clusterNetworks	<[]Object> -required-
     ClusterNetworks is a list of ClusterNetwork objects that defines the global
     overlay network's L3 space by specifying a set of CIDR and netmasks that
     the SDN can allocate addresses from.

   hostsubnetlength	<integer>
     HostSubnetLength is the number of bits of network to allocate to each node.
     eg, 8 would mean that each node would have a /24 slice of the overlay
     network for its pods

   kind	<string>
     Kind is a string value representing the REST resource this object
     represents. Servers may infer this from the endpoint the client submits
     requests to. Cannot be updated. In CamelCase. More info:

   metadata	<Object>
     Standard object's metadata. More info:

   mtu	<integer>
     MTU is the MTU for the overlay network. This should be 50 less than the MTU
     of the network connecting the nodes. It is normally autodetected by the
     cluster network operator.

   network	<string>
     Network is a CIDR string specifying the global overlay network's L3 space

   pluginName	<string>
     PluginName is the name of the network plugin being used

   serviceNetwork	<string> -required-
     ServiceNetwork is the CIDR range that Service IP addresses are allocated

   vxlanPort	<integer>
     VXLANPort sets the VXLAN destination port used by the cluster. It is set by
     the master configuration file on startup and cannot be edited manually.
     Valid values for VXLANPort are integers 1-65535 inclusive and if unset
     defaults to 4789. Changing VXLANPort allows users to resolve issues between
     openshift SDN and other software trying to use the same VXLAN destination

Comment 7 errata-xmlrpc 2020-05-13 21:52:17 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.


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