Configuring the downloaded images

Complete these steps to download and configure the downloaded images:

1. Download the agent, the data collector, or Hybrid Gateway images to a Cloud APM server (see Download instructions).
2. Create the configuration package files by running the make configuration package script in interactive mode or batch mode:
   • Run the make configuration package script in interactive mode:
     1. On the system where the Cloud APM server is installed, navigate to the default /opt/ibm/ccm directory or to the custom_path/ccm directory that you specified during server installation, and enter the following command:

        ./make_configuration_packages.sh

     2. When prompted, enter the IP address or host name of the Cloud APM server that you want the agent, data collector, or Hybrid Gateway to connect to or accept the default.
     3. Enter the directory where you want to store the configuration package after it is created or accept the default value of /opt/ibm/ccm/mkcustpkg_workdir.process_ID_of_script.
     4. Select the communication protocol. For secure communications, select the HTTPS protocol. For non-secure communications, select the HTTP protocol. The communication protocol between server and agents or data collectors must be the same. For more information, see Setting HTTP or HTTPS communications.
   • Run the script in batch mode by entering the following command:

      ./make_configuration_packages.sh -s server_ip 
     [-p communication_protocol] [-k key_file_dir] [-d config_package_dir]
      [-n]

     -s server_ip

     (Required) IP address or fully qualified domain name of the server.

     -p communication_protocol

     (Optional) Possible values are http and https. The default communication protocol is HTTP. If you set the protocol to secure HTTPS before you install the server, enter -p https to change the protocol for the agents or data collectors to HTTPS so that it matches what was set for the server. For more information, see Setting HTTP or HTTPS communications.

     -k key_file_dir

     (Optional) Path to the keystore files to be used with the agents. The -k option is needed only if you have created a custom certificate for the agent to server HTTPS connection (Configuring a self-signed certificate or Configuring a Third-Party Root CA custom certificate for HTTPS agent communications).

     -d config_package_dir

     (Optional) Path to the directory where you want to store the configuration package after it is created.

     -n

     (Optional) Do not validate input parameters that are used in the agent configuration, for example, server host name.

   A configuration package file, onprem_config.tar, is created in the default directory or where you specified.
3. Configure the downloaded images (agent, data collector, or Hybrid Gateway) on Linux® system interactively or in batch mode.
   You can configure the image before or after you extract the image files. For AIX® systems, run the script on a Linux system, preferably the Cloud APM server and copy the configured image archive file to your AIX® system.
   • Run the configure images script in interactive mode:
     1. Enter the following command:

        ./configure_agent_images.sh

     2. If you unpacked the downloaded images, enter the path to the directory where you unpacked the image.
     3. If you did not unpack the downloaded images, enter the path to the directory where you downloaded the archive file.
     4. If you did not unpack the downloaded images, enter the path to the directory where you want to store the configured images archive file. Use the following default path or specify a different path:

        /opt/ibm/ccm/depot

     5. If you run the script in an environment where the agent framework is not available in the default location, server_install_dir/ccm/AgentFrameworks, enter the path to the directory with the unpacked agent offering frameworks.
   • Run the configure images script in batch mode by entering the following command:
     

     ./configure_agent_images.sh -p config_package_dir 
     
     -s download_images_dir [-a agent_frameworks_dir] [-d configured_images_dir]

     -p config_package_dir

     Required. If you did not unpack the configuration package, enter the path to the directory where the configuration package is located.

     -s download_images_dir

     Required. Path to the directory where you downloaded the images archive file. If you unpacked the images, this variable is the path to the directory where the unpacked agent or data collector images are located.

     -a agent_frameworks_dir

     Optional. Directory that contains unpacked agent offering frameworks packages. These files are available in the server_install_dir/ccm/AgentFrameworks directory on the Cloud APM server by default. If default agent offering frameworks packages are used, this variable is not required.

     -d configured_images_dir

     Optional. If you did not unpack the images archive file, this variable is the path to the directory where you want to store the configured agent or data collector images archive file.

     -h

     Displays help for the configure_agent_images.sh command.

   If you get a message that one or more agent images are skipped, upgrade your server installation. Then, run the configure agent images script. For more information, see Upgrading your server.