Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-29846

Document Search Collector addondeploymentconfig resourcerequirements

XMLWordPrintable

    • Quality / Stability / Reliability
    • 5
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected
    • Low
    • 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. - [/ ] 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:

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.15/html/search/acm-search#update-klusterlet-search

      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:

      In addition to the annotations in the existing documentation, users can update klusterlet-addon-search deployment resource requirements and limits by creating an AddonDeploymentConfig.addon.open-cluster-management.io/v1alpha1 resource in the managed cluster namespace on the hub resource like:

      apiVersion: addon.open-cluster-management.io/v1alpha1
      kind: AddOnDeploymentConfig
      metadata:
        name: search-addon-resources
        namespace: jorge-managed
      spec:
        resourceRequirements:
        - containerID: deployments:klusterlet-addon-search:collector
          resources:
            limits:
              memory: 1099Mi
            requests:
              memory: 199Mi
      

      The label

      cluster.open-cluster-management.io/backup: ""
      

      can be added to the labels to ensure the resource is backed up and included for disaster recovery.

      This resource then gets referenced in the managedclusteraddon and then the klusterlet-addon-search pod will be updated.

      oc patch managedclusteraddon search-collector -n jorge-test-managed --type merge -p '{"spec": { "configs": [{"group": "addon.open-cluster-management.io","resource": "addondeploymentconfigs","name": "search-addon-resources","namespace": "jorge-test-managed"}]}}'
      
      • [ ] *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.

              mdockery@redhat.com Mikela Jackson
              rh-ee-smcavey Spencer McAvey
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: