Uploaded image for project: 'OpenShift Monitoring'
  1. OpenShift Monitoring
  2. MON-3220

Add openshift.io/description to CMO resources

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • None
    • openshift.io/description
    • False
    • None
    • False
    • Not Selected
    • NEW
    • To Do
    • MON-3217Improve user and developer documentation
    • NEW
    • 80% To Do, 0% In Progress, 20% Done

      Add an annotation (with one sentence) that explains what the Kube resource is used for, sometimes we cannot/don't want to browse the code to know what the resource is used for, and mist of the times the name is not self-explanatory.

      I don't think maintaining this will be a big deal as resources' purposes don't change a lot.

      there is a standard annotation for this kubernetes.io/description https://kubernetes.io/docs/reference/labels-annotations-taints/#description

      See https://issues.redhat.com/browse/MON-1634?focusedId=22170770&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-22170770 for more context.

       

              Unassigned Unassigned
              rh-ee-amrini Ayoub Mrini
              Tai Gao Tai Gao
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: