Bug 1769004 - Missing openapi CRD definitions for oc explain to work for machine and machineSet
Summary: Missing openapi CRD definitions for oc explain to work for machine and machin...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Cloud Compute
Version: 4.3.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: 4.5.0
Assignee: Joel Speed
QA Contact: Paige Rubendall
URL:
Whiteboard:
: 1792054 1810039 1823715 1823717 1847709 (view as bug list)
Depends On: 1816624 1823692
Blocks: 1820474 1823693 1823715 1823717
TreeView+ depends on / blocked
 
Reported: 2019-11-05 18:13 UTC by Maciej Szulik
Modified: 2023-10-06 18:44 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Feature: Provide full OpenAPI schema for Machine and MachineSet custom resources Reason: Allows improvements to client side validation of resources and allows the use of the `oc explain` command Result: `oc explain` now provides descriptions for fields within Machine and MachineSet resources
Clone Of:
: 1816624 1820474 (view as bug list)
Environment:
Last Closed: 2020-07-13 17:12:05 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift machine-api-operator pull 552 0 None closed BUG 1769004: Make Machine/MachineSets structural 2021-01-26 17:06:19 UTC
Red Hat Product Errata RHBA-2020:2409 0 None None None 2020-07-13 17:12:27 UTC

Description Maciej Szulik 2019-11-05 18:13:24 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 Alberto 2020-01-23 10:07:36 UTC
*** Bug 1792054 has been marked as a duplicate of this bug. ***

Comment 2 Alberto 2020-03-04 15:13:55 UTC
*** Bug 1810039 has been marked as a duplicate of this bug. ***

Comment 3 Alberto 2020-04-01 15:21:58 UTC
Lowering severity as MHC is covered by https://bugzilla.redhat.com/show_bug.cgi?id=1816624. We'll create specific tickets for clusterAutoscaler and machineAutoscaler resources. Machine will need more work due to the embedded providerSpec as a raw extension.

Comment 4 Alberto 2020-04-03 15:04:26 UTC
clusterAutoscaler and machineAutoscaler resources -> https://bugzilla.redhat.com/show_bug.cgi?id=1820474

Assigning to Joel to follow up exploring machine/machineSet.

Comment 5 Alberto 2020-04-14 11:57:09 UTC
*** Bug 1823715 has been marked as a duplicate of this bug. ***

Comment 6 Alberto 2020-04-14 11:58:14 UTC
*** Bug 1823717 has been marked as a duplicate of this bug. ***

Comment 9 Paige Rubendall 2020-05-11 18:26:07 UTC
Verifying that oc explain returns output for both machine and machinesets. The output is similar to the oc explain pod


[parube@ip-172-31-48-186 ~]$ 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


[parube@ip-172-31-48-186 ~]$ oc explain machinesets
KIND:     MachineSet
VERSION:  machine.openshift.io/v1beta1

DESCRIPTION:
     / [MachineSet] MachineSet ensures that a specified number of machines
     replicas are running at any given time.

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>
     / [MachineSetSpec] MachineSetSpec defines the desired state of MachineSet

   status	<Object>
     / [MachineSetStatus] MachineSetStatus defines the observed state of
     MachineSet

Comment 10 Alberto 2020-06-17 10:29:47 UTC
*** Bug 1847709 has been marked as a duplicate of this bug. ***

Comment 12 errata-xmlrpc 2020-07-13 17:12:05 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-2020:2409


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