-
Bug
-
Resolution: Done
-
Normal
-
None
-
None
-
devex docs #216 Mar 17-Apr 7
-
5
Section Number and Name:
"Configuring cluster monitoring" part, step 1, cluster-monitoring-config.yml example file:
Describe the issue:
1. The prometheusOperator does not have baseImage/prometheusConfigReloaderBaseImage/configReloaderBaseImage configuration parameters since 4.x
2. All monitoring components don't have a baseImage configuration parameter since 4.x
3. Because the topic is about increasing the storage capacity for Prometheus, only mentioning prometheusK8s and alertmanagerMain parts is fine
4. Change the following:
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', so to staty consistent we should change all instances of cluster-monitoring-config.yml to cluster-monitoring-config.yaml throughout the page
Suggestions for improvement:
1. Change all instances of cluster-monitoring-config.yml to cluster-monitoring-config.yaml in the page
2. Example configuration code should be changed 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
- links to