Installing the ICAM klusterlet on the managed cluster with Helm

By installing the ICAM klusterlet on any managed cluster, you can use this ICAM klusterlet to configure and receive Kubernetes events from the cluster.

Before you begin

The Cloud App Management server with IBM Cloud Pak for Multicloud Management must be installed on the hub cluster. For more information, select the specific installation scenario topic for your environment from Installing IBM Cloud App Management with IBM Cloud Pak for Multicloud Management.

You must import a managed cluster. For more information, see Importing a target managed cluster to the hub cluster.

About this task

Install the IBM Cloud CLI from the management console. Click Menu > Command Line Tools > Cloud Private CLI to download the installer by using a curl command. Copy and run the curl command for your operating system. For more information, see Installing the IBM® Cloud Private CLI.

Procedure

  1. Locate the ICAM klusterlet packages on IBM Passport Advantage. Find the installation image by searching for it using its part number. Choose one of the following packages based on your platform:
    • For Linux® on Power®, choose the Multicluster Event Management Klusterlet for PlinuxLE (part number: CC4KXEN): agent_ppa_2019.4.0_prod_ppc64le.tar.gz
    • For Linux® x86_64, choose Multicluster Event Management Klusterlet on AMD64 (part number: CC4KZEN): agent_ppa_2019.4.0_prod_amd64.tar.gz
  2. As an OpenShift administrator, log in to the OpenShift Container platform and log in to the Docker registry. Then, load the ICAM klusterlet PPA installation image file into the Docker registry:
    cloudctl login -a my_cluster_URL -n my_namespace --skip-ssl-validation -u username -p password
    docker login $(oc registry info) -u $(oc whoami) -p $(oc whoami -t)
    cloudctl catalog load-archive --archive ppa_file --registry $(oc registry info)/my_namespace
    Where my_cluster_URL is the name that you defined for your cluster such as https://cluster_address:443, ppa_file is the ICAM klusterlet PPA image file name, and my_namespace is multicluster-endpoint.
  3. In subsequent steps in the ICAM klusterlet configuration, you are prompted for the MCM Fullname Override value, which is the helm release name for the IBM Cloud Pak for Multicloud Management multicluster endpoint on the system. Run the following commands to determine this value. If you installed IBM Cloud Pak for Multicloud Management by using the Helm chart, the Helm release name is the first part of the pod name. In the following example, the Helm release name is example.
    kubectl get pods --all-namespaces | grep klusterlet
    kube-system example-ibm-mcm-klusterlet-klusterlet-66d565q5hnp 4/4 Running 0 2m
    kube-system example-ibm-mcm-klusterlet-weave-scope-2f6ml 1/1 Running 0 2m
    If you installed IBM Cloud Pak for Multicloud Management by using the cloudctl CLI instead of the Helm chart, run the following command on your IBM Cloud Pak for Multicloud Management multicluster endpoint to obtain the MCM Fullname Override.
    kubectl get secrets -n multicluster-endpoint |grep hub-kubeconfig
    endpoint-connmgr-hub-kubeconfig Opaque 1 8d
    
    The MCM Fullname Override value is endpoint-connmgr.
  4. Log in to the management console of your target cluster.
  5. Click Catalog.
  6. Search for and select the icam-clouddc-klusterlet Helm chart.
  7. Click Configure.
  8. Configure the following configuration parameters:
    Helm release name
    Enter the helm release name for the ICAM klusterlet.
    Target namespace
    From the drop-down menu, select the namespace where IBM Cloud Pak for Multicloud Management is installed in step 2.
    Target cluster
    The cluster on which icam-clouddc-klusterlet is being installed.
    Product License Acceptance
    Accept the product license by selecting the checkbox.
    Images Repository
    The image repository must be set to the registry name and namespace that the PPA was loaded to in step 2.
    Note: For OCP 4.2 or later environment that has openshift-image-registry route, use the internal docker image repository. Find the internal docker image repository by using the command: oc registry info --internal
    Images Prefix
    Leave this blank.
    Product Deployment Size
    From the drop-down menu, select the appropriate value.
    Replica Count
    Ignore this field.
    MCM Fullname Override
    The helm release name for the IBM Cloud Pak for Multicloud Management multicluster endpoint on the system. Use the value from step 3.
    Alert target CRD
    Ignore this field.
  9. Click Install to deploy the icam-clouddc-klusterlet Helm chart.

What to do next

  1. Update the IBM Cloud Pak for Multicloud Management team for Cloud App Management. When a managed cluster is imported, the namespace corresponding to the managed cluster is created at the hub cluster. To activate monitoring of the managed cluster resources, add the namespace as a resource to a Cloud App Management team. On the console, click Manage > Identity and Access > Teams. For more information, see Adding the Helm repository and namespace to a team.
  2. On the console, click the Incidents menu to update the ICAM klusterlet with the correct webhook for Cloud App Management events.
  3. Install and configure Cloud App Management agents and data collectors to collect data and metrics. For more information, see Deploying agents and data collectors for IBM Cloud Pak for Multicloud Management.