Bug 1895838
| Summary: | oc explain description contains '/' | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Milind Yadav <miyadav> |
| Component: | Cloud Compute | Assignee: | Michael McCune <mimccune> |
| Cloud Compute sub component: | Other Providers | QA Contact: | Milind Yadav <miyadav> |
| Status: | CLOSED ERRATA | Docs Contact: | |
| Severity: | low | ||
| Priority: | unspecified | CC: | mimccune |
| Version: | 4.7 | ||
| Target Milestone: | --- | ||
| Target Release: | 4.7.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| 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.
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2021-02-24 15:31:28 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: | |||
the fix for this has been proposed, just waiting on testing for it to merge. 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
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 |
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