-
Task
-
Resolution: Done
-
Undefined
-
None
-
False
-
None
-
False
-
-
-
None
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. - [x] Mandatory: Add the required version to the Fix version/s field.
2. - [x] Mandatory: Choose the type of documentation change or review.
- [x] We need to update to an existing topic
3. - [x] *Mandatory: *Use the following link to open the doc and find where the
documentation update should go. Note: As the feature and doc is
understood and developed, this placement decision may change:
- Klusterlet node selector / toleration doc: https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.10/html-single/clusters/index#import-configuring-nodeselector-tolerations
- Add-ons node selector / toleration doc: https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/add-ons/add-ons-overview#configure-nodeselector-tolerations-addons
- ACM Hub-side components node selector / toleration doc: https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/install/installing#node-selector
- MCE Hub-side components node selector / toleration doc: https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#node-selector
4. - [x] Mandatory for GA content:
- [x] Add steps, the diff, known issue, and/or other important
conceptual information in the following space:
Users need to able to configure which nodes our managed-cluster side agents deploy onto; we have two sets of documentation (as linked above) that describe two workflows that are required. There are two separate sections, because they describe how to configure the base agent (Klusterlet) that is offered via MCE; and the add-ons (additional agents on top of Klusterlet) that are offered via ACM. In order for users, to get the desired result of any MCE/ACM content to be deployed to the correct nodes, they need to complete both workflows. Currently the two different areas of the doc don't have any reference to each other, in order to improve the documentation experience and help the users understand that there is an additional workflow that may be required, it would be good to at least reference and link the two sections for the users.
In addition, there is a separate workflow for configuring the node selector / tolerations for hub-side components (as linked above); it may also be beneficial to provide additional linking for these parts as well.
Alternatively, the doc team can look into, if it would make sense to consolidate all these sections of the doc (if feasible) to improve the experience. Other solutions can be considered if the doc team thinks they can solve these problems.