-
Task
-
Resolution: Done
-
Normal
-
None
-
Product / Portfolio Work
-
5
-
False
-
-
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
- [ ] 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. - [x] 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:
(I'm not 100% sure this is the best place to put this document, just a suggestion)
Change the "After the managed cluster joins the hub, any ClusterClaim that is created on a managed cluster is synchronized with the status of the ManagedCluster resource on the hub cluster. " to:
After the managed cluster joins the hub, the following two types of clusterclaims created on the managedcluster are synchronized with the status of the ManagedCluster resource on the hub cluster(note clusterclaim with label "open-cluster-management.io/spoke-only" will not be synchronized):
1. Clusterclaims managed by ACM: such as "id.k8s.io", or with the suffix "open-cluster-management.io" or "openshift.io". All these clusterclaims will be synchronized to the managedcluster status on the hub.
2. Clusterclaims managed by customers without the suffix "open-cluster-management.io" or "openshift.io": By default, up to 20 ClusterClaims will be synchronized to the managedcluster status on the hub, and more than 20 will not be synchronized. The threshold 20 can be configured by the klusterletconfig API:
1) Create a klusterletConfig and set the clusterClaimConfiguration.maxCustomClusterClaims 30
kind: KlusterletConfig apiVersion: config.open-cluster-management.io/v1alpha1 metadata: name: klusterlet-cluster-claim-config spec: clusterClaimConfiguration: maxCustomClusterClaims: 30
2) Use annotation to refer the klusterletconfig in the managedcluster, you can add the annotation by `oc annotate managedcluster <cluster-name> agent.open-cluster-management.io/klusterlet-config="klusterlet-cluster-claim-config"`, the managedcluster should look like:
apiVersion: cluster.open-cluster-management.io/v1
kind: ManagedCluster
metadata:
annotations:
agent.open-cluster-management.io/klusterlet-config: klusterlet-cluster-claim-config
name: cluster1
spec:
hubAcceptsClient: true
leaseDurationSeconds: 60
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
https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12
Doc staged repo within the ACM Workspace:
https://github.com/stolostron/rhacm-docs
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: https://issues.redhat.com/browse/ACM-20141
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.