Bug 2060699 - update the "Configuring cluster monitoring" part
Summary: update the "Configuring cluster monitoring" part
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.9
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: 4.6.z
Assignee: Brian Burt
QA Contact: Junqi Zhao
Claire Bremble
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-03-04 02:49 UTC by Junqi Zhao
Modified: 2022-04-06 18:54 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-04-06 18:54:57 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHDEVDOCS-3858 0 None None None 2022-04-01 18:11:12 UTC

Description Junqi Zhao 2022-03-04 02:49:09 UTC
Document URL: 
https://docs.openshift.com/container-platform/4.9/scalability_and_performance/scaling-cluster-monitoring-operator.html#configuring-cluster-monitoring_cluster-monitoring-operator

Section Number and Name: 
"Configuring cluster monitoring" part, step 1, cluster-monitoring-config.yml example file:

Describe the issue: 
1. prometheusOperator does not have baseImage/prometheusConfigReloaderBaseImage/configReloaderBaseImage configuration parameters since 4.x
2. all monitoring components don't have baseImage configuration parameter since 4.x
3. since it is about increase the storage capacity for Prometheus, only mention prometheusK8s and alertmanagerMain parts are fine
4. 
metadata:
  name: cluster-monitoring-config
namespace: openshift-monitoring

should be
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring

5. since we used cluster-monitoring-config.yaml for most of our docs, example:
https://docs.openshift.com/container-platform/4.9/monitoring/configuring-the-monitoring-stack.html
we should use the same postfix 'yaml', we'd better change all cluster-monitoring-config.yml to cluster-monitoring-config.yaml throughout the page

Suggestions for improvement: 
1. change all cluster-monitoring-config.yml to cluster-monitoring-config.yaml in the page
2. example configuration change to
****************************
apiVersion: v1
kind: ConfigMap
data:
  config.yaml: |
    prometheusK8s:
      retention: {{PROMETHEUS_RETENTION_PERIOD}}
      nodeSelector:
        node-role.kubernetes.io/infra: ""
      volumeClaimTemplate:
        spec:
          storageClassName: gp2
          resources:
            requests:
              storage: {{PROMETHEUS_STORAGE_SIZE}}
    alertmanagerMain:
      nodeSelector:
        node-role.kubernetes.io/infra: ""
      volumeClaimTemplate:
        spec:
          storageClassName: gp2
          resources:
            requests:
              storage: {{ALERTMANAGER_STORAGE_SIZE}}
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring
****************************

Additional information: 
4.5 and below versions are no longer supported, we only need to change for 4.6 and above versions
4.9 doc:
https://docs.openshift.com/container-platform/4.9/scalability_and_performance/scaling-cluster-monitoring-operator.html#configuring-cluster-monitoring_cluster-monitoring-operator

4.8 doc:
https://docs.openshift.com/container-platform/4.8/scalability_and_performance/scaling-cluster-monitoring-operator.html#configuring-cluster-monitoring_cluster-monitoring-operator

4.7 doc:
https://docs.openshift.com/container-platform/4.7/scalability_and_performance/scaling-cluster-monitoring-operator.html#configuring-cluster-monitoring_cluster-monitoring-operator

4.6 doc:
https://docs.openshift.com/container-platform/4.6/scalability_and_performance/scaling-cluster-monitoring-operator.html#configuring-cluster-monitoring_cluster-monitoring-operator


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