Adding external volume to docker_run (#2)

* added volume entry in tasks

* volume entryes added in default

* volume variable update to host_volume

* Update README.md

* Update main.yml

* Update main.yml

* Update README.md

* Update main.yml

* Update main.yml

* Update main.yml

* Update nginx.yml

* Update test.yml

* Update main.yml

* Set docker_run_volume variable

* Update main.yml

* set docker variable

* Update nginx.yml added variable

* Update test.yml

* Update main.yml typo

* Update README.md

* Update README.md

README.md

@@ -2,6 +2,7 @@ Role docker_run
 =========
 
 The role starts a docker container from the specified image and parameters.
+The role support the definition of an external volume for data storage.
 
 Requirements
 ------------
@@ -18,7 +19,7 @@ Role Variables
 - `docker_run_env_variables`: list of environment variables (key/value pair) - see below. Default: [] 
 - `docker_run_ports`: list of ports to publish from the container to the host. Use the docker CLI syntax, e.g. [ "8080" ] or [ "8080:80" ].  Default: []
 - `docker_run_command`: command to be executed, can be left blank
-
+- `docker_run_volume`: volume path on the container side, see more under the "External volume" section.
 
 Environment variables
 --------------
@@ -28,6 +29,11 @@ Varaible(s) are copied down into a file .env that is used to start the container
 env_file: /opt/{{ docker_run_appname }}/.env  --> path to file containig a list of environment variables in the form FOO=BAR
 ```
 
+External volume
+--------------
+Volume path on the container side is mounted by populating the variable `docker_run_volume`.
+Volume path on the host side is set by default to "/data". It can be changed by modifying the `docker_run_host_volume` variable under `defaults/` folder.
+
 Dependencies
 ------------
 
@@ -46,6 +52,7 @@ Example Playbook
       docker_run_tag: latest
       docker_run_ports: [ "8080:80" ] 
       docker_run_command: ""
+      docker_run_volume: ""
 ```
 
 

defaults/main.yml

@@ -6,3 +6,5 @@ docker_run_tag: latest
 docker_run_env_variables: []
 docker_run_ports: []
 docker_run_command: ""
+docker_run_volume: ""
+docker_run_host_volume: "/data"

tasks/main.yml

@@ -12,14 +12,17 @@
         state: touch
         mode: u=rw,g=r,o=r
 
-
     - name: Set environment variables
       lineinfile:
         path: /opt/{{ docker_run_appname }}/.env
         line: "{{ item.key }}={{ item.value }}"
         create: yes
       with_dict: "{{ docker_run_env_variables }}"
 
+    - name: Set docker_run_volume_on_container variable
+      set_fact:
+        docker_run_volume_on_container: "{{ docker_run_host_volume }}:{{ docker_run_volume }}:rw"
+      when: docker_run_volume is defined and docker_run_volume != ''
 
     - name: Running the container
       docker_container:
@@ -28,5 +31,6 @@
         env_file: /opt/{{ docker_run_appname }}/.env
         command: "{{ docker_run_command }}"
         ports: "{{ docker_run_ports }}"
+        volumes: "{{ docker_run_volume_on_container | default(omit) }}"
         detach: True
         state: started

tests/nginx.yml

@@ -3,8 +3,9 @@
   remote_user: root
   roles:
     - role: ansible-role-docker_run
-      appname: nginx
-      image: nginx
-      tag: latest
-      ports: "8080:80"
-      command: ""
+      docker_run_appname: nginx
+      docker_run_image: nginx
+      docker_run_tag: latest
+      docker_run_ports: "8080:80"
+      docker_run_command: ""
+      docker_run_volumes: ""

tests/test.yml

@@ -3,8 +3,9 @@
   remote_user: root
   roles:
     - role: ansible-role-docker_run
-      appname: container
-      image: ubuntu
-      tag: latest
-      ports: "80" 
-      command: "printenv"
+      doker_run_appname: container
+      doker_run_image: ubuntu
+      doker_run_tag: latest
+      doker_run_ports: "80" 
+      doker_run_command: "printenv"
+      docker_run_volume: ""