Preparing to install your server

To monitor your environment, you must first install the Cloud APM server and supporting components. Review the options and requirements to help you plan your installation of the Cloud APM server.
What gets installed with the Cloud APM server

The installation also installs a Db2® server, a Summarization and Pruning agent, and a MongoDB database on the same system as the Cloud APM server. The Db2 database stores application definitions and relationship and metric data. The MongoDB database stores threshold event and transaction tracking data.

Requirements and supported operating systems

You must have root permissions to install and run the Cloud APM server. Running the Cloud APM server as a non-root user is not supported.

Review the System requirements and Dependencies topics for the supported operating systems and requirements for the Cloud APM server.

Configuring the downloaded images while you are installing the server
Before you can install agents, install the IBM Cloud Application Performance Management Hybrid Gateway, or configure the data collector, you must configure the downloaded images for communication with the Cloud APM server. The downloaded images can be configured automatically during server installation if you download the images to the system where the server will be installed.

The downloaded images can be mounted on an NFS partition but the images must be accessible by the file system. Do not change the installation image file names during or after download. If an installation image file name is changed, it is not recognized by image configuration tools and configuration fails. For more information, see Download instructions.

Configuring your virus scan program to exclude Db2 database files
If you are using a virus scan program such as McAfee Virus Scan for Linux or Sophos, you must configure the virus scan program to exclude all Db2 database files; including storage groups, table spaces, and buffer pools. Configure the virus scan program before you install the Cloud APM server. The Db2 database files are installed in the install_dir/db2 directory by default, for example, /opt/ibm/db2.
Creating Db2 users before you install the Cloud APM server
The Cloud APM server installation creates a Db2 server on your local system. Several Db2 instance users and groups are created during installation and each user assigned to its respective group. To adhere to your organization's database server administration policies, you might want to create the Db2 instance users before the Db2 server is installed. For more information, see Creating Db2 users before you connect to a local Db2 server.
Connecting to a remote Db2 server
If you have a remote Db2 server, you can use it for the Cloud APM server databases rather than installing the local default Db2 server with the Cloud APM server installation.

You might want to connect to a remote Db2 server on an external system to adhere to your organization's database server administration policies. Connecting to a remote Db2 server also reduces the load on the Cloud APM server, which improves performance. Consider a remote Db2 setup when the necessary disk I/O performance cannot be achieved on the hardware that is allocated for your Cloud APM server.

The Db2 installer creates the dasuser1 user and the dasadm1 group and assigns the dasuser1 user to the dasadm1 group. You must manually create all other users and groups and assign the users to the appropriate groups.

For more information, see Connecting to a remote Db2 server.

Installing MongoDB on a remote system

For scalability purposes, you can install MongoDB on another system. For more information, see Installing a remote MongoDB.

Installing the Cloud APM server on a computer system where LDAP authentication is used

If the system where you plan to install the Cloud APM server with a local Db2 server is using an external directory service with LDAP for user authentication, you must update itmuser and Db2 instance user passwords if they are configured in your directory service. You must update these passwords before you install the Cloud APM server. After you install the Cloud APM server, you must configure the LDAP security plug-in on the local Db2 server. For more information, see Installing on a system using an external directory service.

If you plan to use transparent LDAP authentication on the system where you are installing the Cloud APM server, you must use a remote Db2 server rather than installing the Db2 server locally with the Cloud APM server. For more information, see Connecting to a remote Db2 server and LDAP-based authentication and group lookup support.

OIDC
OpenID Connect (OIDC) is a simple identity protocol over OAuth 2.0. OIDC is enabled in Cloud APM console. With OIDC, a client application can request the identity of the user as an ID token in a standardized, REST-like manner. In addition, the client application can use access tokens to access REST-like Services.

A self-signed certificate is created for OIDC during installation. You can configure a self-signed certificate or a CA signed certificate for OIDC. For more information, see Configuring certificates by using a Third-Party Root Certificate Authority and Configuring certificates by using a private root certificate authority.

Replacing Cloud APM, Base with the Cloud APM, Advanced offering

You can replace Cloud APM, Base with the Cloud APM, Advanced offering at any time after you installed the Cloud APM, Base offering or upgraded to the Cloud APM, Base offering. Replacing Cloud APM, Base with Cloud APM, Advanced can take longer than installing Cloud APM, Advanced only. For more information, see Switching from one offering to another offering.

APMUI
APMUI is the Cloud APM console component that handles incoming user interface requests. It is built on WebSphere Liberty. The server.xml file contains an include statement for user-exit.xml. All customization should be done on user-exit.xml so that customization is not lost during an upgrade.