Creating the agent package

You can use Agent Builder to create a compressed agent installation package.

About this task

An agent package contains all the fines necessary to run the agent, as well as the installation and configuration scripts. The package also includes support files for the monitoring environment.

You can use an agent package to install the agent into the IBM® Tivoli® Monitoring and IBM Cloud Application Performance Management environments.

Procedure

  1. Click the itm_toolkit_agent.xml file from the Project Explorer navigation tree of Agent Builder by using one of the following methods:
    • Right-click the itm_toolkit_agent.xml file and select IBM > Generate Agent.
    • Select the itm_toolkit_agent.xml file and select the Generate Agent Generate Agent icon on the toolbar.
    • Double-click the itm_toolkit_agent.xml file and select Agent Editor > Generate Agent.
  2. Enter the name of the directory where you want to place the output (a compressed package or expanded files) in the Generate Agent Image section.
  3. Optional: Select the Keep intermediate files check box to keep the generated expanded files separate from the zip or tar file.
  4. Select the Create a ZIP file check box to create a compressed file in the specified directory. The compressed zip file is named smai-agent_name-version.zip for Windows systems by default.
  5. Select the Create a TAR file check box to create a tar file in the specified directory. The compressed tar file is named smai-agent_name-version.tgz for UNIX and Linux® systems by default.
  6. Select the agent components to generate. You can select Base Agent, Cognos Reporting, or both.
    Important: For the IBM Cloud Application Performance Management environment, do not select Cognos Reporting, because the reports are currently not supported and including the reports increases the size of the package.
  7. You can optionally provide security signing for agent application files. If you want to provide security signing, select Sign self-describing support JAR. Click Edit all jar signing preferences. You can add a timestamp to signed jar files and specify the time stamping authority. Specify details about your Java™ Keystore File.
    Important: You can create the Java Keystore File by using Java tools. For example, to generate a private key and certificate with a corresponding public key in a Java Keystore File, you can run this command:
    • ab_install_path/jre/bin/keytool -genkeypair -keystore keystore_file_path -storepass key_store_password -alias key_store_alias -dname "CN=common_name, OU=organizational_unit, L=city_or_locality, ST=state_or_province, C=country" -keypass key_password
    Where:
    • ab_install_path is the location where Agent Builder is installed
    • keystore_file_path is the path where an existing JKS key store resides, or where one will be created
    • key_store_password is the password needed to access any items in this key store
    • key_store_alias is a name identifying this key within the key store (defaults to "mykey")
    • key_password is the password needed to access this particular key (defaults to key_store_password)
    Include this certificate in the server key store.
  8. Click Finish.