Bug 2060699

Summary: update the "Configuring cluster monitoring" part
Product: OpenShift Container Platform Reporter: Junqi Zhao <juzhao>
Component: DocumentationAssignee: Brian Burt <bburt>
Status: CLOSED CURRENTRELEASE QA Contact: Junqi Zhao <juzhao>
Severity: medium Docs Contact: Claire Bremble <cbremble>
Priority: medium    
Version: 4.9CC: aos-bugs, bburt, dnagaraj
Target Milestone: ---   
Target Release: 4.6.z   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-04-06 18:54:57 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

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