-
Notifications
You must be signed in to change notification settings - Fork 113
Update more details-Observability service (in review) #7974
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 2.14_stage
Are you sure you want to change the base?
Conversation
…lity service Section Update more details related to StorageClass in Enabling the Observability service Section
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: PoornimaSingour The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/label peer-review-in-needed |
@PoornimaSingour: The label(s) In response to this:
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. |
/label peer-review-in-needed |
@PoornimaSingour: The label(s) In response to this:
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 thanks for the PR, however, can you point us to the JIRA issue for the doc team that reflects this change? If no issue was opened, you can open one from this procedure: |
HI @swopebe Yes here is the JIRA https://issues.redhat.com/browse/ACM-21655. DO let me know if any details are needed. |
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. |
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove $
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
keep consistent throughout. This topic should have "required access:" at the top, to fit with the ACM format. -- just checked and it does.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file also has ROKS in it as a product name, which is against company standards so that needs to change, as well.
---- | ||
|
||
+ | ||
*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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
*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: | |
*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 was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At ACM docs, we try to follow company and industry standards: present tense, coding non-English words that cannot be translated bc it is part of the code, and no bidirectional language like "below" that alienates a non-sighted user. See those changes.
+ | ||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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 theMultiClusterObservability
custom resource if you do not want to use the platform's defaultStorageClass
.Modified 1.3.2.3. Creating the MultiClusterObservability custom resource
Added:
Note: By default if you do not define the
storageConfig.storageClass
field in theMultiClusterObservability
custom resource, platforms defaultStorageClass
will be populated in the storageConfig section ofMultiClusterObservability
. For example for AWS default storageClass will be gp2. You can verify default storageClass using below command:Also $ was missing in front of all the command so added that as well.