Update to 2021-11-26 13:00

roles/etherpad/defaults/main.yml

@@ -1,27 +1,44 @@
 ---
 
+# You can install several instances of etherpad on the same server
+# They should each get their own ID and port
 etherpad_id: 1
+# Where etherpad will be installed
 etherpad_root_dir: /opt/etherpad_{{ etherpad_id }}
+# Unix account under which etherpad will run. The user will be created if it doesn't exist
 etherpad_user: etherpad_{{ etherpad_id }}
+# Version to deploy
 etherpad_version: 1.8.15
+# URL from where the archive will be downloaded
 etherpad_archive_url: https://github.com/ether/etherpad-lite/archive/{{ etherpad_version }}.tar.gz
+# Expected sha1 of the archive, to check the download were OK
 etherpad_archive_sha1: c7995d0418c919d97e62c941e70fb20940ce7b35
+# Port on which the service will listen
 etherpad_port: 9003
+# List of IP/CIDR for which the port will be opened (if iptables_manage == True)
 etherpad_src_ip: []
 
+# Etherpad uses a MySQL compatible database
 etherpad_db_name: etherpad_{{ etherpad_id }}
 etherpad_db_user: etherpad_{{ etherpad_id }}
 etherpad_db_port: 3306
 etherpad_db_server: "{{mysql_server | default('localhost') }}"
-# A random one is generated if not defined
+# A random one is generated if not defined, and stored under {{ etherpad_root_dir }}/meta/ansible_dbpass
 # etherpad_db_pass: s3cr3t.
 
+# Page title
 etherpad_title: Etherpad
+# Default theme
 etherpad_theme: colibris
-# A random one will be created if not defined
-#etherpad_admin_pass: p@ssw0rd
-#etherpad_api_key: 123456
 
+# Admin password
+# A random one will be created if not defined, and stored under {{ etherpad_root_dir }}/meta/ansible_admin_pass
+# etherpad_admin_pass: p@ssw0rd
+# The API Key
+# A random one will be created if not defined, and stored under {{ etherpad_root_dir }}/meta/ansible_api_key
+# etherpad_api_key: 123456
+
+# List of plugins to install
 etherpad_plugins_base:
   - adminpads
   - delete_after_delay

roles/phpmyadmin/defaults/main.yml

@@ -1,42 +1,72 @@
 ---
 
+# Version to deploy
 pma_version: 5.1.1
+# ID of the instance. Several instances can be installed on the same server
+# they must have different ID
 pma_id: "1"
+# URL from where the archive will be downloaded
 pma_archive_url: https://files.phpmyadmin.net/phpMyAdmin/{{ pma_version }}/phpMyAdmin-{{ pma_version }}-all-languages.zip
+# Expected sha256 of the archive, to verify the download
 pma_archive_sha256: 78a5d93621f9fdfc221a530705025dc79c1abc7a4d6a940a9d0a9a3719d0554c
+# Should ansible handle upgrades. If False, then only the initial install will be done
 pma_manage_upgrade: True
+# Where phpMyAdmin will be installed
 pma_root_dir: /opt/phpmyadmin_{{ pma_id }}
+# phpMyAdmn uses a DB to store queries. Here are the param for this DB
+# MySQL DB user
 pma_db_user: pma_{{ pma_id }}
+# MySQL DB name
 pma_db_name: pma_{{ pma_id }}
+# MySQL DB server
 pma_db_server: "{{ mysql_server | default('localhost') }}"
-# If Not defined, a random one will be created
+# MySQL db password
+# If Not defined, a random one will be created and stored under {{ pma_root_dir }}/meta/ansible_dbpass
 # pma_db_pass: 
 
-# If defined, will use this specific FPM pool, which must exist
+# If defined, will use this specific FPM pool, which must exist.
+# Else, a PHP pool will be configured
 # pma_php_fpm_pool: pma
+# PHP version to use for the PHP pool
 pma_php_version: 80
+# Unix account under which the PHP pool will run. The user will be created
 pma_php_user: php-pma_{{ pma_id }}
+
+# Env vars which contain the login of the current user
+# This can be used for example with Lemonldap::NG protecting phpMyAdmin
 pma_sso_user_fields:
   - REMOTE_USER
   - REDIRECT_REMOTE_USER
+# Same for the groups the user is member of
 pma_sso_groups_fields: []
 # pma_sso_groups_fields
 #   - HTTP_USER_GROUPS
+
+# Optional list of IP/CIDR having access to phpMyAdmin
 # pma_src_ip:
 #   - 127.0.0.1
+
+# If defined, an alias (eg /phpmyadmin) will be created
+# If not defined, you'll have to create a vhost pointing at {{ pma_root_dir }}/web
+# for phpMyAdmin to be reachable
 # pma_alias: phpmyadmin
+
+# List of database servers
 pma_servers: []
 # pma_servers:
 #   - host: localhost
 #     port: 3306
 #     socket: /var/lib/mysql/mysql.sock
 #     auth_type: signon
+
+# Dict of phpMyAdmin users and their corresponding MySQL credentials
 pma_sso_users: []
 # pma_sso_users:
 #   - user: dani
 #     sql_login: admin
 #     sql_password: p@ssw0rd
 
+# Same for groups
 pma_sso_groups: []
 # pma_sso_groups:
 #   - group: DB_Admins

roles/phpmyadmin/tasks/archive_post.yml

@@ -0,0 +1,8 @@
+---
+
+- import_tasks: ../includes/webapps_compress_archive.yml
+  vars:
+    - root_dir: "{{ pma_root_dir }}"
+    - version: "{{ pma_current_version }}"
+  tags: pma
+

roles/phpmyadmin/tasks/archive_pre.yml

@@ -0,0 +1,8 @@
+---
+
+- import_tasks: ../includes/webapps_archive.yml
+  vars:
+    - root_dir: "{{ pma_root_dir }}"
+    - version: "{{ pma_current_version }}"
+    - db_name: "{{ pma_db_name }}"
+  tags: pma

roles/phpmyadmin/tasks/cleanup.yml

@@ -0,0 +1,9 @@
+---
+
+- name: Remove temp files
+  file: path={{ item }} state=absent
+  with_items:
+    - "{{ pma_root_dir }}/tmp/phpMyAdmin-{{ pma_version }}-all-languages.zip"
+    - "{{ pma_root_dir }}/tmp/phpMyAdmin-{{ pma_version }}-all-languages"
+  tags: pma
+

roles/phpmyadmin/tasks/conf.yml

@@ -0,0 +1,17 @@
+---
+
+- import_tasks: ../includes/webapps_webconf.yml
+  vars:
+    - app_id: pma_{{ pma_id }}
+    - php_version: "{{ pma_php_version }}"
+    - php_fpm_pool: "{{ pma_php_fpm_pool | default('') }}"
+  tags: pma
+
+- name: Deploy sso scripts
+  template: src=sso.php.j2 dest={{ pma_root_dir }}/web/sso.php group={{ pma_php_user }} mode=640
+  tags: pma
+
+- name: Deploy phpMyAdmin config
+  template: src=config.inc.php.j2 dest={{ pma_root_dir }}/web/config.inc.php group={{ pma_php_user }} mode=640
+  tags: pma
+

roles/phpmyadmin/tasks/directories.yml

@@ -0,0 +1,14 @@
+---
+
+- name: Create directory structure
+  file: path={{ item.dir }} state=directory mode={{ item.mode | default(omit) }}
+  loop:
+    - dir: "{{ pma_root_dir }}"
+    - dir: "{{ pma_root_dir }}/web"
+    - dir: "{{ pma_root_dir }}/tmp"
+    - dir: "{{ pma_root_dir }}/sessions"
+    - dir: "{{ pma_root_dir }}/cache"
+    - dir: "{{ pma_root_dir }}/meta"
+      mode: 700
+    - dir: "{{ pma_root_dir }}/data"
+  tags: pma

roles/phpmyadmin/tasks/facts.yml

@@ -0,0 +1,37 @@
+---
+
+# Load distribution specific variables
+- include_vars: "{{ item }}"
+  with_first_found:
+    - vars/{{ ansible_distribution }}-{{ ansible_distribution_major_version }}.yml
+    - vars/{{ ansible_os_family }}-{{ ansible_distribution_major_version }}.yml
+    - vars/{{ ansible_distribution }}.yml
+    - vars/{{ ansible_os_family }}.yml
+  tags: pma
+
+# Detect current version (if any) and set install_mode (to none, upgrade or install)
+- block:
+    - import_tasks: ../includes/webapps_set_install_mode.yml
+      vars:
+        - root_dir: "{{ pma_root_dir }}"
+        - version: "{{ pma_version }}"
+    - set_fact: pma_install_mode={{ (install_mode == 'upgrade' and not pma_manage_upgrade) | ternary('none',install_mode) }}
+    - set_fact: pma_current_version={{ current_version | default('') }}
+  tags: pma
+
+# Generate a random key for cookie signing
+- block:
+    - import_tasks: ../includes/get_rand_pass.yml
+      vars:
+        - pass_file: "{{ pma_root_dir }}/meta/key.txt"
+    - set_fact: pma_key={{ rand_pass }}
+  tags: pma
+
+# Generate a DB password if not defined
+- when: pma_db_pass is not defined
+  block:
+    - import_tasks: ../includes/get_rand_pass.yml
+      vars:
+        - pass_file: "{{pma_root_dir }}/meta/ansible_dbpass"
+    - set_fact: pma_db_pass={{ rand_pass }}
+  tags: pma

roles/phpmyadmin/tasks/install.yml

@@ -0,0 +1,54 @@
+---
+
+- name: Install dependencies
+  yum: name={{ pma_packages }}
+  tags: pma
+
+- when:  pma_install_mode != 'none'
+  block:
+
+    - name: Download phpMyAdmin
+      get_url:
+        url: "{{ pma_archive_url }}"
+        dest: "{{ pma_root_dir }}/tmp/"
+        checksum: "sha256:{{ pma_archive_sha256 }}"
+    
+    - name: Extract pma archive
+      unarchive:
+        src: "{{ pma_root_dir }}/tmp/phpMyAdmin-{{ pma_version }}-all-languages.zip"
+        dest: "{{ pma_root_dir }}/tmp"
+        remote_src: yes
+    
+    - name: Move files to the correct directory
+      synchronize:
+        src: "{{ pma_root_dir }}/tmp/phpMyAdmin-{{ pma_version }}-all-languages/"
+        dest: "{{ pma_root_dir }}/web/"
+        compress: False
+        delete: True
+      delegate_to: "{{ inventory_hostname }}"
+
+  tags: pma
+
+- import_tasks: ../includes/webapps_create_mysql_db.yml
+  vars:
+    - db_name: "{{ pma_db_name }}"
+    - db_user: "{{ pma_db_user }}"
+    - db_server: "{{ pma_db_server }}"
+    - db_pass: "{{ pma_db_pass }}"
+  tags: pma
+
+- name: Prepare SQL file to create tables
+  replace: path={{ pma_root_dir }}/web/sql/create_tables.sql regexp='phpmyadmin' replace={{ pma_db_name }}
+  tags: pma
+
+- name: Create tables
+  mysql_db:
+    name: "{{ pma_db_name }}"
+    state: import
+    target: "{{ pma_root_dir }}/web/sql/create_tables.sql"
+    login_host: "{{ pma_db_server }}"
+    login_user: sqladmin
+    login_password: "{{ mysql_admin_pass }}"
+  when: db_created.changed
+  tags: pma
+

roles/phpmyadmin/tasks/main.yml

@@ -1,149 +1,14 @@
 ---
 
-- include_vars: "{{ item }}"
-  with_first_found:
-    - vars/{{ ansible_distribution }}-{{ ansible_distribution_major_version }}.yml
-    - vars/{{ ansible_os_family }}-{{ ansible_distribution_major_version }}.yml
-    - vars/{{ ansible_distribution }}.yml
-    - vars/{{ ansible_os_family }}.yml
-  tags: pma
-
-- name: Install dependencies
-  yum: name={{ pma_packages }}
-  tags: pma
-
-- import_tasks: ../includes/create_system_user.yml
-  vars:
-    - user: "{{ pma_php_user }}"
-    - comment: "PHP FPM for pma {{ pma_id }}"
-  tags: pma
-
-- block:
-    - import_tasks: ../includes/webapps_set_install_mode.yml
-      vars:
-        - root_dir: "{{ pma_root_dir }}"
-        - version: "{{ pma_version }}"
-    - set_fact: pma_install_mode={{ (install_mode == 'upgrade' and not pma_manage_upgrade) | ternary('none',install_mode) }}
-    - set_fact: pma_current_version={{ current_version | default('') }}
-  tags: pma
-
-- import_tasks: ../includes/webapps_archive.yml
-  vars:
-    - root_dir: "{{ pma_root_dir }}"
-    - version: "{{ pma_current_version }}"
-    - db_name: "{{ pma_db_name }}"
+- include: user.yml
+- include: directories.yml
+- include: facts.yml
+- include: archive_pre.yml
   when: pma_install_mode == 'upgrade'
