Docs

Elastic Compute Service

Cloud assistant

Installing cloud assistant Agent

Before using cloud assistant, you need to install the cloud assistant Agent on all target instances. Otherwise, target instances can not be specified as the execution objects in O&M tasks.

Usage notes

Currently, you can only install and use the cloud assistant Agent on instances running operating systems specified in the Limits.

If you are logging in to the Cloud Assistant console for the first time, follow the instructions to grant cross-service access permissions to the cloud assistant.

Procedure

Install cloud assistant Agent during ECS instance creation

You can select the option of installing cloud assistant Agent when creating an ECS instance. This allows the cloud assistant Agent to be installed automatically after the instance is created.

tip

Currently, this feature is supported only when you are creating instances based on operating systems from "Public Images" (CentOS images earlier than version 6.9 are excluded). For more details on supported images, refer to Limits.

In the left-side navigation pane, select "Instances & Images > Instances".

Click the "Create instance" button to purchase an ECS instance. Then, configure the instance as the page guidance. For detailed operations, refer to Purchasing instances via wizard.

At the bottom of the "Basic configuration" page, select the needed public image, and then check the option "Install cloud assistant agent on startup".

After the instance is started, view the cloud assistant Agent status to confirm whether the cloud assistant Agent is installed. For detailed operations, refer to Viewing installation results.

Install the cloud assistant Agent on the existing ECS instances

For existing ECS instances, you can install the cloud assistant Agent in the console or by logging in to the created instances to install the cloud assistant Agent.

Install cloud assistant Agent in the console

Install cloud assistant Agent by executing the scripts manually

You can go to the console to install the cloud assistant Agent for multiple instances at the same time. You need to restart the instances first to make the changes take effect.

tip

Currently, this feature is not supported for Windows operating system instances. Please follow the guide in "Install cloud assistant Agent by executing the scripts manually" to install the cloud assistant Agent.

Select "Monitoring > Cloud assistant."

On theCloud assistantpage, select the "Client Management" tab.

Use any of the following methods to installCloud assistantclient.

Install the cloud assistant Agent on multiple instances

On the Agent management page, select multiple target instances that require the cloud assistant Agent installation.

You can select up to 50 instances at a time.

Click the "Install" button below the list.

Confirm whether you can install selected instances. If you can not install some selected instances, click the "Disallow install instance" tab to resolve issues as instructed, and then install instances. Or ignore instances on the "Disallow install instance" tab first and click the "Confirm" button to install instances on the "Allow install instance" tab.

After the installation is complete, the Installation result window pops up. Here, you can view the installation results. Then, click the "Restart" button to restart the instance for the cloud assistant Agent to take effect.

Install the cloud assistant Agent on one instance

Search for or query information about the target instance from the instance list.

Click the "Install" button in the "Action" column on the right side of the target instance.

After the installation is complete, the Installation result window pops up. Here, you can view the installation results. Then, click the "Restart" button to restart the instance for the cloud assistant Agent to take effect.

tip

If you do not want to restart the instance now, click the × icon in the upper-right corner of the pop-up window to exit. Later, you can restart the instance at your convenience.

You can manually execute the scripts provided by VolcanoEngine in the instance to install the cloud assistant Agent. After successful installation, you do not need to restart the instance.

Select installation commands based on operating system types.

Windows operating system

tip

*火山引擎If you use the script provided by , the cloud assistant Agent will be installed at the "C:/ProgramData/AssistClient" directory by default.

In this example, the CMD (Command Prompt) tool is used to execute related commands.

Installation through intranet

Due to differences in access regions, the executed commands also vary. Please input the corresponding command based on the actual region to install the cloud assistant Agent through the VolcanoEngine intranet.

Command format: curl http://assist-client-{region-code}.tos-{region-code}.ivolces.com/install.bat -o install.bat && install.bat

tip

Please replace {region-code} with the actual Region code you are accessing.

Example: In the Beijing Region, please execute the following command to install the Cloud assistant client.

curl http://assist-client-cn-beijing.tos-cn-beijing.ivolces.com/install.bat -o install.bat && install.bat

Installation through internet

If your ECS instance has been associated with an EIP, you can execute the following command on an instance in any region to install the cloud assistant Agent through the internet.

curl http://assist-client-cn-beijing.tos-cn-beijing.volces.com/install.bat -o install.bat && install.bat

Linux operating system

tip

*火山引擎The script provided by installs the cloud assistant Agent into the "/usr/local/assist-client" directory by default.

Installation through intranet

Due to differences in access regions, the executed commands also vary. Please input the corresponding command based on the actual region to install the Cloud assistant client through the VolcanoEngine intranet.

Command format: sudo bash -c \"$(curl http://assist-client-{region-code}.tos-{region-code}.ivolces.com/install.sh)\"

tip

Please replace {region-code} with the actual Region code you are accessing.

Example: In the Beijing Region, please execute the following command to install the Cloud assistant client.

sudo bash -c "$(curl http://assist-client-cn-beijing.tos-cn-beijing.ivolces.com/install.sh)"

Installation through internet

If your ECS instance has been associated with an EIP, you can execute the following command on an instance in any region to install the cloud assistant Agent through the internet.

sudo bash -c "$(curl http://assist-client-cn-beijing.tos-cn-beijing.volces.com/install.sh)"

Confirm whether the installation is complete based on the guidance in Viewing installation results.

Subsequent steps

Once the cloud assistant Agent is running normally, you can use the cloud assistant to perform O&M tasks. For details, refer to Creating O&M tasks.