Updated on 2022-08-11 GMT+08:00

Installing the ICAgent

The following table describes the ICAgent status.

Table 1 ICAgent status

Status

Description

Running

The ICAgent is running properly.

Uninstalled

The ICAgent is not installed. For details about how to install the ICAgent, see Installing the ICAgent.

Installing

The ICAgent is being installed. This operation takes about 1 minute to complete.

Installation failed

Failed to install the ICAgent. Uninstall the ICAgent according to Uninstalling the ICAgent Through Logging In to the Server and then install it again.

Upgrading

The ICAgent is being upgraded. This operation takes about 1 minute to complete.

Upgrade failed

Failed to upgrade the ICAgent. Uninstall the ICAgent according to Uninstalling the ICAgent Through Logging In to the Server and then install it again.

Offline

The Access Key ID/Secret Access Key (AK/SK) are incorrect. Obtain the correct AK/SK and install the ICAgent again.

Abnormal

The ICAgent is abnormal. Contact technical support.

Restricted

The AOM license is restricted. Check the license and update it in a timely manner.

Prerequisites

Before installing the ICAgent, ensure that the time and time zone of the local browser are consistent with those of the server. If multiple servers are deployed, ensure that the local browser and multiple servers use the same time zone and time. Otherwise, metric data of applications and servers displayed on the console may be inaccurate.

Installation Methods

There are two methods to install the ICAgent. Note that the two methods are not applicable to container nodes created using ServiceStage or Cloud Container Engine (CCE). For container nodes, you do not need to manually install the ICAgent. Instead, you only need to perform certain operations when creating clusters or deploying applications.

For details, see Table 2.

Table 2 Installation methods

Method

Application Scenario

Initial installation

This method is used when the following conditions are met:

  1. An elastic IP address (EIP) has been bound to the server.
  2. The ICAgent has never been installed on the server.

Inherited installation

This method is used when the following conditions are met:

You have multiple servers on which the ICAgent is to be installed. One server is bound to an EIP, but others are not bound to an EIP. You can use this method to install the ICAgent on the servers that are not bound to an EIP.

Initial Installation

After you apply for a server and install the ICAgent for the first time, perform the following operations:

  1. Obtain an AK/SK.

    • If you have obtained the AK/SK, skip this step.
    • If you do not have an AK/SK, obtain them first.

  2. In the navigation pane, choose Configuration Management > Agent Management.
  3. Click Install ICAgent.
  4. Generate and copy the ICAgent installation command.

    1. Enter the obtained AK/SK in the text box to generate the ICAgent installation command.

      Ensure that the AK/SK are correct. Otherwise, the ICAgent cannot be installed.

    2. Click Copy Command.

  5. Use a remote login tool, such as PuTTY, to log in as user root to the server where the ICAgent is to be installed, and run the command copied in the previous step to install the ICAgent.
  6. Run the command copied in 4 and enter the obtained AK/SK as prompted to install the ICAgent.
  • If the message ICAgent install success. is displayed, the ICAgent is successfully installed in the /opt/oss/servicemgr/ directory. After the ICAgent is successfully installed, choose Configuration Management > Agent Management to view the ICAgent status.
  • If the ICAgent fails to be installed, uninstall it according to Uninstalling the ICAgent Through Logging In to the Server and then install it again. If the problem persists, contact technical support.

Inherited Installation

If the ICAgent has been installed on a server and the ICProbeAgent.tar.gz installation package exists in the /opt/ICAgent/ directory of this server, use this method to install the ICAgent on a remote server with a few clicks.

After the ICAgent is upgraded, the /opt/ICAgent/ directory and the files stored in it will be deleted. Therefore, reinstall the ICAgent and then perform inherited installation.

  1. Run the following command (x.x.x.x indicates the server IP address) on the server where the ICAgent has been installed:

    bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -ip x.x.x.x

  2. Enter the password of the root user of the server where the ICAgent is to be installed as prompted.

    • If both the Expect tool and the ICAgent have been installed on the server, the ICAgent will be installed on the remote server after the preceding command is executed. If the ICAgent has been installed on the server, but the Expect tool has not, enter the information as prompted.
    • Ensure that the root user can run the SSH or SCP command on the server where the ICAgent has been installed to remotely communicate with the server where the ICAgent is to be installed.
    • Ensure that the ICProbeAgent.tar.gz installation package is transmitted to the server to be installed.
    • If the message ICAgent install success is displayed, the ICAgent is successfully installed in the /opt/oss/servicemgr/ directory. After the ICAgent is successfully installed, choose Configuration Management > Agent Management to view the ICAgent status.
    • If the ICAgent fails to be installed, uninstall it according to Uninstalling the ICAgent Through Logging In to the Server and then install it again. If the problem persists, contact technical support.

Inherited Batch Installation

If the ICAgent has been installed on a server and the ICProbeAgent.zip installation package exists in the /opt/ICAgent/ directory of this server, use this method to install the ICAgent on multiple remote servers in batches with a few clicks.

  1. Ensure that you can run the SSH and SCP commands on the ECS server where the ICAgent has been installed to communicate with the remote ECS servers where the ICAgent is to be installed.
  2. If you have installed the ICAgent in a server through an agency, you also need to set an agency for other servers where the ICAgent is to be installed.
  3. Batch installation scripts depend on Python versions. You are advised to implement batch installation on hosts running Python 2.x. Python 3.x does not support batch installation.
  4. You need to press Enter at the end of each line in the iplist.cfg file.
  5. After the ICAgent is upgraded, the /opt/ICAgent/ directory and the files stored in it will be deleted. Therefore, reinstall the ICAgent and then perform inherited batch installation.

Prerequisites

The IP addresses and passwords of all servers for which the ICAgent is to be installed have been collected, sorted in the iplist.cfg file, and uploaded to the /opt/ICAgent/ directory on the server where the ICAgent has been installed. The following is an example of the iplist.cfg file, where IP addresses and passwords are separated by spaces.

192.168.0.109 password (Set the password as required.)

192.168.0.39 password (Set the password as required.)

  • Because the iplist.cfg file contains sensitive information, you are advised to clear the information after use.
  • If the passwords of all servers are the same, only list IP addresses in the iplist.cfg file and enter the password once during execution. If the password of an IP address is different from those of the other ones, list both passwords and IP addresses in the iplist.cfg file.
  • The batch installation function depends on Python 2.7.*. If the system displays a message indicating that Python cannot be found during the installation, install Python 2.7.* and try again.

Procedure

  1. Run the following command on the server where the ICAgent has been installed:

    bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -batchModeConfig /opt/ICAgent/iplist.cfg

    Enter the default password of the root user as prompted. If the passwords of all IP addresses have been configured in the iplist.cfg file, press Enter to skip this step. Otherwise, enter the default password.

    batch install begin
    start to install python pexpect module
    use local pyexpect package
    Please input default passwd:
    send cmd to 192.168.0.109
    send cmd to 192.168.0.39
    2 tasks running, please wait...
    2 tasks running, please wait...
    2 tasks running, please wait...
    End of install agent: 192.168.0.39
    End of install agent: 192.168.0.109
    All hosts install icagent finish.

    Wait until the message All hosts install icagent finish. is displayed, which indicates that the ICAgent is successfully installed on all the hosts listed in the configuration file.

  2. After the ICAgent is successfully installed, choose Configuration Management > Agent Management to view the ICAgent status.