Bug 1895838 - oc explain description contains '/'
Summary: oc explain description contains '/'
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Cloud Compute
Version: 4.7
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: 4.7.0
Assignee: Michael McCune
QA Contact: Milind Yadav
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-11-09 08:57 UTC by Milind Yadav
Modified: 2021-02-24 15:31 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Cause: Extraneous comments in source code are interfering with automated tooling that generates description text for descriptions that are displayed through oc related commands. Consequence: When using `oc explain` to view Machine API resources, the descriptions contain leading text in the form of "/ [ResourceName] ". Fix: The extraneous comments have been removed from the source code. Result: The descriptions in `oc explain` are now free of extraneous information.
Clone Of:
Environment:
Last Closed: 2021-02-24 15:31:28 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift machine-api-operator pull 745 0 None closed Bug 1895838: Remove extraneous code comments 2021-01-04 08:24:33 UTC
Red Hat Product Errata RHSA-2020:5633 0 None None None 2021-02-24 15:31:58 UTC

Description Milind Yadav 2020-11-09 08:57:49 UTC
Description of Problem:
The description tag(explain comand output) has few characters that seems to be populated mistakenly

version   4.7.0-0.nightly-2020-10-27-051128

Steps:
1.oc explain machine

[miyadav@miyadav ~]$ oc explain machine 
KIND:     Machine
VERSION:  machine.openshift.io/v1beta1

DESCRIPTION:
     / [Machine] Machine is the Schema for the machines API

FIELDS:
   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:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

   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:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

   metadata        <Object>
     Standard object's metadata. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

   spec        <Object>
     / [MachineSpec] MachineSpec defines the desired state of Machine

   status        <Object>
     / [MachineStatus] MachineStatus defines the observed state of Machine

Actual : / [Machine] Machine is the .....
Expected: Machine is the ...

Additional info : 
It is same for machineset as well

Comment 1 Michael McCune 2020-11-13 18:33:00 UTC
the fix for this has been proposed, just waiting on testing for it to merge.

Comment 3 Milind Yadav 2020-11-23 11:14:46 UTC
 oc explain machine
KIND:     Machine
VERSION:  machine.openshift.io/v1beta1

DESCRIPTION:
     Machine is the Schema for the machines API

FIELDS:
   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:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

   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:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

   metadata	<Object>
     Standard object's metadata. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

   spec	<Object>
     MachineSpec defines the desired state of Machine

   status	<Object>
     MachineStatus defines the observed state of Machine

[miyadav@miyadav ~]$ oc get clusterversion
NAME      VERSION                             AVAILABLE   PROGRESSING   SINCE   STATUS
version   4.7.0-0.nightly-2020-11-22-204912   True        False         175m    Cluster version is 4.7.0-0.nightly-2020-11-22-204912

Moved to VERIFIED

Comment 6 errata-xmlrpc 2021-02-24 15:31:28 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 Container Platform 4.7.0 security, bug fix, and enhancement 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-2020:5633


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