Bug 1709090
| Summary: | Missing openapi CRD definitions for oc explain to work for controllermanager operator | |||
|---|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Wenjing Zheng <wzheng> | |
| Component: | Build | Assignee: | Adam Kaplan <adam.kaplan> | |
| Status: | CLOSED ERRATA | QA Contact: | wewang <wewang> | |
| Severity: | medium | Docs Contact: | ||
| Priority: | medium | |||
| Version: | 4.1.0 | CC: | adam.kaplan, aos-bugs, maszulik, obulatov, wzheng | |
| Target Milestone: | --- | |||
| Target Release: | 4.2.0 | |||
| Hardware: | Unspecified | |||
| OS: | Unspecified | |||
| Whiteboard: | ||||
| Fixed In Version: | Doc Type: | No Doc Update | ||
| Doc Text: | Story Points: | --- | ||
| Clone Of: | 1705752 | |||
| : | 1714778 (view as bug list) | Environment: | ||
| Last Closed: | 2019-10-16 06:28:42 UTC | Type: | --- | |
| Regression: | --- | Mount Type: | --- | |
| Documentation: | --- | CRM: | ||
| Verified Versions: | Category: | --- | ||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | ||
| Cloudforms Team: | --- | Target Upstream Version: | ||
| Embargoed: | ||||
| Bug Depends On: | ||||
| Bug Blocks: | 1714778 | |||
|
Description
Wenjing Zheng
2019-05-13 03:34:51 UTC
It seels below error is not invalid, because "openshiftcontrollermanagers.operator.openshift.io" is not a resource, right? $ oc explain openshiftcontrollermanagers.operator.openshift.io error: field "operator" does not exist It's empty in DESCRIPTION part
$ oc explain openshiftcontrollermanagers --api-version=operator.openshift.io/v1
KIND: OpenShiftControllerManager
VERSION: operator.openshift.io/v1
DESCRIPTION:
<empty>
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/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/api-conventions.md#types-kinds
metadata <Object>
Standard object's metadata. More info:
https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec <Object> -required-
status <Object>
moving to 4.2.0, if you decide to backport it to 4.1.z create a clone. This was shipped in 4.1.0. Note that the `oc explain` test already works for the openshift controller manager config. Moving to ON_QA PR: https://github.com/openshift/cluster-openshift-controller-manager-operator/pull/79 @Wenjing looks like the empty Description is expected - only gets filled if you explain an actual field: $ oc explain openshiftcontrollermanager.spec.logLevel --api-version operator.openshift.io/v1 KIND: OpenShiftControllerManager VERSION: operator.openshift.io/v1 FIELD: logLevel <string> DESCRIPTION: logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands. *** Bug 1714778 has been marked as a duplicate of this bug. *** verified in version
4.1.0-rc.9
[wewang@Desktop ~]$ oc explain openshiftcontrollermanager.spec.logLevel --api-version operator.openshift.io/v1
KIND: OpenShiftControllerManager
VERSION: operator.openshift.io/v1
FIELD: logLevel <string>
DESCRIPTION:
logLevel is an intent based logging for an overall component. It does not
give fine grained control, but it is a simple way to manage coarse grained
logging choices that operators have to interpret for their operands.
Reopening - per @Maciej we should in fact have a fully populated DESCRIPTION field. This was fixed in https://github.com/openshift/cluster-openshift-controller-manager-operator/pull/105 verified in 4.2.0-0.nightly-2019-08-24-002347
[wewang@Desktop Downloads]$ oc explain openshiftcontrollermanager
KIND: OpenShiftControllerManager
VERSION: operator.openshift.io/v1
DESCRIPTION:
OpenShiftControllerManager provides information to configure an operator to
manage openshift-controller-manager.
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/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/api-conventions.md#types-kinds
metadata <Object>
Standard object's metadata. More info:
https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec <Object> -required-
status <Object>
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 |