Bug 1932722 - update description for CMO and use the same font type for kube-state-metrics agent, openshift-state-metrics agent, node-exporter agent
Summary: update description for CMO and use the same font type for kube-state-metrics ...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.8
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: 4.7.z
Assignee: Claire Bremble
QA Contact: Junqi Zhao
Claire Bremble
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-02-25 04:03 UTC by Junqi Zhao
Modified: 2023-02-10 16:03 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-02-10 16:03:39 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
kube-state-metrics agent, openshift-state-metrics agent, node-exporter agent are bold characters (202.04 KB, image/png)
2021-02-25 04:03 UTC, Junqi Zhao
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHDEVDOCS-4351 0 None None None 2022-08-16 14:26:37 UTC

Description Junqi Zhao 2021-02-25 04:03:27 UTC
Created attachment 1759184 [details]
kube-state-metrics agent, openshift-state-metrics agent, node-exporter agent are bold characters

Created attachment 1759184 [details]
kube-state-metrics agent, openshift-state-metrics agent, node-exporter agent are bold characters

Document URL: 
https://docs.openshift.com/container-platform/4.7/monitoring/understanding-the-monitoring-stack.html

Section Number and Name: 
Table 1. Default monitoring stack components

Describe the issue: 
1. Description for Cluster Monitoring Operator
***********************
The Cluster Monitoring Operator (CMO) is a central component of the monitoring stack. It deploys and manages Prometheus instances, the Thanos Querier, the Telemeter Client, and metrics targets and ensures that they are up to date. The CMO is deployed by the Cluster Version Operator (CVO).
***********************
Suggestions for improvement: 
CMO also deploys and manages Alertmanager instances
change to
It deploys and manages Prometheus and Alertmanager instances

Additional information: 
Component: kube-state-metrics agent, openshift-state-metrics agent, node-exporter agent are bold characters, the font type is different with other components, should use the same font type

Comment 1 Junqi Zhao 2021-02-25 04:04:04 UTC
also need to back port to 4.6 if available

Comment 7 Claire Bremble 2022-09-15 19:32:00 UTC
This impacts supported versions of OCP, so updating the version to 4.8.

Comment 8 Brian Burt 2023-01-20 16:14:12 UTC
The content to be updated is in the "Default monitoring components" table located at: https://docs.openshift.com/container-platform/4.8/monitoring/monitoring-overview.html#default-monitoring-components_monitoring-overview

Comment 9 Claire Bremble 2023-02-10 16:03:25 UTC
Closed via this Jira: https://issues.redhat.com/browse/RHDEVDOCS-4351


Note You need to log in before you can comment on or make changes to this bug.