Preparing the deployment of Unified Agent

Before you deploy the Unified Agent, you need to download the Unified Agent Greenfield package and the configuration package, and ensure that your environment meets the prerequisites.

Before you begin

General prerequisites
  • Docker 1.7.1 or higher version
  • Helm client and server (Tiller) version 2.11.0 or higher
    Note: In OpenShift environment, you need to manually install Helm client and server, and grant user access to Tiller:
    • Do steps 1-3 as stated in the page of Getting started with Helm on OpenShift.
    • Grant user access to Tiller by running the following command:
      oc adm policy add-role-to-user edit username -n namespace
      Where username is the username that you use to deploy the Unified Agent, and namespace is the namespace where you install Tiller.
    • Make sure that the project where you want to deploy the Unified Agent exists and you have access to this project. Run the following command to grant the access:
      oc adm policy add-role-to-group edit username -n project
      Where project is the project to deploy the Unified Agent.
  • Kubectl client on the environment from where you are installing
Special prerequisites for plug-ins
Table 1. Prerequisites for each plug-in of Unified Agent
Plug-in System requirements Other requirements
Jaeger and Zipkin Link not applicable
NGINX Link Make sure the NGINX monitoring interface is enabled. For more information, see Enabling the NGINX monitoring interface.
Redis Link not applicable
IBM API Connect Link
  • The API Connect toolkit is required to provide CLI commands to register the plug-in.
  • The Unified Agent must be deployed in the same Kubernetes environment as IBM API Connect
  • Make sure the service account that you use to install and configure the IBM API Connect plug-in must have access to Kubernetes resources. For more information, see Authorizing the plug-ins to access Kubernetes resources.
  • This plug-in leverages Kubernetes Metrics API to get the pod CPU and Memory usage, so metrics server is required to be deployed in the cluster.
IBM App Connect Enterprise Link
  • Make sure the service account that you use to install and configure the IBM App Connect Enterprise plug-in has access to Kubernetes resources. For more information, see Authorizing the plug-ins to access Kubernetes resources.
  • Make sure the Prometheus service for IBM App Connect Enterprise is launched.
IBM MQ Link
DEM Link not applicable
OpenShift Link not applicable

About this task

Before proceeding to deploy the Unified Agent, download the Unified Agent greenfield eImage, log in to the Cloud App Management console and download the agent configuration package.

The eImage is the Unified Agent Greenfield package and contains all the installable plug-ins. The configuration package (ConfigPack) contains the configuration files with authentication information required to communicate with the Cloud App Management server and, if the Cloud App Management server is HTTPS enabled, the required certificates.

Procedure

  1. Download the Unified Agent package unifiedAgent_2019.4.0.1.tar.gz from IBM Passport Advantage®.
    For more information, see Part numbers.
  2. Download the configuration package:
    1. Log in to the Cloud App Management console, click the Get Started link on the Welcome page, then select Administration > Integrations.
      Integrations hexagon
    2. Click the New an integration button.
      Incoming and Configure an integration buttons selected.
    3. In the Standard monitoring agents section, select the Data Collectors Configure button.
    4. Select Download file and specify the directory where you want to save the compressed ConfigPack file.
      The ibm-cloud-apm-dc-configpack.tar file is downloaded.

What to do next

After you complete the preparation steps, you are ready to deploy the Unified Agent.