-
Task
-
Resolution: Done
-
Undefined
-
None
-
False
-
-
False
-
-
-
No
Create an informative issue (See each section, incomplete templates/issues won't be triaged)
Using the current documentation as a model, please complete the issue template.
Note: Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address only high-priority, customer-reported issues for releases in support.
Prerequisite: Start with what we have
Always look at the current documentation to describe the change that is needed. Use the source or portal link for Step 3:
- Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7
- Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs
It is a new component, so there is nothing in the ACM documentation to base it on.
Describe the changes in the doc and link to your dev story
Provide info for the following steps:
1. - [ X ] Mandatory Choose the documentation release (Published releases are refreshed ~weekly after publication).
- [ ] ACM 2.4
- [ ] ACM 2.5
- [ ] ACM 2.6
- [ ]ACM 2.7
- [ X ]ACM 2.8 (upcoming release)
- [ ] MCE 2.0
- [ ] MCE 2.1
- [ X ] MCE 2.2 (upcoming release)
(please note its an ACM only component, will not be part of MCE)
2. - [ X ] Mandatory Choose the type of documentation change.
- [ X ] New topic in an existing section or new section
- [ ] Update to an existing topic
3. - [ ] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:
4. - [ X ] Mandatory for GA content:
Update the note `Note: You must have the Red Hat {aap-short} Resource Operator installed from OperatorHub to create and run an {aap-short} job. To configure a cluster API address, see Optional: Configure the cluster API address` to
```
Note: You must have the Red Hat {aap-short} Resource Operator installed from OperatorHub to create and run an {aap-short} job.
To configure a cluster API address, see Optional: Configure the cluster API address
To configure your managed clsuter klusterlet to run on specific nodes, see Optional: Configure `nodeSelector` and `tolerations` annotations for managed cluster
```
And add a new optional operation
Optional: Configure `nodeSelector` (the key of this annotation is: `open-cluster-management/nodeSelector`, the value of this annotation is a string map with json format.) and `tolerations` (the key of this annotation is: `open-cluster-management/tolerations`, the value of this annotation represents a [toleration](https://github.com/kubernetes/api/blob/release-1.24/core/v1/types.go#L3007) list with json format) annotations for managed cluster klusterlet t to run the klusterlet on specific nodes with the following steps
- Set the YAML switch to ON in the console
- Add `nodeSelector` and `tolerations` annotations to the `ManagedCluster` yaml definition, e.g.
```yaml
apiVersion: cluster.open-cluster-management.io/v1
kind: ManagedCluster
metadata:
# other meta data
annotations:
open-cluster-management/nodeSelector: '{\"dedicated\":\"acm\"}'
open-cluster-management/tolerations: '[
]'
```
Add a new optional operation in below topics
https://github.com/stolostron/rhacm-docs/blob/2.8_stage/clusters/cluster_lifecycle/create_aws_govcloud.adoc
https://github.com/stolostron/rhacm-docs/blob/2.8_stage/clusters/cluster_lifecycle/create_google.adoc
https://github.com/stolostron/rhacm-docs/blob/2.8_stage/clusters/cluster_lifecycle/create_azure.adoc
https://github.com/stolostron/rhacm-docs/blob/2.8_stage/clusters/cluster_lifecycle/create_vm.adoc
In `Creating your cluster with the console` section, we need an optional operation
Optional: configure your managed cluster klusterlet to run on specific nodes with the following steps
- Set the YAML switch to ON in the console
- Add `nodeSelector` (the key of this annotation is: `open-cluster-management/nodeSelector`, the value of this annotation is a string map with json format) and `tolerations` (the key of this annotation is: `open-cluster-management/tolerations`, the value of this annotation represents a [toleration](https://github.com/kubernetes/api/blob/release-1.24/core/v1/types.go#L3007) list with json format) annotations to the `ManagedCluster` yaml definition, e.g.
```yaml
apiVersion: cluster.open-cluster-management.io/v1
kind: ManagedCluster
metadata:
# other meta data
annotations:
open-cluster-management/nodeSelector: '{\"dedicated\":\"acm\"}'
open-cluster-management/tolerations: '[
]'
```
- [ X ] Add link to dev story here:
https://issues.redhat.com/browse/ACM-2200
- Errata release note version, this is NOT for regular refreshes:
(published with Errata release)
- [ ] ACM 2.4.x
- [ ] ACM 2.5.x
- [ ] ACM 2.6.x
- [ ] MCE 2.0.x
- [ ] MCE 2.1.x