Bug 1880786
| Summary: | PodNetworkConnectivityCheck is missing description for `oc explain` | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Jason Boxman <jboxman> |
| Component: | kube-apiserver | Assignee: | Luis Sanchez <sanchezl> |
| Status: | CLOSED WONTFIX | QA Contact: | Ke Wang <kewang> |
| Severity: | low | Docs Contact: | |
| Priority: | low | ||
| Version: | 4.6 | CC: | aos-bugs, kewang, mfojtik, sttts, wlewis, xxia |
| Target Milestone: | --- | Keywords: | UserExperience |
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2022-02-25 15:57:38 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: | |||
Verified in latest 4.6.0-0.nightly-2020-09-22-073212, still reproduced. Waiting for bumping PR for the merged dependent https://github.com/openshift/api/pull/741 The api change needs revendoring into kube-apiserver-operator. Moving out of 4.6. This is cosmetics and can be backported later. The CRD is opt-in now and unsupported. So low prio. $ oc get clusterversion
NAME VERSION AVAILABLE PROGRESSING SINCE STATUS
version 4.8.0-0.nightly-2021-06-09-142759 True False 9h Cluster version is 4.8.0-0.nightly-2021-06-09-142759
$ oc explain PodNetworkConnectivityCheck
KIND: PodNetworkConnectivityCheck
VERSION: controlplane.operator.openshift.io/v1alpha1
DESCRIPTION:
PodNetworkConnectivityCheck
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> -required-
Spec defines the source and target of the connectivity check
status <Object>
Status contains the observed status of the connectivity check
From Comment #7, the DESCRIPTION for PodNetworkConnectivityCheck is terrible，it's the equivalent of nothing being explained. Let's see a normal description, as below, $ oc explain crd KIND: CustomResourceDefinition VERSION: apiextensions.k8s.io/v1 DESCRIPTION: CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. ... I think the linked PR doesn't fixed the bug, I have to move it ASSIGNED. |
Description of problem: There is no description for PodNetworkConnectivityCheck CRD reported by `oc explain`. How reproducible: Always. Steps to Reproduce: `oc explain PodNetworkConnectivityCheck` Actual results: KIND: PodNetworkConnectivityCheck VERSION: controlplane.operator.openshift.io/v1alpha1 DESCRIPTION: <empty> Expected results: A description of what this CRD is for.