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

List and document API services managed by CMO

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Major
    • None
    • None
    • None
    • None
    • 3
    • False
    • None
    • False
    • NEW
    • NEW
    • MON Sprint 246, MON Sprint 249
    • 0

    Description

      We don't clearly document what are the supported "3rd-party" monitoring APIs. We should compile the exhaustive list of API services that we officially support:

      • OpenShift routes to access the monitoring API endpoints from the outside.
      • Kubernetes services to access the monitoring API endpoints within the cluster.
      • For each API, the list of supported endpoints (e.g. /api/v1/query, /api/v1/query_range for Prometheus).
      • Which clusterrole/role bindings are needed to access each API service.

      See RHDEVDOCS-4830 for the context.

      Attachments

        Issue Links

          blocks

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. OBSDOCS-201 Add some notes and support regulations to APIs section on the Docs

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          documents

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. MON-3134 Allow to query alerts of application namespaces as an application user using API

          • Normal - To be worked after urgent and high priorities are resolved. This term is chosen when the severity of an issue is relatively close to the level of effort to fix it. The existence of an easily implemented workaround can also lead to this priority level instead of a higher priority.
          • Closed
          is documented by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. OBSDOCS-913 Add CMO routes and services reference content to APIs section of monitoring docs

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Review
          links to

          Web Link OpenShift enhancement proposal for UWM

          GitHub openshift/cluster-monitoring-operator#2188: MON-3172: describe monitoring services

          GitHub openshift/openshift-docs#59163: [WIP] RHDEVDOCS-4830-add-warning-info-to-mon-api-access-topic

          Activity

            People

              spasquie@redhat.com Simon Pasquier
              spasquie@redhat.com Simon Pasquier
              Brian Burt
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: