Deploy the agent

This topic describes downloading, configuring, and deploying images for the Edge Agent.

Download images and configuration files

Go to Axway support and log on. Look up downloads for your product and version. Find the file for Amplify Edge Agent 1.1. Download the archive file. It contains the following image files to deploy on Docker.

Image file Service
confluentinc_cp-kafka.tar.gz Kafka
confluentinc_cp-zookeeper.tar.gz Zookeper
axway_edge-agent.tar.gz Amplify Edge Agent

In addition, you must download separately the agent configuration files for your product and version. There are two files per product:

  • An input configuration file that defines the type of data the agent collects from your product.
  • A report configuration file the agent uses to aggregate the data to upload to the platform.

Install the Edge Agent CLI

Install the Axway Edge Agent CLI as an extension of the Axway CLI.

To install the Axway Edge Agent CLI, run the following command from the terminal:

axway pm install @axway/axway-edge-agent-cli

Refer to the Axway Edge Agent CLI reference documented in the Axway CLI guide for details.

Deploy images

Use the following command to load all the Docker images in any order:

docker load -i <image file>

Configure the agent

You do not need to change anything for the agent to run.

If you want to make changes, you can update the agent configuration file (<install_directory>/.env). Your changes will take effect on your next agent start.

Read about the most frequently changed configuration options in Security settings and Services and data.

Deploy product configuration files

After deploying the agent, copy the product-specific configuration files to the following directories:

  • The input configuration file to the aggregationConfigurationDir.
    • This property is defined in the agent configuration (<install_directory>/.env) and defaults to ./conf/agent/aggregation.
  • The report configuration file to reportConfigurationDir.
    • This property is defined in the agent configuration (<install_directory>/.env) and defaults to ./conf/agent/report.

You must edit the report configuration file to add the environment ID associated with your platform organization. See Configure the platform.

Complete the steps in Enable the product to report usage through the Edge Agent section.

Grant file access on agent host

You must grant the agent runtime user access rights to the files it uses from the host filesystem.

Using the default configuration, run these commands:

sudo chown -R 11001:11000 <install_directory>/data/agent
sudo chown -R 11001:11000 <install_directory>/conf/agent

If you want to change the default paths, follow Security settings - Filesystem for used files, users and their required access rights.

Do not use the agent in production without granting file access for persistence. Failure to do so would result in loss of data.

Start using the agent

Manage and use the agent as described in Agent operations.

Related Links