IM/ansible_fencl
3
0
Fork 0
forked from jakub/ansible
Code Pull Requests Activity

Refactor update_collabora.yml: enhance Collabora configuration with robust detection and improved command execution

Browse Source
This commit is contained in:
fencl
2025-10-05 09:26:01 +02:00
parent b7f6d38a32
commit abc7fba684
1 changed files with 159 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

203
nextcloud/update_collabora.yml
View File

@@ -31,9 +31,14 @@
# Flip to true if Docker needs sudo on the VM # Flip to true if Docker needs sudo on the VM
use_sudo: false use_sudo: false
# ---------- Collabora settings ---------- # ---------- Collabora defaults (can be overridden by detection) ----------
collabora_project: "nextcloud-collabora" collabora_project: "nextcloud-collabora"
collabora_compose_file: "/data/compose/nextcloud/collabora-only.yml" collabora_candidate_files:
# English comments: ordered list of likely compose file locations
- "/data/compose/nextcloud/collabora-only.yml"
- "/data/compose/nextcloud/collabora.yml"
- "/data/compose/collabora/docker-compose.yml"
- "/data/compose/collabora/compose.yml"
# ---------- Nextcloud commands ---------- # ---------- Nextcloud commands ----------
vm_commands: vm_commands:
@@ -44,15 +49,6 @@
# English comments: run health script non-interactively with a timeout and xtrace for debugging # English comments: run health script non-interactively with a timeout and xtrace for debugging
- "set -o pipefail; timeout 180s bash -x /data/compose/nextcloud/stack-health.sh </dev/null" - "set -o pipefail; timeout 180s bash -x /data/compose/nextcloud/stack-health.sh </dev/null"
# ---------- Collabora update commands ----------
collabora_commands:
# English comments: pre-pull latest base image (optional but keeps cache warm)
- "timeout 600s docker pull collabora/code:latest"
# English comments: pull service image defined in compose file
- "timeout 600s docker compose -p {{ collabora_project }} -f {{ collabora_compose_file }} pull collabora"
# English comments: recreate only the 'collabora' service without touching dependencies
- "timeout 600s docker compose -p {{ collabora_project }} -f {{ collabora_compose_file }} up -d --no-deps --force-recreate collabora"
tasks: tasks:
- name: Ensure sshpass is installed (for password-based SSH) # English comments - name: Ensure sshpass is installed (for password-based SSH) # English comments
ansible.builtin.apt: ansible.builtin.apt:
@@ -60,25 +56,9 @@
state: present state: present
update_cache: yes update_cache: yes
- name: Preflight | Ensure Collabora compose file exists on VM # English comments ###########################################################################
ansible.builtin.command: # Nextcloud maintenance (works for you already)
argv: ###########################################################################
- sshpass
- -p
- "{{ vm_pass }}"
- ssh
- -o
- StrictHostKeyChecking=no
- -o
- ConnectTimeout=15
- "{{ vm_user }}@{{ vm_ip }}"
- bash
- -lc
- "{{ ('sudo ' if use_sudo else '') }}test -f '{{ collabora_compose_file }}'"
register: collab_preflight
changed_when: false
failed_when: collab_preflight.rc != 0
- name: Run Nextcloud commands on VM (via SSH, argv, no line breaks) - name: Run Nextcloud commands on VM (via SSH, argv, no line breaks)
ansible.builtin.command: ansible.builtin.command:
argv: argv:
@@ -90,6 +70,10 @@
- StrictHostKeyChecking=no - StrictHostKeyChecking=no
- -o - -o
- ConnectTimeout=15 - ConnectTimeout=15
- -o
- ServerAliveInterval=15 # English: keep SSH from stalling silently
- -o
- ServerAliveCountMax=2
- "{{ vm_user }}@{{ vm_ip }}" - "{{ vm_user }}@{{ vm_ip }}"
- bash - bash
- -lc - -lc
@@ -97,6 +81,7 @@
loop: "{{ vm_commands }}" loop: "{{ vm_commands }}"
register: vm_cmds register: vm_cmds
changed_when: false changed_when: false
failed_when: false # English: we'll assert later to print richer logs first
- name: Show outputs for each Nextcloud command - name: Show outputs for each Nextcloud command
ansible.builtin.debug: ansible.builtin.debug:
@@ -116,7 +101,10 @@
success_msg: "All Nextcloud commands succeeded." success_msg: "All Nextcloud commands succeeded."
loop: "{{ vm_cmds.results }}" loop: "{{ vm_cmds.results }}"
- name: Update Collabora on VM (via SSH, argv, no line breaks) ###########################################################################
# Collabora update (robust detection + conditional execution)
###########################################################################
- name: Collabora | Detect docker compose CLI on VM (v2 or legacy) # English comments
ansible.builtin.command: ansible.builtin.command:
argv: argv:
- sshpass - sshpass
@@ -130,25 +118,152 @@
- "{{ vm_user }}@{{ vm_ip }}" - "{{ vm_user }}@{{ vm_ip }}"
- bash - bash
- -lc - -lc
- "{{ ('sudo ' if use_sudo else '') + item }}" - >
loop: "{{ collabora_commands }}" if {{ 'sudo ' if use_sudo else '' }}docker compose version >/dev/null 2>&1; then
register: collab_cmds echo "docker compose";
elif {{ 'sudo ' if use_sudo else '' }}docker-compose version >/dev/null 2>&1; then
echo "docker-compose";
else
echo "none";
fi
register: compose_cli
changed_when: false changed_when: false
failed_when: false
- name: Show outputs for each Collabora command - name: Collabora | Set compose command fact # English comments
ansible.builtin.set_fact:
docker_compose_cmd: "{{ (compose_cli.stdout | trim) if (compose_cli.stdout | trim) else 'none' }}"
- name: Collabora | Warn if compose CLI not found
ansible.builtin.debug:
msg: "Collabora update skipped: no docker compose CLI found on VM."
when: docker_compose_cmd == 'none'
- name: Collabora | Find first existing compose file on VM # English comments
ansible.builtin.command:
argv:
- sshpass
- -p
- "{{ vm_pass }}"
- ssh
- -o
- StrictHostKeyChecking=no
- -o
- ConnectTimeout=15
- "{{ vm_user }}@{{ vm_ip }}"
- bash
- -lc
- |
set -euo pipefail
for f in {{ collabora_candidate_files | map('quote') | join(' ') }}; do
if {{ 'sudo ' if use_sudo else '' }}test -f "$f"; then
echo "$f"
exit 0
fi
done
exit 3
register: collab_file_probe
changed_when: false
failed_when: false
when: docker_compose_cmd != 'none'
- name: Collabora | Set resolved compose file fact
ansible.builtin.set_fact:
collabora_compose_file_resolved: "{{ (collab_file_probe.stdout | trim) if (collab_file_probe.rc == 0) else '' }}"
when: docker_compose_cmd != 'none'
- name: Collabora | Warn if compose file not found
ansible.builtin.debug:
msg: "Collabora update skipped: no compose file found in candidates: {{ collabora_candidate_files }}"
when:
- docker_compose_cmd != 'none'
- collabora_compose_file_resolved | default('') == ''
- name: Collabora | Verify 'collabora' service exists in compose # English comments
ansible.builtin.command:
argv:
- sshpass
- -p
- "{{ vm_pass }}"
- ssh
- -o
- StrictHostKeyChecking=no
- -o
- ConnectTimeout=15
- "{{ vm_user }}@{{ vm_ip }}"
- bash
- -lc
- >
{{ ('sudo ' if use_sudo else '') }}{{ docker_compose_cmd }} -p {{ collabora_project }}
-f {{ collabora_compose_file_resolved }} config --services | grep -qx collabora
register: collab_service_check
changed_when: false
failed_when: false
when:
- docker_compose_cmd != 'none'
- collabora_compose_file_resolved | default('') != ''
- name: Collabora | Warn if service 'collabora' missing
ansible.builtin.debug:
msg: "Collabora update skipped: service 'collabora' not found in compose file {{ collabora_compose_file_resolved }}."
when:
- docker_compose_cmd != 'none'
- collabora_compose_file_resolved | default('') != ''
- collab_service_check.rc != 0
- name: Collabora | Run update commands (pull + up -d) # English comments
ansible.builtin.command:
argv:
- sshpass
- -p
- "{{ vm_pass }}"
- ssh
- -o
- StrictHostKeyChecking=no
- -o
- ConnectTimeout=15
- -o
- ServerAliveInterval=15
- -o
- ServerAliveCountMax=2
- "{{ vm_user }}@{{ vm_ip }}"
- bash
- -lc
- >
set -o pipefail;
{{ ('sudo ' if use_sudo else '') }}timeout 600s docker pull collabora/code:latest;
{{ ('sudo ' if use_sudo else '') }}timeout 600s {{ docker_compose_cmd }} -p {{ collabora_project }}
-f {{ collabora_compose_file_resolved }} pull collabora;
{{ ('sudo ' if use_sudo else '') }}timeout 600s {{ docker_compose_cmd }} -p {{ collabora_project }}
-f {{ collabora_compose_file_resolved }} up -d --no-deps --force-recreate collabora
register: collab_update
changed_when: false
failed_when: false
when:
- docker_compose_cmd != 'none'
- collabora_compose_file_resolved | default('') != ''
- collab_service_check.rc == 0
- name: Collabora | Show update output
ansible.builtin.debug: ansible.builtin.debug:
msg: | msg: |
CMD: {{ item.item }} Collabora update output:
RC: {{ item.rc }} RC: {{ collab_update.rc | default('n/a') }}
STDOUT: STDOUT:
{{ (item.stdout | default('')).strip() }} {{ (collab_update.stdout | default('')).strip() }}
STDERR: STDERR:
{{ (item.stderr | default('')).strip() }} {{ (collab_update.stderr | default('')).strip() }}
loop: "{{ collab_cmds.results }}" when:
- docker_compose_cmd != 'none'
- collabora_compose_file_resolved | default('') != ''
- collab_service_check.rc == 0
- name: Fail play if any Collabora command failed - name: Collabora | Fail if update command failed
ansible.builtin.assert: ansible.builtin.assert:
that: "item.rc == 0" that: "collab_update.rc == 0"
fail_msg: "Collabora update failed on VM: {{ item.item }} (rc={{ item.rc }}) {{ ' -- likely timeout' if item.rc == 124 else '' }}" fail_msg: "Collabora update failed (rc={{ collab_update.rc }}) {{ ' -- likely timeout' if collab_update.rc == 124 else '' }}"
success_msg: "Collabora updated successfully." success_msg: "Collabora updated successfully."
loop: "{{ collab_cmds.results }}" when:
- docker_compose_cmd != 'none'
- collabora_compose_file_resolved | default('') != ''
- collab_service_check.rc == 0