Sync Agent

The tool is intended to simplify configuring dockerized applications running in the cloud.

Design

Sync Agent is a simple application that exposes access to local folder through simple REST API. The following setup can be used to let Sync Agent manage configuration of an app running in a sibling container on the same host.

Installation

Sync Agent can be launched locally or on remote machine using this command:

docker run -d \
  -p 8080:8080 \
  -e SYNC_FOLDER=/opt/host \
  -v /host/folder/to/expose:/opt/host \
  --name sync-agent \
  glympse/sync-agent:latest

API Endpoints

There API endpoints are exposed by running instance of Sync Agent.

api/1

GET /api/1/list

Returns the list of files available at the location where Sync Agent instance is pointed at.

GET /api/1/get
  ?name=...

Responds with the contents of requested file.

POST /api/1/update
  ?name=...

Uploads new file with the specified name and contents from request body.

Integrations

Docker Cluster includes a plugin that utilizes Sync Agent API:

Disclaimer

Keep in mind that Sync Agent exposes API that makes it possible to modify local filesystem within Docker container. It is highly recommended to use Sync Agent for educational and experimental purposes only.

License

Code is licensed under the The MIT License.
Documentation is licensed under Creative Commons Attribution 4.0 International License.