Uploaded image for project: 'OpenShift Over the Air'
  1. OpenShift Over the Air
  2. OTA-1166

OSUS usability: annotate Kube resources with kubernetes.io/description

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • None
    • None
    • None
    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • None
    • None
    • OTA 256

      kubernetes.io/description is a well-known annotation that can be used to provide context on the annotated Kubernetes resource. For example, see here where we set it on our CVO Deployment. We should set it on our OSUS resources too, so newcomers have an easier time understanding how a resource fits into the component, which will increase transparency and aide any audits and debugging.

      This will probably involve touching bundle inputs like the operator Deployment, as well as making Go adjustments to cover resources created by the operator.

      Definition of done:

      • After a new OSUS install and UpdateService deployment, all Kubernetes resources in the target namespace (except for the UpdateService itself, which is customer-created) should have kubernetes.io/description set and/or have ownerReferences pointing back up the chain to a resource which has kubernetes.io/description set (e.g. Pod ownerReferences ReplicaSet ownerReferences Deployment kubernetes.io/description).

              hongkliu Hongkai Liu
              trking W. Trevor King
              None
              None
              None
              None
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: