-
Task
-
Resolution: Done
-
Normal
-
ACM 2.9.0
-
Product / Portfolio Work
-
2
-
False
-
-
False
-
-
-
None
Documentation is not clear where the search-collector-config should be configured . Document say <namespace where search-collector add-on is deployed> . but does not detail if this is on a hub cluster or on the managed cluster and by default which namespace would be .
Note: Doc team updates the current version of the documentation and the
two previous versions (n-2), but we address *only high-priority, or
customer-reported issues* for -2 releases in support.
Describe the changes in the doc and link to your dev story:
1. -
Mandatory: Add the required version to the Fix version/s field.
2. - [ ] Mandatory: Choose the type of documentation change or review.
We need to update to an existing topic
- [ ] We need to add a new document to an existing section
- [ ] We need a whole new section; this is a function not
documented before and doesn't belong in any current section
- [ ] We need an Operator Advisory review and approval
- [ ] We need a z-Stream (Errata) Advisory and Release note for
MCE and/or ACM
3. - [ ] Mandatory: Find the link to where the documentation update
should go and add it to the recommended changes. You can either use the
published doc or the staged repo for this step:
Note: As the feature and doc is understood, this recommendation may
change. If this is new documentation, link to the section where you think
it should be placed.
Customer Portal published version
Doc staged repo within the ACM Workspace:
(2.11 and before) https://github.com/stolostron/rhacm-docs/blob/2.11_stage/observability/manage_search.adoc#creating-search-configurable-collection
(2.12 and after) https://github.com/stolostron/rhacm-docs/blob/2.12_stage/console/manage_search.adoc#managing-search
4. - [ ] Mandatory for GA content:
- [ ] Add steps, the diff, known issue, and/or other important
conceptual information in the following space:
- [ ] *Add Required access level *(example, *Cluster
Administrator*) for the user to complete the task:
- [ ] Add verification at the end of the task, how does the user
verify success (a command to run or a result to see?)
- [ ] Add link to dev story here:
5. -
Mandatory for bugs: What is the diff? Clearly define what the
problem is, what the change is, and link to the current documentation. Only
use this for a documentation bug.
The ConfigMap search-collector-config needs to be created for each managed cluster that we want to customize the resources collected by search. This configmap needs to be placed in the same namespace where the search add-on is deployed. By default the namespace is open-cluster-management-agent-addon.
Additional info: We have this wiki topic which describes how to use an ACM policy to distribute the configmap to the managed clusters. I don't think all the details belong in the documentation but maybe it would help users if we add a hint or something.