Update more details-Observability service (in review) #7974

PoornimaSingour · 2025-06-18T14:40:26Z

Update more details related to StorageClass in Enabling the Observability service Section.

BUG : https://issues.redhat.com/browse/ACM-21655

Modified [Prerequisites] section (https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/observability/index#prerequisites-observability)
Before : You must define a storage class in the MultiClusterObservability custom resource, if there is no default storage class specified.
After : - You must specify the storageConfig.storageClass field in the MultiClusterObservability custom resource if you do not want to use the platform's default StorageClass.
Modified 1.3.2.3. Creating the MultiClusterObservability custom resource

Added:

Note: By default if you do not define the storageConfig.storageClass field in the MultiClusterObservability custom resource, platforms default StorageClass will be populated in the storageConfig section of MultiClusterObservability. For example for AWS default storageClass will be gp2. You can verify default storageClass using below command:

$ oc get storageClass
NAME                PROVISIONER       RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
gp2-csi             ebs.csi.aws.com   Delete          WaitForFirstConsumer   true                   151m
gp3-csi (default)   ebs.csi.aws.com   Delete          WaitForFirstConsumer   true                   151m

Also $ was missing in front of all the command so added that as well.

…lity service Section Update more details related to StorageClass in Enabling the Observability service Section

PoornimaSingour · 2025-06-18T14:42:23Z

/label peer-review-in-needed

openshift-ci · 2025-06-18T14:42:25Z

@PoornimaSingour: The label(s) /label peer-review-in-progress cannot be applied. These labels are supported: acknowledge-critical-fixes-only, platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, ux-approved, no-qe, downstream-change-needed, rebase/manual, cluster-config-api-changed, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, jira/valid-bug, stability-fix-approved, staff-eng-approved. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

In response to this:

/label peer-review-in-progress

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.

PoornimaSingour · 2025-06-18T14:42:49Z

/label peer-review-in-needed

openshift-ci · 2025-06-18T14:42:52Z

@PoornimaSingour: The label(s) /label peer-review-in-needed cannot be applied. These labels are supported: acknowledge-critical-fixes-only, platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, ux-approved, no-qe, downstream-change-needed, rebase/manual, cluster-config-api-changed, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, jira/valid-bug, stability-fix-approved, staff-eng-approved. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

In response to this:

/label peer-review-in-needed

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.

swopebe · 2025-06-18T14:57:39Z

@PoornimaSingour thanks for the PR, however, can you point us to the JIRA issue for the doc team that reflects this change?
We cannot start peer review or tech review without tacking the change/understanding the change via a doc issue.

If no issue was opened, you can open one from this procedure:

https://docs.google.com/document/d/1YTqpZRH54Bnn4WJ2nZmjaCoiRtqmrc2w6DdQxe_yLZ8/edit?tab=t.0#heading=h.nmome2yn9lvr

PoornimaSingour · 2025-06-18T15:28:27Z

HI @swopebe Yes here is the JIRA https://issues.redhat.com/browse/ACM-21655. DO let me know if any details are needed.

swopebe · 2025-06-20T00:48:41Z

Thanks, we will pick this up as soon as we can. We generally don't add $ to the commands in ACM doc, we never really have (this content was moved from IBM and we stuck to those practices.) I know OCP adds it.

swopebe · 2025-07-25T21:23:22Z

observability/observability_enable.adoc

@@ -50,7 +50,7 @@ Complete the following steps to enable the Observability service:
 +
 [source,bash]
 ----
-oc create namespace open-cluster-management-observability
+$ oc create namespace open-cluster-management-observability


keep consistent throughout. This topic should have "required access:" at the top, to fit with the ACM format. -- just checked and it does.

This file also has ROKS in it as a product name, which is against company standards so that needs to change, as well.

observability/observability_enable.adoc

swopebe · 2025-07-25T21:33:45Z

observability/observability_enable.adoc

 +
-All the pods in `open-cluster-management-observability` namespace for Thanos, Grafana and Alertmanager are created. All the managed clusters connected to the {acm-short} hub cluster are enabled to send metrics back to the {acm-short} Observability service.
+All the pods in `open-cluster-management-observability` namespace for Thanos, Grafana and Alertmanager are created. All the managed clusters connected to the {acm-short} hub cluster are   enabled to send metrics back to the {acm-short} Observability service.


Suggested change

All the pods in `open-cluster-management-observability` namespace for Thanos, Grafana and Alertmanager are created. All the managed clusters connected to the {acm-short} hub cluster are enabled to send metrics back to the {acm-short} Observability service.

All the pods in `open-cluster-management-observability` namespace for Thanos, Grafana, and Alertmanager are created. All the managed clusters connected to the {acm-short} hub cluster are enabled to send metrics back to the {acm-short} Observability service.

line 505 really should not be here--we don't know that they "are created"; for a while some writers were writing this in place of "verification steps" (this is not a verification step) without checking in for peer review--we have stopped doing that. I think this should be removed. You don't know that the pods are created.

observability/observability_enable.adoc

Co-authored-by: swope <[email protected]>

dockerymick

Made updates based on earlier doc review

coleenquadros · 2025-08-01T09:40:53Z

/lgtm

openshift-ci · 2025-08-01T09:41:02Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: coleenquadros, dockerymick, PoornimaSingour

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci · 2025-08-01T15:19:30Z

New changes are detected. LGTM label has been removed.

swopebe · 2025-08-01T15:20:46Z

observability/observability_enable.adoc

@@ -489,9 +489,20 @@ For more information, see link:https://docs.redhat.com/en/documentation/openshif
 ----
 oc apply -f multiclusterobservability_cr.yaml
 ----
+
+
+*Note:* By default, if you do not define the `storageConfig.storageClass` field in the `MultiClusterObservability` custom resource, platform default `StorageClass` fields are populated in the `storageConfig` section of the `MultiClusterObservability` resource. For example, AWS default `storageClass` is set to `gp2`. You can verify default `storageClass` by running the following command:


There is a step inside this note.

dockerymick · 2025-08-06T15:21:16Z

Created tech debt issue to improve the doc: https://issues.redhat.com/browse/ACM-22916

Otherwise, the request from the original issue is addressed. Merging this PR

Update more details related to StorageClass in Enabling the Observabi…

047c64b

…lity service Section Update more details related to StorageClass in Enabling the Observability service Section

swopebe changed the title ~~Update more details related to StorageClass in Enabling the Observability service Section~~ Update more details-Observability service (not ready for review, issue requested-bcs) Jun 18, 2025

swopebe changed the title ~~Update more details-Observability service (not ready for review, issue requested-bcs)~~ Update more details-Observability service Jun 20, 2025

swopebe changed the title ~~Update more details-Observability service~~ Update more details-Observability service (post GA or when in progress features are complete) Jun 23, 2025

oafischer requested a review from dockerymick June 26, 2025 14:51

swopebe reviewed Jul 25, 2025

View reviewed changes

observability/observability_enable.adoc Outdated Show resolved Hide resolved

swopebe reviewed Jul 25, 2025

View reviewed changes

swopebe changed the title ~~Update more details-Observability service (post GA or when in progress features are complete)~~ Update more details-Observability service (in review) Jul 25, 2025

dockerymick requested changes Jul 31, 2025

View reviewed changes

openshift-ci bot assigned dockerymick Jul 31, 2025

dockerymick and others added 2 commits July 31, 2025 17:12

Apply suggestions from code review

fca7055

Co-authored-by: swope <[email protected]>

Update product name

8b0d204

dockerymick approved these changes Jul 31, 2025

View reviewed changes

openshift-ci bot added the lgtm label Jul 31, 2025

coleenquadros approved these changes Aug 1, 2025

View reviewed changes

openshift-ci bot assigned coleenquadros Aug 1, 2025

Update observability_enable.adoc--format off with extra line under this.

0094a67

openshift-ci bot removed the lgtm label Aug 1, 2025

swopebe reviewed Aug 1, 2025

View reviewed changes

swopebe added 3 commits August 1, 2025 11:22

Update observability_enable.adoc

92ec038

Update observability_enable.adoc

d92bac1

Update observability_enable.adoc

5ee7662

dockerymick merged commit 0e43796 into stolostron:2.14_stage Aug 6, 2025
1 of 2 checks passed

	All the pods in `open-cluster-management-observability` namespace for Thanos, Grafana and Alertmanager are created. All the managed clusters connected to the {acm-short} hub cluster are enabled to send metrics back to the {acm-short} Observability service.
	All the pods in `open-cluster-management-observability` namespace for Thanos, Grafana, and Alertmanager are created. All the managed clusters connected to the {acm-short} hub cluster are enabled to send metrics back to the {acm-short} Observability service.

Update more details-Observability service (in review) #7974

Update more details-Observability service (in review) #7974

Uh oh!

Conversation

PoornimaSingour commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PoornimaSingour commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci bot commented Jun 18, 2025

Uh oh!

PoornimaSingour commented Jun 18, 2025

Uh oh!

openshift-ci bot commented Jun 18, 2025

Uh oh!

swopebe commented Jun 18, 2025

Uh oh!

PoornimaSingour commented Jun 18, 2025

Uh oh!

swopebe commented Jun 20, 2025

Uh oh!

swopebe Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

swopebe Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swopebe Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

swopebe Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swopebe Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dockerymick left a comment

Choose a reason for hiding this comment

Uh oh!

coleenquadros commented Aug 1, 2025

Uh oh!

openshift-ci bot commented Aug 1, 2025

Uh oh!

openshift-ci bot commented Aug 1, 2025

Uh oh!

swopebe Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

dockerymick commented Aug 6, 2025

Uh oh!

Uh oh!

Uh oh!

PoornimaSingour commented Jun 18, 2025 •

edited

Loading

PoornimaSingour commented Jun 18, 2025 •

edited

Loading

swopebe Jul 25, 2025 •

edited

Loading

swopebe Jul 25, 2025 •

edited

Loading