add documentation for docker compose

deployments/docker/README.md

@@ -1,8 +1,8 @@
 # Docker 
 
-The easiest, and let's say most natural, deployment is done by utilising `docker`. Docker can run a stand-alone, single, Kerberos Agent (or container) and a bigger set of Kerberos Agents (or containers) through `docker compose`.
+The easiest, and let's say most natural, deployment is done [by utilising `docker`](#1-running-a-single-container). Docker can run a stand-alone, single, Kerberos Agent (or container) and a bigger set of Kerberos Agents (or containers) [through `docker compose`](#2-running-multiple-containers-with-docker-compose).
 
-## Running a single container
+## 1. Running a single container
 
 We are creating Docker images as part of our CI/CD process. You'll find our Docker images on [Docker hub](https://hub.docker.com/r/kerberos/agent). Pick a specific tag of choice, or use latest. Once done run below command, this will open the web interface of your Kerberos agent on port 80.  
     
@@ -40,7 +40,50 @@ You attach a volume to your container by leveraging the `-v` option. To mount yo
 
 Next to attaching the configuration file, it is also possible to override the configuration with environment variables. This makes deployments easier when leveraging `docker compose` or `kubernetes` deployments much easier and scalable. Using this approach we simplify automation through `ansible` and `terraform`. You'll find [the full list of environment variables on the main README.md file](https://github.com/kerberos-io/agent#override-with-environment-variables).
 
-### Running multiple containers with Docker compose
+### 2. Running multiple containers with Docker compose
 
 When running multiple containers, you could execute the above process multiple times, or a better way is to run a `docker compose` with predefined configuration file, a `docker-compose.yaml`. 
 
+You'll find [an example `docker-compose.yaml` file here](https://github.com/kerberos-io/agent/blob/master/deployments/docker/docker-compose.yaml). This configuration file includes a definition for running 3 Kerberos Agents (or containers). By specifying environment variables you can override the internal configuration. To add more Kerberos Agents to your deployment, just `copy-paste` a `service` block and modify the name, exposed port, and settings accordingly.
+
+    kerberos-agent2:
+        image: "kerberos/agent:latest"
+        ports:
+        - "8082:80"
+        environment:
+        - AGENT_NAME=agent2
+        - AGENT_CAPTURE_IPCAMERA_RTSP=rtsp://x.x.x.x:554/Streaming/Channels/101
+        - AGENT_HUB_KEY=yyy
+        - AGENT_HUB_PRIVATE_KEY=yyy
+
+#### Attaching volumes
+
+As described in [1. Running a single container](#1-running-a-single-container) you can also assign volumes to your `docker compose` services. A volume can be added to persist the recordings of your Kerberos Agents on the host machine, or to provide more accurate configurations.
+
+When attaching a volume for persisting recordings or mounting configuration files from the host system. the `docker-compose.yaml` would look like this.
+
+Let's start by creating some directories on your host system. We'll consider 3 Kerberos Agents in this example.
+
+    mkdir -p agent1/config agent1/recordings
+    mkdir -p agent2/config agent2/recordings
+    mkdir -p agent3/config agent3/recordings
+
+Download the configuration file in each Kerberos Agent configuration directory.
+
+    wget https://raw.githubusercontent.com/kerberos-io/agent/master/machinery/data/config/config.json -O agent1/config/config.json
+    wget https://raw.githubusercontent.com/kerberos-io/agent/master/machinery/data/config/config.json -O agent2/config/config.json
+    wget https://raw.githubusercontent.com/kerberos-io/agent/master/machinery/data/config/config.json -O agent3/config/config.json
+
+Next we'll add a `volumes:` section to each Kerberos Agent (service) in the `docker-compose-with-volumes.yaml` file.
+
+    volumes:
+      - ./agent1/config:/home/agent/data/config
+      - ./agent1/recordings:/home/agent/data/recordings
+
+We'll repeat that for the other Kerberos Agents as well. You can review [the final result over here](https://github.com/kerberos-io/agent/blob/master/deployments/docker/docker-compose-with-volumes.yam). 
+
+Run the `docker compose` command by providing a different configuration file name.
+
+    docker compose -f docker-compose-with-volumes.yaml up
+
+Please note that you can use a combination of using a configuration file and environment variables at the same time. However environment variables will always override the setting in your configuration file.

deployments/docker/docker-compose-with-volumes.yaml

@@ -0,0 +1,27 @@
+version: "3.9"
+services:
+  kerberos-agent1:
+    image: "kerberos/agent:latest"
+    ports:
+      - "8081:80"
+    environment:
+      - AGENT_NAME=agent1
+      # You can still override the configuration with environment variables, but might not makes sense if you are attaching a host config.
+      # find full list of environment variables here: https://github.com/kerberos-io/agent#override-with-environment-variables
+    volumes:
+      - ./agent1/config:/home/agent/data/config
+      - ./agent1/recordings:/home/agent/data/recordings
+  kerberos-agent2:
+    image: "kerberos/agent:latest"
+    ports:
+      - "8082:80"
+    volumes:
+      - ./agent2/config:/home/agent/data/config
+      - ./agent2/recordings:/home/agent/data/recordings
+  kerberos-agent3:
+    image: "kerberos/agent:latest"
+    ports:
+      - "8083:80"
+    volumes:
+      - ./agent3/config:/home/agent/data/config
+      - ./agent3/recordings:/home/agent/data/recordings