Bug 1876469
| Summary: | Invalid doc link on yaml template schema description | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | XiaochuanWang <xiaocwan> |
| Component: | Cloud Compute | Assignee: | Joel Speed <jspeed> |
| Cloud Compute sub component: | Other Providers | QA Contact: | sunzhaohua <zhsun> |
| Status: | CLOSED ERRATA | Docs Contact: | |
| Severity: | low | ||
| Priority: | low | CC: | aos-bugs, jokerman, spadgett |
| Version: | 4.6 | ||
| Target Milestone: | --- | ||
| Target Release: | 4.7.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: |
Cause: A referenced document had been moved in the upstream location
Consequence: The link was broken
Fix: Update the link to the new location
Result: Link is no longer broken
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2021-02-24 15:17:26 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: | |||
|
Description
XiaochuanWang
2020-09-07 09:49:16 UTC
The console is showing the description from the OpenAPI schema for MachineSets. The API doc itself will need to be updated. You see the same problem with `oc explain`.
$ oc explain machineset.spec.template.spec
KIND: MachineSet
VERSION: machine.openshift.io/v1beta1
RESOURCE: spec <Object>
DESCRIPTION:
Specification of the desired behavior of the machine. More info:
https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
We need to work out where this document has moved to and update the comment [1] (or remove that part of the comment). Will ensure someone does this during the next sprint. [1]: https://github.com/openshift/machine-api-operator/blob/0c284fe1a923c7188bc3f63dfcfa2fcbc5aa6cdf/pkg/apis/machine/v1beta1/machineset_types.go#L118 Failed to Verify, I checked all of our crd yaml files, below link are still invald.
clusterversion: 4.7.0-0.nightly-2020-10-24-155529
$ oc edit crd machineautoscalers.autoscaling.openshift.io
apiVersion:
description: '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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources'
type: string
kind:
description: '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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds'
$ oc edit crd machinesets.machine.openshift.io
template:
description: Template is the object that describes the machine that
will be created if insufficient replicas are detected.
properties:
metadata:
description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata'
Verified, all doc links are valid clusterversion: 4.7.0-0.nightly-2020-11-09-190845 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 |