Move roles/matrix* to roles/custom/matrix*
This paves the way for installing other roles into `roles/galaxy` using `ansible-galaxy`, similar to how it's done in: - https://github.com/spantaleev/gitea-docker-ansible-deploy - https://github.com/spantaleev/nextcloud-docker-ansible-deploy In the near future, we'll be removing a lot of the shared role code from here and using upstream roles for it. Some of the core `matrix-*` roles have already been extracted out into other reusable roles: - https://github.com/devture/com.devture.ansible.role.postgres - https://github.com/devture/com.devture.ansible.role.systemd_docker_base - https://github.com/devture/com.devture.ansible.role.timesync - https://github.com/devture/com.devture.ansible.role.vars_preserver - https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages - https://github.com/devture/com.devture.ansible.role.playbook_help We just need to migrate to those.
This commit is contained in:
Slavi Pantaleev
68
roles/custom/matrix-cactus-comments/tasks/init.yml
Normal file
68
roles/custom/matrix-cactus-comments/tasks/init.yml
Normal file
@ -0,0 +1,68 @@
|
||||
---
|
||||
|
||||
- ansible.builtin.set_fact:
|
||||
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-cactus-comments.service'] }}"
|
||||
when: matrix_cactus_comments_enabled | bool
|
||||
|
||||
# If the matrix-synapse role is not used, these variables may not exist.
|
||||
- ansible.builtin.set_fact:
|
||||
matrix_homeserver_container_runtime_injected_arguments: >
|
||||
{{
|
||||
matrix_homeserver_container_runtime_injected_arguments | default([])
|
||||
+
|
||||
["--mount type=bind,src={{ matrix_cactus_comments_app_service_config_file }},dst=/matrix-cactus-comments.yaml,ro"]
|
||||
}}
|
||||
|
||||
matrix_homeserver_app_service_runtime_injected_config_files: >
|
||||
{{
|
||||
matrix_homeserver_app_service_runtime_injected_config_files | default([])
|
||||
+
|
||||
["/matrix-cactus-comments.yaml"]
|
||||
}}
|
||||
when: matrix_cactus_comments_enabled | bool
|
||||
|
||||
- when: matrix_cactus_comments_enabled | bool and matrix_cactus_comments_serve_client_enabled | bool
|
||||
tags:
|
||||
- always
|
||||
block:
|
||||
- name: Fail if matrix-nginx-proxy role already executed
|
||||
ansible.builtin.fail:
|
||||
msg: >-
|
||||
Trying to append Cactus Comment's reverse-proxying configuration to matrix-nginx-proxy,
|
||||
but it's pointless since the matrix-nginx-proxy role had already executed.
|
||||
To fix this, please change the order of roles in your playbook,
|
||||
so that the matrix-nginx-proxy role would run after the matrix-cactus-comments role.
|
||||
when: matrix_nginx_proxy_role_executed | default(False) | bool
|
||||
|
||||
- name: Mount volume
|
||||
ansible.builtin.set_fact:
|
||||
matrix_nginx_proxy_container_additional_volumes: >
|
||||
{{
|
||||
matrix_nginx_proxy_container_additional_volumes | default([])
|
||||
+
|
||||
[{"src": "{{ matrix_cactus_comments_client_path }}", "dst": "/cactus-comments/cactus-comments", "options": "ro"}]
|
||||
}}
|
||||
|
||||
- name: Generate Cactus Comment proxying configuration for matrix-nginx-proxy
|
||||
ansible.builtin.set_fact:
|
||||
matrix_cactus_comments_nginx_proxy_configuration: |
|
||||
location {{ matrix_cactus_comments_client_endpoint }} {
|
||||
root {{ matrix_cactus_comments_client_nginx_path }};
|
||||
}
|
||||
|
||||
- name: Register Cactus Comment proxying configuration with matrix-nginx-proxy
|
||||
ansible.builtin.set_fact:
|
||||
matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks: |
|
||||
{{
|
||||
matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks | default([])
|
||||
+
|
||||
[matrix_cactus_comments_nginx_proxy_configuration]
|
||||
}}
|
||||
|
||||
- name: Warn about reverse-proxying if matrix-nginx-proxy not used
|
||||
ansible.builtin.debug:
|
||||
msg: >-
|
||||
NOTE: You've enabled Cactus Comments but are not using the matrix-nginx-proxy
|
||||
reverse proxy.
|
||||
Please make sure that you're proxying client files in {{ matrix_cactus_comments_client_path }} correctly
|
||||
when: "not matrix_nginx_proxy_enabled | default(False) | bool"
|
||||
23
roles/custom/matrix-cactus-comments/tasks/main.yml
Normal file
23
roles/custom/matrix-cactus-comments/tasks/main.yml
Normal file
@ -0,0 +1,23 @@
|
||||
---
|
||||
|
||||
- ansible.builtin.import_tasks: "{{ role_path }}/tasks/init.yml"
|
||||
tags:
|
||||
- always
|
||||
|
||||
- ansible.builtin.import_tasks: "{{ role_path }}/tasks/validate_config.yml"
|
||||
when: "run_setup | bool and matrix_cactus_comments_enabled | bool"
|
||||
tags:
|
||||
- setup-all
|
||||
- setup-cactus-comments
|
||||
|
||||
- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_install.yml"
|
||||
when: "run_setup | bool and matrix_cactus_comments_enabled | bool"
|
||||
tags:
|
||||
- setup-all
|
||||
- setup-cactus-comments
|
||||
|
||||
- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
|
||||
when: "run_setup | bool and not matrix_cactus_comments_enabled | bool"
|
||||
tags:
|
||||
- setup-all
|
||||
- setup-cactus-comments
|
||||
138
roles/custom/matrix-cactus-comments/tasks/setup_install.yml
Normal file
138
roles/custom/matrix-cactus-comments/tasks/setup_install.yml
Normal file
@ -0,0 +1,138 @@
|
||||
---
|
||||
|
||||
- name: Ensure cactus comments paths exist
|
||||
ansible.builtin.file:
|
||||
path: "{{ item.path }}"
|
||||
state: directory
|
||||
mode: 0750
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
with_items:
|
||||
- {path: "{{ matrix_cactus_comments_base_path }}", when: true}
|
||||
- {path: "{{ matrix_cactus_comments_client_path }}", when: true}
|
||||
- {path: "{{ matrix_cactus_comments_container_tmp_path }}", when: true}
|
||||
- {path: "{{ matrix_cactus_comments_docker_src_files_path }}", when: matrix_cactus_comments_container_image_self_build}
|
||||
when: "item.when | bool"
|
||||
|
||||
- name: Ensure cactus comments environment file created
|
||||
ansible.builtin.template:
|
||||
src: "{{ role_path }}/templates/env.j2"
|
||||
dest: "{{ matrix_cactus_comments_app_service_env_file }}"
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
mode: 0640
|
||||
|
||||
- name: Ensure cactus comments appservice file created
|
||||
ansible.builtin.template:
|
||||
src: "{{ role_path }}/templates/cactus_appservice.yaml.j2"
|
||||
dest: "{{ matrix_cactus_comments_app_service_config_file }}"
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
mode: 0640
|
||||
|
||||
- name: Ensure cactus comments image is pulled
|
||||
community.docker.docker_image:
|
||||
name: "{{ matrix_cactus_comments_docker_image }}"
|
||||
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
||||
force_source: "{{ matrix_cactus_comments_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
|
||||
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_cactus_comments_docker_image_force_pull }}"
|
||||
when: "not matrix_cactus_comments_container_image_self_build | bool"
|
||||
register: result
|
||||
retries: "{{ matrix_container_retries_count }}"
|
||||
delay: "{{ matrix_container_retries_delay }}"
|
||||
until: result is not failed
|
||||
|
||||
- name: Ensure cactus comments repository is present on self-build
|
||||
ansible.builtin.git:
|
||||
repo: "{{ matrix_cactus_comments_docker_repo }}"
|
||||
version: "{{ matrix_cactus_comments_docker_repo_version }}"
|
||||
dest: "{{ matrix_cactus_comments_docker_src_files_path }}"
|
||||
force: "yes"
|
||||
become: true
|
||||
become_user: "{{ matrix_user_username }}"
|
||||
register: matrix_cactus_comments_git_pull_results
|
||||
when: "matrix_cactus_comments_container_image_self_build | bool"
|
||||
|
||||
- name: Ensure cactus comments image is built
|
||||
community.docker.docker_image:
|
||||
name: "{{ matrix_cactus_comments_docker_image }}"
|
||||
source: build
|
||||
force_source: "{{ matrix_cactus_comments_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
|
||||
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mailer_git_pull_results.changed }}"
|
||||
build:
|
||||
dockerfile: Dockerfile
|
||||
path: "{{ matrix_cactus_comments_docker_src_files_path }}"
|
||||
pull: true
|
||||
when: "matrix_cactus_comments_container_image_self_build | bool"
|
||||
|
||||
- when: matrix_cactus_comments_client_local_dir | length == 0
|
||||
block:
|
||||
- name: Download client binary to local folder
|
||||
ansible.builtin.get_url:
|
||||
url: "https://gitlab.com/cactus-comments/cactus-client/-/archive/v{{ matrix_cactus_comments_client_version }}/cactus-client-v{{ matrix_cactus_comments_client_version }}.tar.gz"
|
||||
dest: "/tmp/cactus-comments-{{ matrix_cactus_comments_client_version }}.tar.gz"
|
||||
mode: '0644'
|
||||
register: _download_client
|
||||
until: _download_client is succeeded
|
||||
retries: 5
|
||||
delay: 2
|
||||
check_mode: false
|
||||
|
||||
- name: Unpack client
|
||||
ansible.builtin.unarchive:
|
||||
src: "/tmp/cactus-comments-{{ matrix_cactus_comments_client_version }}.tar.gz"
|
||||
dest: "/tmp/"
|
||||
remote_src: true
|
||||
mode: 0600
|
||||
check_mode: false
|
||||
|
||||
- name: Propagate client javascript file
|
||||
ansible.builtin.copy:
|
||||
src: "/tmp/cactus-client-v{{ matrix_cactus_comments_client_version }}/src/cactus.js"
|
||||
remote_src: true
|
||||
dest: "{{ matrix_cactus_comments_client_path }}/cactus.js"
|
||||
mode: "{{ matrix_cactus_comments_client_file_permissions }}"
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
- name: Propagate client style file
|
||||
ansible.builtin.copy:
|
||||
src: "/tmp/cactus-client-v{{ matrix_cactus_comments_client_version }}/src/style.css"
|
||||
remote_src: true
|
||||
dest: "{{ matrix_cactus_comments_client_path }}/style.css"
|
||||
mode: "{{ matrix_cactus_comments_client_file_permissions }}"
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
|
||||
- when: matrix_cactus_comments_client_local_dir | length > 0
|
||||
block:
|
||||
- name: Propagate locally distributed client javascreipt
|
||||
ansible.builtin.copy:
|
||||
src: "{{ matrix_cactus_comments_client_local_dir }}/src/cactus.js"
|
||||
dest: "{{ matrix_cactus_comments_client_path }}/cactus.js"
|
||||
mode: "{{ matrix_cactus_comments_client_file_permissions }}"
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
- name: Propagate locally distributed client style.css
|
||||
ansible.builtin.copy:
|
||||
src: "{{ matrix_cactus_comments_client_local_dir }}/src/style.css"
|
||||
dest: "{{ matrix_cactus_comments_client_path }}/style.css"
|
||||
mode: "{{ matrix_cactus_comments_client_file_permissions }}"
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
|
||||
- name: Ensure matrix-cactus-comments.service installed
|
||||
ansible.builtin.template:
|
||||
src: "{{ role_path }}/templates/systemd/matrix-cactus-comments.service.j2"
|
||||
dest: "{{ matrix_systemd_path }}/matrix-cactus-comments.service"
|
||||
mode: 0644
|
||||
register: matrix_cactus_comments_systemd_service_result
|
||||
|
||||
- name: Ensure systemd reloaded after matrix-cactus-comments.service installation
|
||||
ansible.builtin.service:
|
||||
daemon_reload: true
|
||||
when: "matrix_cactus_comments_systemd_service_result.changed | bool"
|
||||
|
||||
- name: Ensure matrix-cactus-comments.service restarted, if necessary
|
||||
ansible.builtin.service:
|
||||
name: "matrix-cactus-comments.service"
|
||||
state: restarted
|
||||
@ -0,0 +1,36 @@
|
||||
---
|
||||
|
||||
- name: Check existence of matrix-cactus-comments service
|
||||
ansible.builtin.stat:
|
||||
path: "{{ matrix_systemd_path }}/matrix-cactus-comments.service"
|
||||
register: matrix_cactus_comments_service_stat
|
||||
|
||||
- name: Ensure cactus comments is stopped
|
||||
ansible.builtin.service:
|
||||
name: matrix-cactus-comments
|
||||
state: stopped
|
||||
enabled: false
|
||||
daemon_reload: true
|
||||
register: stopping_result
|
||||
when: "matrix_cactus_comments_service_stat.stat.exists | bool"
|
||||
|
||||
- name: Ensure matrix-cactus-comments.service doesn't exist
|
||||
ansible.builtin.file:
|
||||
path: "{{ matrix_systemd_path }}/matrix-cactus-comments.service"
|
||||
state: absent
|
||||
when: "matrix_cactus_comments_service_stat.stat.exists | bool"
|
||||
|
||||
- name: Ensure systemd reloaded after matrix-cactus-comments.service removal
|
||||
ansible.builtin.service:
|
||||
daemon_reload: true
|
||||
when: "matrix_cactus_comments_service_stat.stat.exists | bool"
|
||||
|
||||
- name: Ensure Matrix cactus comments paths don't exist
|
||||
ansible.builtin.file:
|
||||
path: "{{ matrix_cactus_comments_base_path }}"
|
||||
state: absent
|
||||
|
||||
- name: Ensure cactus comments Docker image doesn't exist
|
||||
community.docker.docker_image:
|
||||
name: "{{ matrix_cactus_comments_docker_image }}"
|
||||
state: absent
|
||||
@ -0,0 +1,10 @@
|
||||
---
|
||||
|
||||
- name: Fail if required settings not defined
|
||||
ansible.builtin.fail:
|
||||
msg: >-
|
||||
You need to define a required configuration setting (`{{ item }}`).
|
||||
when: "vars[item] == ''"
|
||||
with_items:
|
||||
- "matrix_cactus_comments_as_token"
|
||||
- "matrix_cactus_comments_hs_token"
|
||||
Reference in New Issue
Block a user