-  tags: pma
-
-- name: Create directory structure
-  file: path={{ item }} state=directory
-  with_items:
-    - "{{ pma_root_dir }}"
-    - "{{ pma_root_dir }}/web"
-    - "{{ pma_root_dir }}/tmp"
-    - "{{ pma_root_dir }}/sessions"
-    - "{{ pma_root_dir }}/cache"
-    - "{{ pma_root_dir }}/meta"
-    - "{{ pma_root_dir }}/data"
-  tags: pma
-
-- name: Download phpMyAdmin
-  get_url:
-    url: "{{ pma_archive_url }}"
-    dest: "{{ pma_root_dir }}/tmp/"
-    checksum: "sha256:{{ pma_archive_sha256 }}"
-  when: pma_install_mode != 'none'
-  tags: pma
-
-- name: Extract pma archive
-  unarchive:
-    src: "{{ pma_root_dir }}/tmp/phpMyAdmin-{{ pma_version }}-all-languages.zip"
-    dest: "{{ pma_root_dir }}/tmp"
-    remote_src: yes
-  when: pma_install_mode != 'none'
-  tags: pma
-
-- name: Move files to the correct directory
-  synchronize:
-    src: "{{ pma_root_dir }}/tmp/phpMyAdmin-{{ pma_version }}-all-languages/"
-    dest: "{{ pma_root_dir }}/web/"
-    compress: False
-    delete: True
-  delegate_to: "{{ inventory_hostname }}"
-  when: pma_install_mode != 'none'
-  tags: pma
-
-- name: Remove temp files
-  file: path={{ item }} state=absent
-  with_items:
-    - "{{ pma_root_dir }}/tmp/phpMyAdmin-{{ pma_version }}-all-languages.zip"
-    - "{{ pma_root_dir }}/tmp/phpMyAdmin-{{ pma_version }}-all-languages"
-  tags: pma
-
-- import_tasks: ../includes/get_rand_pass.yml
-  vars:
-    - pass_file: "{{ pma_root_dir }}/meta/key.txt"
-  tags: pma
-- set_fact: pma_key={{ rand_pass }}
-  tags: pma
-
-- import_tasks: ../includes/get_rand_pass.yml
-  vars:
-    - pass_file: "{{pma_root_dir }}/meta/ansible_dbpass"
-  when: pma_db_pass is not defined
-  tags: pma
-- set_fact: pma_db_pass={{ rand_pass }}
-  when: pma_db_pass is not defined
-  tags: pma
-
-- import_tasks: ../includes/webapps_create_mysql_db.yml
-  vars:
-    - db_name: "{{ pma_db_name }}"
-    - db_user: "{{ pma_db_user }}"
-    - db_server: "{{ pma_db_server }}"
-    - db_pass: "{{ pma_db_pass }}"
-  tags: pma
-
-- name: Prepare SQL file to create tables
-  replace: path={{ pma_root_dir }}/web/sql/create_tables.sql regexp='phpmyadmin' replace={{ pma_db_name }}
-  tags: pma
-
-- name: Create tables
-  mysql_db:
-    name: "{{ pma_db_name }}"
-    state: import
-    target: "{{ pma_root_dir }}/web/sql/create_tables.sql"
-    login_host: "{{ pma_db_server }}"
-    login_user: sqladmin
-    login_password: "{{ mysql_admin_pass }}"
-  when: db_created.changed
-  tags: pma
-
-- import_tasks: ../includes/webapps_webconf.yml
-  vars:
-    - app_id: pma_{{ pma_id }}
-    - php_version: "{{ pma_php_version }}"
-    - php_fpm_pool: "{{ pma_php_fpm_pool | default('') }}"
-  tags: pma
-
-- name: Deploy sso scripts
-  template: src=sso.php.j2 dest={{ pma_root_dir }}/web/sso.php group={{ pma_php_user }} mode=640
-  tags: pma
-
-- name: Deploy phpMyAdmin config
-  template: src=config.inc.php.j2 dest={{ pma_root_dir }}/web/config.inc.php group={{ pma_php_user }} mode=640
-  tags: pma
-
-- import_tasks: ../includes/webapps_compress_archive.yml
-  vars:
-    - root_dir: "{{ pma_root_dir }}"
-    - version: "{{ pma_current_version }}"
+- include: install.yml
+- include: conf.yml
+- include: archive_post.yml
   when: pma_install_mode == 'upgrade'
-  tags: pma
-
-- import_tasks: ../includes/webapps_post.yml
-  vars:
-    - root_dir: "{{ pma_root_dir }}"
-    - version: "{{ pma_version }}"
-  tags: pma
+- include: cleanup.yml
+- include: write_version.yml
 

roles/phpmyadmin/tasks/user.yml

@@ -0,0 +1,8 @@
+---
+
+- import_tasks: ../includes/create_system_user.yml
+  vars:
+    - user: "{{ pma_php_user }}"
+    - comment: "PHP FPM for pma {{ pma_id }}"
+  tags: pma
+

roles/phpmyadmin/tasks/write_version.yml

@@ -0,0 +1,7 @@
+---
+
+- import_tasks: ../includes/webapps_post.yml
+  vars:
+    - root_dir: "{{ pma_root_dir }}"
+    - version: "{{ pma_version }}"
+  tags: pma