Bug 1843043
| Summary: | Config api resource has a terrible description | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Clayton Coleman <ccoleman> |
| Component: | kube-apiserver | Assignee: | Ben Parees <bparees> |
| Status: | CLOSED ERRATA | QA Contact: | Ke Wang <kewang> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 4.5 | CC: | aos-bugs, bparees, mfojtik, wlewis, xxia |
| Target Milestone: | --- | Keywords: | Reopened |
| Target Release: | 4.12.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | LifecycleReset | ||
| Fixed In Version: | Doc Type: | No Doc Update | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2023-01-17 19:46:21 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: | |||
No 4.5 blocker. Moving to 4.6. Reducing severity. Challenge me on Slack if you disagree. Assigned. I will get to this next sprint. Still a problem, still no time to fix it. This bug hasn't had any activity in the last 30 days. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. As such, we're marking this bug as "LifecycleStale" and decreasing the severity/priority. If you have further information on the current state of the bug, please update it, otherwise this bug can be closed in about 7 days. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. Additionally, you can add LifecycleFrozen into Keywords if you think this bug should never be marked as stale. Please consult with bug assignee before you do that. Our APIs are a key part of our documentation. Raising to Medium. We need to stop deferring explaining how to use our API to users. This bug hasn't had any activity in the last 30 days. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. As such, we're marking this bug as "LifecycleStale" and decreasing the severity/priority. If you have further information on the current state of the bug, please update it, otherwise this bug can be closed in about 7 days. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. Additionally, you can add LifecycleFrozen into Keywords if you think this bug should never be marked as stale. Please consult with bug assignee before you do that. The LifecycleStale keyword was removed because the bug got commented on recently. The bug assignee was notified. This bug hasn't had any activity in the last 30 days. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. As such, we're marking this bug as "LifecycleStale" and decreasing the severity/priority. If you have further information on the current state of the bug, please update it, otherwise this bug can be closed in about 7 days. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. Additionally, you can add LifecycleFrozen into Keywords if you think this bug should never be marked as stale. Please consult with bug assignee before you do that. Please fix your configuration API so that humans looking at our product understand what to do with these objects. This bug hasn't had any activity in the last 30 days. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. As such, we're marking this bug as "LifecycleStale" and decreasing the severity/priority. If you have further information on the current state of the bug, please update it, otherwise this bug can be closed in about 7 days. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. Additionally, you can add LifecycleFrozen into Keywords if you think this bug should never be marked as stale. Please consult with bug assignee before you do that. The LifecycleStale keyword was removed because the bug moved to QE. The bug assignee was notified. Tested in 4.8.0-0.nightly-2021-05-08-025039:
$ oc explain configs
KIND: Config
VERSION: operator.openshift.io/v1
DESCRIPTION:
Config provides information to configure the config operator.
Need bump. BTW which component use it (config.operator/cluster)? Installer or Apiserver?
$ oc get clusterversion
NAME VERSION AVAILABLE PROGRESSING SINCE STATUS
version 4.12.0-0.nightly-2022-09-28-204419 True False 17m Cluster version is 4.12.0-0.nightly-2022-09-28-204419
$ oc explain configs
KIND: Config
VERSION: operator.openshift.io/v1
DESCRIPTION:
Config specifies the behavior of the config operator which is responsible
for creating the initial configuration of other components on the cluster.
The operator also handles installation, migration or synchronization of
cloud configurations for AWS and Azure cloud based clusters Compatibility
level 1: Stable within a major release for a minimum of 12 months or 3
minor releases (whichever is longer).
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 is the specification of the desired behavior of the Config Operator.
status <Object>
status defines the observed status of the Config Operator.
Show us a detail of explanation.
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.12.0 bug fix and security 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-2022:7399 |
○ oc explain configs KIND: Config VERSION: operator.openshift.io/v1 DESCRIPTION: Config provides information to configure the config operator. The description is terrible. Should be 2-3 sentences that describes the problem domain this API object applies to. Examples: Pod Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. ClusterVersion ClusterVersion is the configuration for the ClusterVersionOperator. This is where parameters related to automatic updates can be set. (this could be better) If you could do a pass over all the API objects in your domain and set better 2-3 sentence descriptions in the form "what this is, what this does, how do you use it" that would improve our API. This is how people understand our product, which is why it's high (and this will go into docs, and shows up in console, and will be added to dynamic editors etc etc)