Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-8879

Add documentation to new CRD's integrated with Assisted Installer

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • 4.8
    • Hive
    • None
    • None
    • Unspecified
    • If docs needed, set a value

      Description of problem:

      We will need the proper documentation for new Hive CRDs, this is a sample of the gaps on that side:

      ```
      [kni@bm-cluster-1-hyper AI-Manifests]$ oc explain clusterimageset
      KIND: ClusterImageSet
      VERSION: hive.openshift.io/v1
      DESCRIPTION:
      <empty>
      [kni@bm-cluster-1-hyper AI-Manifests]$ oc explain clusterdeployment
      KIND: ClusterDeployment
      VERSION: hive.openshift.io/v1
      DESCRIPTION:
      <empty>

      ```

      Maybe there are more of them, so this also applies for every missed one.

      Version-Release number of selected component (if applicable):

      Hive v1.1.3

      How reproducible:

      Always

      Steps to Reproduce:
      1. Deploy Hive from OLM
      2. Execute an oc explain <CRD>

      Actual results:

      DESCRIPTION:
      <empty>

      Expected results:

      A correct one would be something like:

      KIND: StorageState
      VERSION: migration.k8s.io/v1alpha1

      DESCRIPTION:
      The state of the storage of a specific resource.

      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>
      Specification of the storage state.

      status <Object>
      Status of the storage state.

      Additional info:

            openshift_jira_bot OpenShift Jira Bot
            jparrill@redhat.com Juan Manuel Parrilla Madrid
            Red Hat Employee
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: