feat(hedgedoc): add deployment_method=podman, add docs

galaxy.yml

@@ -1,6 +1,6 @@
 namespace: finallycoffee
 name: services
-version: 0.1.3
+version: 0.1.4
 readme: README.md
 authors:
 - transcaffeine <transcaffeine@finally.coffee>

roles/hedgedoc/README.md

@@ -0,0 +1,21 @@
+# `finallycoffee.services.hedgedoc` ansible role
+
+Role to deploy and configure hedgedoc using `docker` or `podman`.
+To configure hedgedoc, set either the config as complex data
+directly in `hedgedoc_config` or use the flattened variables
+from the `hedgedoc_config_*` prefix (see
+[defaults/main/config.yml](defaults/main/config.yml)).
+
+To remove hedgedoc, set `hedgedoc_state: absent`. Note that this
+will delete all data directories aswell, removing any traces this
+role created on the target (except database contents).
+
+# Required configuration
+
+- `hedgedoc_config_domain` - Domain of the hedgedoc instance
+- `hedgedoc_config_session_secret` - session secret for hedgedoc
+
+## Deployment methods
+
+To set the desired deployment method, set `hedgedoc_deployment_method` to a
+supported deployment methods (see [vars/main.yml](vars/main.yml#5)).

roles/hedgedoc/defaults/main/container.yml

@@ -48,7 +48,10 @@ hedgedoc_container_all_volumes: >-2
 hedgedoc_container_base_labels:
   version: "{{ hedgedoc_container_tag | default(hedgedoc_version, true) }}"
 hedgedoc_container_labels: ~
+hedgedoc_container_network_mode: ~
 hedgedoc_container_all_labels: >-2
   {{ hedgedoc_container_base_labels | default({}, true)
     | combine(hedgedoc_container_labels | default({}, true)) }}
-hedgedoc_container_restart_policy: "unless-stopped"
+hedgedoc_container_restart_policy: >-2
+  {{ (hedgedoc_deployment_method === 'docker')
+      | ternary('unless-stopped', 'on-failure') }}

roles/hedgedoc/defaults/main/user.yml

@@ -1,5 +1,5 @@
 ---
 hedgedoc_run_user_id: >-2
-  {{ hedgedoc_user_info.uid | default(hedgedoc_user }}
+  {{ hedgedoc_user_info.uid | default(hedgedoc_user) }}
 hedgedoc_run_group_id: >-2
-  {{ hedgedoc_user_info.group | default(hedgedoc_user }}
+  {{ hedgedoc_user_info.group | default(hedgedoc_user) }}

roles/hedgedoc/tasks/deploy-docker.yml

@@ -17,8 +17,15 @@
     name: "{{ hedgedoc_container_name }}"
     image: "{{ hedgedoc_container_image }}"
     env: "{{ hedgedoc_container_env | default(omit, true) }}"
+    user: "{{ hedgedoc_container_user | default(omit, true) }}"
+    ports: "{{ hedgedoc_container_ports | default(omit, true) }}"
     labels: "{{ hedgedoc_container_all_labels }}"
     volumes: "{{ hedgedoc_container_all_volumes }}"
     etc_hosts: "{{ hedgedoc_container_etc_hosts | default(omit, true) }}"
-    restart_policy: "{{ hedgedoc_container_restart_policy | default(omit, true) }}"
+    dns_servers: >-2
+      {{ hedgedoc_container_dns_servers | default(omit, true) }}
+    network_mode: >-2
+      {{ hedgedoc_container_network_mode | default(omit, true) }}
+    restart_policy: >-2
+      {{ hedgedoc_container_restart_policy | default(omit, true) }}
     state: "{{ hedgedoc_container_state }}"

roles/hedgedoc/vars/main.yml

@@ -4,6 +4,7 @@ hedgedoc_states:
   - absent
 hedgedoc_deployment_methods:
   - docker
+  - podman
 
 hedgedoc_required_arguments:
   - hedgedoc_config_domain