-
Epic
-
Resolution: Unresolved
-
Major
-
OpenShift 4.14 Freeze, OpenShift 4.13 Async
-
Make UWM docs more developer focused
-
13
-
False
-
-
False
-
100% To Do, 0% In Progress, 0% Done
Description of problem:
The user-defined projects monitoring is documented via https://docs.openshift.com/container-platform/4.13/monitoring/enabling-monitoring-for-user-defined-projects.html, https://docs.openshift.com/container-platform/4.13/monitoring/enabling-alert-routing-for-user-defined-projects.html#enabling-the-platform-alertmanager-instance-for-user-defined-alert-routing_enabling-alert-routing-for-user-defined-projects, https://docs.openshift.com/container-platform/4.13/monitoring/managing-metrics.html#querying-metrics-for-user-defined-projects-as-a-developer_managing-metrics and https://docs.openshift.com/container-platform/4.13/monitoring/managing-alerts.html#managing-alerting-rules-for-user-defined-projects_managing-alerts The above though are mostly focused on the Red Hat OpenShift Container Platform 4 - Cluster administrator and are missing proper step by step instructions for developers. Even though the configuration piece for Red Hat OpenShift Container Platform 4 - Cluster administrator is important, it's also key that Developers find them-self in the documentation and have a clear understanding how to use the user-defined projects monitoring. So basically gain understanding what objects need to be created where, how to manage and configure alerting and thus have a 7x24 overview of the deployed application services.
Version-Release number of selected component (if applicable):
Red Hat OpenShift Container Platform 4.13
How reproducible:
Always
Steps to Reproduce:
1. See Problem description
Actual results:
Information are spread across multiple sections, where it's hard to follow as it's more focused on platform administrator and not developers running their workload
Expected results:
Step by step instructions for developers to understand what components need to be deployed and configured how, to understand how to leverage the user-defined project monitoring.
Additional info:
Also https://developers.redhat.com/ is not providing any useful/good data about that problem
- is depended on by
-
OBSDOCS-1379 Restructuring of monitoring documentation
- In Progress