Skip to main contentIBM Cloud Pak Playbook

ICAM - Installation Guide

Overview

In this section we will walk through the installation of the IBM Cloud Application Manager version 2019.4.0 component of the Cloud Pak for Multicloud Management. This document is specifically written for installations on OpenShift 4.2 with Multicloud Manager installed running on an x86 architecture.

Prerequisites

This document does not describe how to install or configure the underlying OpenShift platform. So prior to installing make sure you have a working OpenShift cluster with Multicloud manager installed with the required capacity.

  • Check the requirements doc to make sure you have size your cluster appropriately and you have capacity
  • For offline installs make sure you have downloaded the Cloud Pak for Multicloud Management Passport Advantage Archive (PPA) file (see requirements) and copied it to the installation server
  • For online installs make sure you have an entitlement key to access the IBM Entitled Docker Registry
  • The installation is performed from the Command line (CLI) so you will need the required CLI tools to interface with the cluster. Instructions on setting up the required CLI tools here: https://www.ibm.com/support/knowledgecenter/en/SSFC4F_1.2.0/cli/cli_guide_mcm.html
  • Offline installation will require the docker client install on the installation server

Online Installation

Offline Installation

  1. Download the Cloud Application Management Archive file

    File NamePart NumberVersion
    icam_ppa_2019.4.0_prod.tar.gzCC4KNEN1.2
    icam_ppa_2020.1.0_prod.tar.gzCC5WFEN1.3
  2. Create a cluster directory and move the ppa into the new directory

    mkdir cluster
    cd cluster
    mv <PACKAGE_NAME> .
  3. Use admin access to login to the MCM console

    cloudctl login -a < my_cluster_URL > -n kube-system --skip-ssl-validation

    Where < my_cluster_URL > is the name that you defined for your cluster.

    Ex. https://cluster_address:443, where cluster_address looks something like icp-console.apps.hostname-icp-mst.domain.com For future reference to the console use the value for cluster_address.

  4. Login to OpenShift as an administrator:

    oc login
  5. Login to the OCP Docker registry (assuming the OpenShift registry has been exposed - see exposing registry):

    docker login $(oc registry info) -u $(oc whoami) -p $(oc whoami -t)
  6. Load the installation image into IBM’s Docker Registry:

    cloudctl catalog load-archive --archive ./icam_ppa_2020.1.0_prod.tar.gz --registry $(oc registry info)/kube-system
  7. Prepare Persistent Storage

    Unless your storage class can handle 5000 IO Operations per second, IBM recommends setting up Persistant Storage backed by local disks or partitions.

    For help configuring persistent storage, see Understanding Kubernetes Storage

  8. Log in to the console UI of your target cluster from https://icp-console.apps.< cluster >.< domain >/

  9. Click Catalog in the Upper right-hand icon; select the Repositories > local-charts. Open the ibm-cloud-appmgmt-prod tile.

  10. Click Configure and specify the following:

  • Helm relase name: ibmcloudappmgmt

  • Target namespace: kube-system

  • Target cluster: local-cluster

  • License accepted: (checked)

  • Expand all parameters as you must customize more parameters than just the default, specify at least the following

  • Create CRD (checked)

  • Create TLS Certs (checked)

  • Cloud Console FQDN: icp-console.apps.< cluster >.< domain >

  • Cloud Console Port: 443

  • Cloud Proxy FQDN: icp-proxy.apps.< cluster >.< domain >

  • Cloud Master FQDN: icp-console.apps.< cluster >.< domain >

  • Cloud Master Port: 443

  • Image Repository: image-registry.openshift-image-registry.svc:5000/kube-system

    For configuration parameters, reference Table 1 in the Knowledge Center iCAM workbook.

  1. Click Install to deploy the ibm-cloud-appmgmt-prod Helm chart.

Post Installation

Now that your iCAM instance is successfuly installed, you can register with OIDC.

1. In your MCM console, select Monitor Health > Helm Releases, then select the release name that you gave for iCAM.

2. Scroll to the notes section at the bottom of your release and complete Step 3 (OIDC Registration) of the Notes section. Run the two kubectl commands that are displayed there.

Command 1 registers your iCAM instance with OIDC, and Command 2 adds two policy registrations.

Next Steps

Next, you can deploy the ICAM Klusterlet to monitor applications in your MCM environment. For more information, see Installing the ICAM klusterlet on the managed cluster guide for installing via the helm chart, or check out Installing the ICAM klusterlet on the managed cluster without helm for a non-helm installation.

Additional Resources