3 minute read
The Edge Delta agent can be installed using Docker. You can either run the Edge Delta image stored in the Edge Delta public repository with default settings or you can use a local configuration file. The Edge Delta agent is installed as a container, and it analyses logs and metrics from other containers on the host before streaming them to the configured destinations.
Installing with Default Settings
You can install Edge Delta using Docker without changing any default settings. You first create an Edge Delta agent configuration for Docker if one doesn’t exist in the Edge Delta web app. Then you deploy the agent by running the Edge Delta image, passing in a secret key to your Edge Delta web app configuration.
Create an Edge Delta Agent Configuration
Select the Docker template option in the following steps:
- In the Edge Delta App, click Data Pipeline, and then click Agent Configs.
- Click Create Configuration.
- Select the appropriate template.
- Specify a tag to identify the agent and environment.
- Click Create Configuration.
- Optionally, modify and test the agent configuration then click Save Edits or Done.
The agent table is updated with a new agent configuration with the agent tag you specified.
Deploy an Edge Delta Agent
- In the agent table, click the hamburger button for the newly created agent configuration and click Deploy Instructions.
- Select Docker.
- Copy and run the command on the Docker host.
This onscreen command creates a container named Edge Delta, passes in the API key required to connect your agent to your Edge Delta account on the web app, and installs the latest image located on the Edge Delta public repository. The following example shows the command in the instructions but with an example key 123456789.
docker run --rm -d --name edgedelta -v /var/run/docker.sock:/var/run/docker.sock:ro -e "ED_API_KEY=123456789" gcr.io/edgedelta/agent:latest
Alternatively, you can visit gcr.io/edgedelta/agent and choose a specific agent version.
Installing with Custom Settings
Using a Local Configuration File
If you have a local config.yaml file for the agent on the host, you can specify that file by adding the following parameter to the docker run command provided by the web app. In this example, you replace
$PWD/config.yml with the absolute path of the local configuration file
-v $PWD/config.yml:/edgedelta/config.yml \
Specifying Resource Limits
The Edge Delta agent is a very lightweight resource. Nevertheless, you can limit the CPU or memory resources that the Edge Delta container consumes by adding the following parameter to the docker run command provided by the web app.
--cpus=".25" --memory="256m" \
In this instance the Edge Delta container is limited to one quarter of one CPU and a maximum of 256MB of RAM.
See here for other docker resource constraints that can be set.
Troubleshooting the Agent
To verify that the agent’s container is running, run the following command. A container with edgedelta as the IMAGE name should be listed.
To check the agent’s log file for any errors that may indicate an issue with the agent, configuration, or deployment settings, first run the following command to view all containers (whether running or not). This command will display the CONTAINER ID of the Edge Delta Agent.
docker ps -a
Next, copy the container ID of the agent, which should be listed at the top of the list of containers, and run the following command with the agent’s container ID:
docker logs <container-id>