Separate UWM and core platform monitoring (part 2)

[eromanova97]

Version(s): No version for CP

Issue: OBSDOCS-1433

Link to docs preview:

• CPM persistent volume:
  • link 1
  • link 2
• UWM persistent volume:
  • link 1
  • link 2
• CPM retention: link
• UWM retention: link

QE review:

• [ ] QE has approved this change.

Additional information: This is the part 2 split of core platform monitoring (CPM) and user workload monitoring (UWM) procedures. The issue is getting merged to only monitoring-docs-restructure, not to main, therefore this change will not be visible in the documentation.

The tagging is implemented so that once this is moved to two different assemblies, we will still only have one module to maintain. This will ensure content reuse instead of duplication. It also prevents creation of multiple new modules with basically identical content.

This issue also asks for changes in ID, however, in the final product, the two procedures will be in a different assembly, therefore two IDs will not be needed (context parameter will take care of it)

You can see https://github.com/openshift/openshift-docs/pull/83431 for reference.

[ocpdocs-previewbot]

🤖 Wed Oct 30 12:52:31 - Prow CI generated the docs preview:

https://83910--ocpdocs-pr.netlify.app/openshift-dedicated/latest/observability/monitoring/configuring-the-monitoring-stack.html https://83910--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/configuring-the-monitoring-stack.html https://83910--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/monitoring/configuring-the-monitoring-stack.html

[juzhao]

https://83910--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/configuring-the-monitoring-stack.html#modifying-retention-time-and-size-for-prometheus-metrics-data-uwm_configuring-the-monitoring-stack retention time and size configuration for UWM prometheus example is wrong

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

should be

metadata:
  name: user-workload-monitoring-config
  namespace: openshift-user-workload-monitoring

[juzhao]

Modifying the retention time and size for Prometheus metrics data for core platform monitoring and Modifying the retention time and size for Prometheus metrics data for user-defined monitoring

they have the same explanation and NOTE before each Prerequisites I think one is fine, otherwise it's too redundant

[eromanova97]

Modifying the retention time and size for Prometheus metrics data for core platform monitoring and Modifying the retention time and size for Prometheus metrics data for user-defined monitoring

they have the same explanation and NOTE before each Prerequisites I think one is fine, otherwise it's too redundant

Hello @juzhao yes, thank you for the comment. I added this line in the module: // The following section will be removed and made into its separate concept module.

because I think that part should be in its separate module anyway. So it will be removed in another PR from the procedure and made into its own conceptual module, therefore removing the duplication. I apologise it is hard to estimate what should I do in one PR, because I do not want to make all of the review jobs too difficult, so I am trying to just concentrate on one topic per PR (these changes are huge :sweat_smile: )

And the users will not see these changes anyway until it is all ready :grin: I created a JIRA to track this change: https://issues.redhat.com/browse/OBSDOCS-1464 to not forget about this. Thank you for your thoughtful reviews! :slightly_smiling_face:

[eromanova97]

/label peer-review-needed

[juzhao]

LGTM, waiting for others to review

[openshift-ci[bot]]

@eromanova97: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[eromanova97]

/label merge-review-needed