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

Refactor update_collabora.yml: streamline Collabora update process with improved command structure and error handling

Browse Source
This commit is contained in:
fencl
2025-10-05 09:27:19 +02:00
parent abc7fba684
commit 4dd4b3b6f7
1 changed files with 16 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

229
nextcloud/update_collabora.yml
View File

@@ -1,22 +1,10 @@
# """
# Run the command and check the response.
# Update Collabora CODE container on VM via Proxmox.
#
# :parameter command: The command to be executed.
# :parameter add_command: Whether to include the command in the database values.
# :parameter add_response: Whether to include the response in the database values.
# :parameter measurement: The measurement index for the command.
# :parameter measure_retries: The number of retries for measurement in case of failure.
# :parameter check_port: Whether to check the port before sending the command.
# :parameter response_equals: The expected response string to compare against.
# :parameter response_length: The expected length or format of the response.
# :parameter send_skipped: Whether to mark the test as skipped without execution.
# :parameter no_response: Whether to expect no response from the command.
# :parameter expect_patch_id_decimal: The expected patch ID in decimal format for validation.
# :parameter response_equals_match: The expected response string to match against.
# :return: RunResultType
# """
- name: Run Nextcloud maintenance on VM via Proxmox
- name: Update Collabora CODE on VM via Proxmox
hosts: proxmox
gather_facts: false
become: true
@@ -31,23 +19,13 @@
# Flip to true if Docker needs sudo on the VM
use_sudo: false
# ---------- Collabora defaults (can be overridden by detection) ----------
collabora_project: "nextcloud-collabora"
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"
collabora_compose_file: "/data/compose/nextcloud/collabora-only.yml"
# ---------- Nextcloud commands ----------
vm_commands:
- "docker exec -u www-data nextcloud php -f /var/www/html/cron.php"
- "docker exec -u www-data nextcloud php occ app:update --all"
- "docker exec -u www-data nextcloud php occ maintenance:repair --include-expensive"
- "docker exec -u www-data nextcloud php occ status"
# 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"
collabora_commands:
- "docker pull collabora/code:latest"
- "docker compose -p {{ collabora_project }} -f {{ collabora_compose_file }} pull collabora"
- "docker compose -p {{ collabora_project }} -f {{ collabora_compose_file }} up -d --no-deps --force-recreate collabora"
tasks:
- name: Ensure sshpass is installed (for password-based SSH) # English comments
@@ -56,10 +34,7 @@
state: present
update_cache: yes
###########################################################################
# Nextcloud maintenance (works for you already)
###########################################################################
- name: Run Nextcloud commands on VM (via SSH, argv, no line breaks)
- name: Run Collabora update commands on VM (via SSH)
ansible.builtin.command:
argv:
- sshpass
@@ -70,20 +45,15 @@
- StrictHostKeyChecking=no
- -o
- ConnectTimeout=15
- -o
- ServerAliveInterval=15 # English: keep SSH from stalling silently
- -o
- ServerAliveCountMax=2
- "{{ vm_user }}@{{ vm_ip }}"
- bash
- -lc
- "{{ ('sudo ' if use_sudo else '') + item }}"
loop: "{{ vm_commands }}"
register: vm_cmds
loop: "{{ collabora_commands }}"
register: collab_cmds
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 Collabora command
ansible.builtin.debug:
msg: |
CMD: {{ item.item }}
@@ -92,178 +62,11 @@
{{ (item.stdout | default('')).strip() }}
STDERR:
{{ (item.stderr | default('')).strip() }}
loop: "{{ vm_cmds.results }}"
loop: "{{ collab_cmds.results }}"
- name: Fail play if any Nextcloud command failed
- name: Fail play if any Collabora command failed
ansible.builtin.assert:
that: "item.rc == 0"
fail_msg: "Command failed on VM: {{ item.item }} (rc={{ item.rc }}) {{ ' -- likely timeout' if item.rc == 124 else '' }}"
success_msg: "All Nextcloud commands succeeded."
loop: "{{ vm_cmds.results }}"
###########################################################################
# Collabora update (robust detection + conditional execution)
###########################################################################
- name: Collabora | Detect docker compose CLI on VM (v2 or legacy) # English comments
ansible.builtin.command:
argv:
- sshpass
- -p
- "{{ vm_pass }}"
- ssh
- -o
- StrictHostKeyChecking=no
- -o
- ConnectTimeout=15
- "{{ vm_user }}@{{ vm_ip }}"
- bash
- -lc
- >
if {{ 'sudo ' if use_sudo else '' }}docker compose version >/dev/null 2>&1; then
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
failed_when: false
- 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:
msg: |
Collabora update output:
RC: {{ collab_update.rc | default('n/a') }}
STDOUT:
{{ (collab_update.stdout | default('')).strip() }}
STDERR:
{{ (collab_update.stderr | default('')).strip() }}
when:
- docker_compose_cmd != 'none'
- collabora_compose_file_resolved | default('') != ''
- collab_service_check.rc == 0
- name: Collabora | Fail if update command failed
ansible.builtin.assert:
that: "collab_update.rc == 0"
fail_msg: "Collabora update failed (rc={{ collab_update.rc }}) {{ ' -- likely timeout' if collab_update.rc == 124 else '' }}"
success_msg: "Collabora updated successfully."
when:
- docker_compose_cmd != 'none'
- collabora_compose_file_resolved | default('') != ''
- collab_service_check.rc == 0
fail_msg: "Collabora update failed on VM: {{ item.item }} (rc={{ item.rc }})"
success_msg: "All Collabora update commands succeeded."
loop: "{{ collab_cmds.results }}"