OSSM-11009 [DOCS] Update OSSM metrics docs for ambient mode #102972
Conversation
openshift-ci
bot
added
the
size/L
|
🤖 Thu Nov 27 06:51:50 - Prow CI generated the docs preview: https://102972--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/observability/metrics/ossm-metrics.html |
|
/label service-mesh |
shreyasiddhartha
changed the title
shreyasiddhartha
force-pushed
the
OSSM-11010
branch
from
32f327f to
4a1b505
Compare
shreyasiddhartha
force-pushed
the
OSSM-11010
branch
from
4a1b505 to
365d5e1
Compare
| ==== | ||
| You can enable user-workload monitoring by applying the `ConfigMap` change for metrics integration. For more information, see link:https://docs.openshift.com/container-platform/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html[Enabling monitoring for user-defined projects]. | ||
| ==== | ||
| * You have deployed the Bookinfo application in ambient mode to use the following example. For more information, see https://docs.redhat.com/en/documentation/red_hat_openshift_service_mesh/3.2/html/installing/ossm-istio-ambient-mode#ossm-deploying-bookinfo-application-istio-ambient-mode_ossm-istio-ambient-mode[Deploying the Bookinfo application in Istio ambient mode]. |
There was a problem hiding this comment.
I don't think the step of deploying a Bookinfo application is a Prerequisite.
We can move this Bookinfo step from Prerequisties section to a Validation section.
There was a problem hiding this comment.
I have added it as a prereq in the verifying scetion for metrics. Since, I see there is s step there to see the Bookinfo productpage service. If you think it is still not required, I can remove it.
| .Prerequisites | ||
|
|
||
| * You have installed the {SMProductName} Operator. | ||
| * You have enabled the user-workload monitoring. |
There was a problem hiding this comment.
Because we mention "the ConfigMap change" below, it's better to give an example and that's all user need to configure.
| * You have enabled the user-workload monitoring. | |
| * You have enabled the user-workload monitoring, similar to the following example: | |
| [source,yaml] | |
| ---- | |
| apiVersion: v1 | |
| kind: ConfigMap | |
| metadata: | |
| name: cluster-monitoring-config | |
| namespace: openshift-monitoring | |
| data: | |
| config.yaml: | | |
| enableUserWorkload: true | |
| ---- | |
There was a problem hiding this comment.
It will break the parallelism, if I insert an example in prerqs (which I don't think we have done in docs before). The link below already points the user to Configuring user workload monitoring. So, currently I will skip inserting this.
| * You have installed the {SMProductName} Operator. | ||
| * User-workload monitoring is enabled. See link:https://docs.openshift.com/container-platform/4.16/observability/monitoring/enabling-monitoring-for-user-defined-projects.html[Enabling monitoring for user-defined projects]. | ||
| * You have enabled the user-workload monitoring. |
There was a problem hiding this comment.
| * You have enabled the user-workload monitoring. | |
| * You have enabled the user-workload monitoring, similar to the following example: | |
| [source,yaml] | |
| ---- | |
| apiVersion: v1 | |
| kind: ConfigMap | |
| metadata: | |
| name: cluster-monitoring-config | |
| namespace: openshift-monitoring | |
| data: | |
| config.yaml: | | |
| enableUserWorkload: true | |
| ---- | |
There was a problem hiding this comment.
Same comment as above: It will break the parallelism, if I insert an example in prerqs (which I don't think we have done in docs before). The link below already points the user to Configuring user workload monitoring. So, currently I will skip inserting this.
| ---- | ||
|
|
||
| . Create a YAML file named `podmonitor.yml` to collect metrics from the {istio} proxies: | ||
| . Create a YAML file named `podmonitor.yml` to collect metrics from the {istio} proxies similar to the following example: |
There was a problem hiding this comment.
The PodMonitor step section is not working with OSSM in recent OpenShift platform versions. We may remove this PodMonitor Procedure part from our doc. We will introduce an easy way of integrating this in the incoming 3.3 release.
There was a problem hiding this comment.
I have removed the PodMonitor step.
|
@shreyasiddhartha: 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. |
3 participants
Change type: Doc update; Update OSSM metrics docs for ambient mode
Doc JIRA: https://issues.redhat.com/browse/OSSM-11009
Fix Version: service-mesh-docs-main and service-mesh-docs-3.2
Doc Preview:
SME Review/QE Review: @yxun
Peer Review: