Bug 1876469 - Invalid doc link on yaml template schema description
Summary: Invalid doc link on yaml template schema description
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Cloud Compute
Version: 4.6
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 4.7.0
Assignee: Joel Speed
QA Contact: sunzhaohua
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-09-07 09:49 UTC by XiaochuanWang
Modified: 2021-02-24 15:17 UTC (History)
3 users (show)

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
Clone Of:
Environment:
Last Closed: 2021-02-24 15:17:26 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift cluster-autoscaler-operator pull 178 0 None closed Bug 1876469: Update generated CRDs 2021-02-15 20:11:12 UTC
Github openshift machine-api-operator pull 719 0 None closed Bug 1876469: Fix MHC annotation and update generated artifacts 2021-02-15 20:11:12 UTC
Github openshift machine-api-operator pull 739 0 None closed Bug 1876469: Fix link on MachineSet Spec Metadata description 2021-02-15 20:11:12 UTC
Red Hat Product Errata RHSA-2020:5633 0 None None None 2021-02-24 15:17:46 UTC

Description XiaochuanWang 2020-09-07 09:49:16 UTC
Description of problem:
On MachineSet Yaml creation page. The external doc link of schema 
 MachineSet.spec.template.spec on side panel is invalid. Url needs update.

Version-Release number of selected component (if applicable):
4.6.0-0.nightly-2020-09-05-015624

How reproducible:
Always

Steps to Reproduce:
1. Browse to MachineSet yaml creation page: /k8s/ns/openshift-machine-api/machine.openshift.io~v1beta1~MachineSet/~new 
check the right side schema description
2. Browse to Schema: MachineSet.spec.template.spec check the external link

Actual results:
1. There is the description as contains "/ ":
/ [MachineSet] MachineSet ensures that a specified number of machines replicas are running at any given time.
2. External link is https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status which is 404

Expected results:
1. should not have the charactor "/ "
2. Suggest to be https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Additional info:

Comment 1 Samuel Padgett 2020-09-11 16:15:02 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

Comment 2 Joel Speed 2020-10-01 14:41:23 UTC
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

Comment 5 sunzhaohua 2020-10-26 07:29:40 UTC
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'

Comment 7 sunzhaohua 2020-11-11 08:39:26 UTC
Verified, all doc links are valid
clusterversion: 4.7.0-0.nightly-2020-11-09-190845

Comment 10 errata-xmlrpc 2021-02-24 15:17:26 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 (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


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