On-Prem Agent Container Image Management

This document provides information on how to use the Moveworks Agent container image directly, without the setup script.

This guide is for advanced deployments that manage the container image directly. Most installations should use the setup script instead — see the Installation Guide.

Image Details

Image Name: moveworks/agent
Version: See ECR gallery for the latest version tag
Maintainer: Moveworks
ECR Repository URL: public.ecr.aws/moveworks/agent:<version>

Features

Default Workdir: The default working directory is set to /home/moveworks/agent.
Configuration Management: Place your configuration YAML file, named agent_config.yml in /home/moveworks/agent/conf.
Certificate Handling: Store required certificates in /home/moveworks/agent/certs. The agent creates an agent_key.pem certificate to encrypt agent_config.yml; write permissions are needed if this directory is being mounted.
Logging: All log files are created in /var/log/moveworks and are also streamed to standard output.
Directory Permissions: When mounting the above directories, ensure all files have read and write permissions for user_id 17540 and group_id 17540.

Requirements

Docker Version: Ensure you have Docker version 20.10.0 or higher.
Host OS: Compatible with Linux x86_64 only.

Usage

Pulling the Image

$ docker pull public.ecr.aws/moveworks/agent:<version>

Running the Container

$ docker run -d \
>   -v /path/to/local/conf:/home/moveworks/agent/conf \
>   -v /path/to/local/certs:/home/moveworks/agent/certs \
>   -v /path/to/local/logs:/var/log/moveworks \
>   -e LOG_LEVEL=INFO \
>   public.ecr.aws/moveworks/agent:<version>

Example

$ docker run -d \
>   -v /myapp/conf:/home/moveworks/agent/conf \
>   -v /myapp/certs:/home/moveworks/agent/certs \
>   -v /myapp/logs:/var/log/moveworks \
>   -e LOG_LEVEL=DEBUG \
>   public.ecr.aws/moveworks/agent:<version>

Container Configuration

Environment Variables:
- LOG_LEVEL: Sets the logging level. Options include INFO, DEBUG, WARN, CRITICAL, etc.
Volumes:
- /home/moveworks/agent/conf: Mount your configuration files here
- /home/moveworks/agent/certs: Mount your certificates here.
- /var/log/moveworks: Mount this directory to access log files.

$	docker run -d \
>	-v /path/to/local/conf:/home/moveworks/agent/conf \
>	-v /path/to/local/certs:/home/moveworks/agent/certs \
>	-v /path/to/local/logs:/var/log/moveworks \
>	-e LOG_LEVEL=INFO \
>	public.ecr.aws/moveworks/agent:<version>

$	docker run -d \
>	-v /myapp/conf:/home/moveworks/agent/conf \
>	-v /myapp/certs:/home/moveworks/agent/certs \
>	-v /myapp/logs:/var/log/moveworks \
>	-e LOG_LEVEL=DEBUG \
>	public.ecr.aws/moveworks/agent:<version>