Refactored docker logic

Makefile

@@ -1,7 +1,7 @@
 ROLES_DIR         	:= ./roles
 APPLICATIONS_OUT  	:= ./group_vars/all/03_applications.yml
 APPLICATIONS_SCRIPT := ./cli/generate-applications-defaults.py
-INCLUDES_OUT      	:= ./tasks/include-docker-roles.yml
+INCLUDES_OUT      	:= ./tasks/utils/docker-roles.yml
 INCLUDES_SCRIPT   	:= ./cli/generate_playbook.py
 
 .PHONY: build install test

docs/guides/developer/Role_Creation.md

@@ -98,8 +98,7 @@ Now that you have defined the application settings, domain, and application ID,
         domain: "{{ domains | get_domain(application_id) }}"
         http_port: "{{ ports.localhost.http[application_id] }}"
 
-    - name: "copy docker-compose.yml and env file"
+    - include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-      include_tasks: copy-docker-compose-and-env.yml
     ```
 
 3. **`docker-compose.yml.j2`**:

filter_plugins/configuration_filters.py

@@ -23,6 +23,7 @@ def get_docker_compose(path_docker_compose_instances: str, application_id: str)
         'files': {
             'env':            f"{base}.env/env",
             'docker_compose': f"{base}docker-compose.yml",
+            'dockerfile':     f"{base}Dockerfile",
         }
     }
 

playbook.yml

@@ -2,9 +2,9 @@
   hosts: all
   tasks:
   - name: "Load 'constructor' tasks"
-    include_tasks: "tasks/constructor.yml"
+    include_tasks: "tasks/plays/01_constructor.yml"
   - name: "Load '{{host_type}}' tasks"
-    include_tasks: "tasks/{{host_type}}.yml"
+    include_tasks: "tasks/plays/02_{{host_type}}.yml"
   - name: "Load 'destructor' tasks"
-    include_tasks: "tasks/destructor.yml"
+    include_tasks: "tasks/plays/03_destructor.yml"
   become: true

roles/docker-baserow/tasks/main.yml

@@ -10,5 +10,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-bluesky/tasks/main.yml

@@ -47,5 +47,4 @@
     version: "main"
   notify: docker compose project build and setup 
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-compose/tasks/create-files.yml

@@ -0,0 +1,35 @@
+- name:           "Create (optional) '{{ docker_compose.files.dockerfile }}'"
+  template:
+    src:          "{{ playbook_dir }}/roles/{{ role_name }}/templates/{{ template_name }}"
+    dest:         "{{ docker_compose.files.dockerfile }}"
+  notify:         docker compose project build and setup
+  ignore_errors:  true
+
+- name:           "Create (optional) '{{ docker_compose.files.env }}'"
+  template:
+    src:          "env.j2"
+    dest:         "{{ docker_compose.files.env }}"
+    mode:         '770'
+    force:        yes
+  notify:         docker compose project setup
+  register:       env_template
+  ignore_errors:  true
+
+- name:           "Create (obligatoric) '{{ docker_compose.files.docker_compose }}'"
+  template:
+    src:          "docker-compose.yml.j2"
+    dest:         "{{ docker_compose.files.docker_compose }}"
+  notify:         docker compose project setup
+  register:       docker_compose_template
+
+- name:           "Check if any container is running in {{ docker_compose.directories.instance }}"
+  command:        docker compose ps -q --filter status=running
+  args:
+    chdir:        "{{ docker_compose.directories.instance }}"
+  register:       docker_ps
+  changed_when:   (docker_ps.stdout | trim) == ""
+  notify:         docker compose project setup
+  when:           not (docker_compose_template.changed or env_template.changed)
+
+- name:           flush docker compose project setup
+  meta:           flush_handlers

roles/docker-coturn/tasks/main.yml

@@ -10,5 +10,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-espocrm/tasks/main.yml

@@ -14,8 +14,7 @@
     domain:               "{{ domains | get_domain(application_id) }}"
     http_port:            "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: Set OIDC scopes in EspoCRM config (inside web container)
   ansible.builtin.shell: |

roles/docker-friendica/tasks/main.yml

@@ -10,5 +10,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-funkwhale/tasks/main.yml

@@ -10,7 +10,6 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
 
 

roles/docker-fusiondirectory/tasks/main.yml

@@ -9,5 +9,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
   
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-gitea/tasks/main.yml

@@ -10,5 +10,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-gitlab/tasks/main.yml

@@ -10,5 +10,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-joomla/tasks/main.yml

@@ -13,5 +13,4 @@
   loop_control:
     loop_var: domain
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-keycloak/tasks/main.yml

@@ -10,8 +10,7 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: "create directory {{import_directory_host}}"
   file:

roles/docker-lam/tasks/main.yml

@@ -9,5 +9,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
   
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-ldap/tasks/main.yml

@@ -23,8 +23,7 @@
     ipam_config:
       - subnet: "{{ networks.local.central_ldap.subnet }}"
   
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: "create directory {{ldif_host_path}}{{item}}"
   file:

roles/docker-listmonk/tasks/main.yml

@@ -25,8 +25,7 @@
     dest: "{{docker_compose.directories.config}}config.toml"
   notify: docker compose project setup
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: Check if listmonk database is already initialized
   command: docker compose exec -T {{database_host}} psql -U {{database_username}} -d {{database_name}} -c "\dt"

roles/docker-mailu/tasks/main.yml

@@ -18,8 +18,7 @@
     name: nginx-docker-cert-deploy
   when: run_once_docker_mailu is not defined
 
-- name: "Copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
   when: run_once_docker_mailu is not defined
 
 - name: Flush docker service handlers

roles/docker-mastodon/tasks/main.yml

@@ -16,8 +16,7 @@
     client_max_body_size: "80m"
     vhost_flavour:        "ws_generic"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: flush docker service
   meta: flush_handlers

roles/docker-matomo/tasks/main.yml

@@ -12,8 +12,7 @@
     http_port:   "{{ ports.localhost.http[application_id] }}"
   when: run_once_docker_matomo is not defined
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
   when: run_once_docker_matomo is not defined
 
 - name: run the docker matomo tasks once

roles/docker-moodle/tasks/main.yml

@@ -10,14 +10,7 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "Transfer Dockerfile to {{ docker_compose.directories.instance }}"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  template:
-    src: Dockerfile.j2
-    dest: "{{ docker_compose.directories.instance }}Dockerfile"
-  notify: docker compose project build and setup
-
-- name: "copy docker-compose.yml and env file"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: "Configure OIDC login for Moodle if enabled"
   include_tasks: oidc.yml

roles/docker-nextcloud/tasks/main.yml

@@ -35,8 +35,7 @@
     dest: "{{docker_compose.directories.volumes}}nginx.conf"
   notify: restart nextcloud nginx service
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: Flush all handlers immediately so that occ can be used
   meta: flush_handlers

roles/docker-openproject/tasks/main.yml

@@ -10,23 +10,16 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "Create {{openproject_plugins_service}}"
+- name: "Create {{openproject_plugins_folder}}"
   file:
-    path: "{{openproject_plugins_service}}"
+    path: "{{openproject_plugins_folder}}"
     state: directory
     mode: '0755'
 
-- name: "Transfering Gemfile.plugins to {{openproject_plugins_service}}"
+- name: "Transfering Gemfile.plugins to {{openproject_plugins_folder}}"
   copy:
     src: Gemfile.plugins
-    dest: "{{openproject_plugins_service}}Gemfile.plugins"
+    dest: "{{openproject_plugins_folder}}Gemfile.plugins"
-  notify:
-    - docker compose project build and setup
-
-- name: "Transfering Dockerfile to {{openproject_plugins_service}}Dockerfile"
-  template:
-    src: Dockerfile
-    dest: "{{openproject_plugins_service}}Dockerfile"
   notify:
     - docker compose project build and setup
 
@@ -40,8 +33,7 @@
     state: directory
     mode: 0755
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: flush docker service
   meta: flush_handlers

roles/docker-openproject/templates/Dockerfile.j2

@@ -5,7 +5,7 @@ FROM openproject/community:{{applications.openproject.version}}
 # path inside of the container. Say for `/app/vendor/plugins/openproject-slack`:
 # COPY /path/to/my/local/openproject-slack /app/vendor/plugins/openproject-slack
 
-COPY Gemfile.plugins /app/
+COPY volumes/plugins/Gemfile.plugins /app/
 
 # If the plugin uses any external NPM dependencies you have to install them here.
 # RUN npm add npm <package-name>*

roles/docker-openproject/templates/docker-compose.yml.j2

@@ -4,7 +4,7 @@ x-op-app: &app
     driver: journald
   image: {{custom_openproject_image}}
   build:
-    context: {{openproject_plugins_service}}
+    context: .
     dockerfile: Dockerfile
 
 services:

roles/docker-openproject/vars/main.yml

@@ -2,7 +2,8 @@ application_id:               "openproject"
 docker_repository_address:    "https://github.com/opf/openproject-deploy"
 database_type:                "postgres"
 
-openproject_plugins_service:  "{{docker_compose.directories.services}}plugins/"
+openproject_plugins_folder:  "{{docker_compose.directories.volumes}}plugins/"
+
 custom_openproject_image:     "custom_openproject"
 
 # The following volume doesn't have a practcical function. It just exist to prevent the creation of unnecessary anonymous volumes

roles/docker-peertube/tasks/main.yml

@@ -11,8 +11,7 @@
   vars:
     http: "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: "Install and activate auth-openid-connect plugin if OIDC is enabled"
   include_tasks: enable-oidc.yml

roles/docker-pgadmin/tasks/main.yml

@@ -14,5 +14,4 @@
   include_tasks: configuration.yml
   when: applications[application_id].server_mode | bool
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-phpldapadmin/tasks/main.yml

@@ -9,5 +9,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
   
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-phpmyadmin/tasks/main.yml

@@ -10,5 +10,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-pixelfed/tasks/main.yml

@@ -10,5 +10,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-presentation/tasks/main.yml

@@ -26,5 +26,4 @@
     domain:     "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-roulette-wheel/tasks/main.yml

@@ -12,10 +12,4 @@
   become: true
   ignore_errors: true
 
-- name: add docker-compose.yml
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  template: src=docker-compose.yml.j2 dest={{docker_compose.directories.instance}}docker-compose.yml
-  notify: docker compose project setup
-
-- name: add Dockerfile
-  template: src=Dockerfile.j2 dest={{docker_compose.directories.instance}}Dockerfile
-  notify: docker compose project setup

roles/docker-snipe-it/tasks/main.yml

@@ -10,5 +10,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-sphinx/tasks/main.yml

@@ -22,5 +22,4 @@
     domain:     "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-syncope/tasks/main.yml

@@ -27,5 +27,4 @@
     force: yes
   notify: docker compose project setup
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-taiga/tasks/main.yml

@@ -28,5 +28,4 @@
     dest:  "{{docker_compose_init}}"
   notify: docker compose project build and setup
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

roles/docker-wordpress/tasks/main.yml

@@ -25,14 +25,7 @@
     dest: "{{ host_msmtp_conf }}"
   notify: docker compose project build and setup
 
-- name: "Transfering Dockerfile to {{ docker_compose.directories.instance }}"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  copy:
-    src: Dockerfile
-    dest: "{{ docker_compose.directories.instance }}Dockerfile"
-  notify: docker compose project build and setup
-
-- name: "copy docker-compose.yml and env file"
-  include_tasks: copy-docker-compose-and-env.yml
 
 - name: "Install wordpress"
   include_tasks: install.yml

roles/docker-wordpress/templates/Dockerfile.j2

@@ -1,4 +1,4 @@
-FROM wordpress
+FROM wordpress:{{applications[application_id].version}}
 
 # Install msmtp and update system
 RUN apt-get update && \

roles/docker-yourls/tasks/main.yml

@@ -10,5 +10,4 @@
     domain:   "{{ domains | get_domain(application_id) }}"
     http_port:   "{{ ports.localhost.http[application_id] }}"
 
-- name: "copy docker-compose.yml and env file"
+- include_tasks: "{{ playbook_dir }}/roles/docker-compose/tasks/create-files.yml"
-  include_tasks: copy-docker-compose-and-env.yml

tasks/.gitignore

@@ -1 +0,0 @@
-include-docker-roles.yml

tasks/TODO.md

@@ -1,3 +0,0 @@
-# todo
-- Move update-repository-with-files.yml to own role
-- Move copy-docker-compose-and-env.yml to own role

tasks/copy-docker-compose-and-env.yml

@@ -1,27 +0,0 @@
-- name: "create {{ docker_compose.files.docker_compose }}"
-  template:
-    src: "docker-compose.yml.j2"
-    dest: "{{ docker_compose.files.docker_compose }}"
-  notify: docker compose project setup
-  register: docker_compose_template
-
-- name: "create {{ docker_compose.files.env }}"
-  template:
-    src: "env.j2"
-    dest: "{{ docker_compose.files.env }}"
-    mode: '770'
-    force: yes
-  notify: docker compose project setup
-  register: env_template
-
-- name: "Check if any container is running in {{ docker_compose.directories.instance }}"
-  command: docker compose ps -q --filter status=running
-  args:
-    chdir: "{{ docker_compose.directories.instance }}"
-  register: docker_ps
-  changed_when: (docker_ps.stdout | trim) == ""
-  notify: docker compose project setup
-  when: not (docker_compose_template.changed or env_template.changed)
-
-- name: flush docker compose project setup
-  meta: flush_handlers

tasks/plays/02_server.yml

@@ -12,7 +12,7 @@
     - system-btrfs-auto-balancer
 
 - name: "Integrate Docker Role includes"
-  include_tasks: "include-docker-roles.yml"
+  include_tasks: "./tasks/utils/docker-roles.yml"
 
 # Native Webserver Roles
 - name: setup nginx-serve-htmls

tasks/utils/.gitignore

@@ -0,0 +1 @@
+docker-roles.yml