always recreate; deprecate version tag

Reviewed-on: #3

.ansible-lint

@@ -0,0 +1,6 @@
+offline: false
+
+warn_list:
+  - yaml[line-length]
+  - yaml[empty-lines]
+  - yaml[new-line-at-end-of-file]

.ansible-lint-ignore

@@ -1,6 +0,0 @@
-
-# In den hier aufgelisteten Dateien sollen die dahinter stehenden
-# Warnungen und Fehler von ansible-lint ignoriert werden.
-
-tasks/main.yaml no-handler # Der Restart / Recreate Gitea Task ist gut dort, wo er ist
-tasks/main.yaml name[template] # Es braucht zwei Templates, um den FQDN zusammenzusetzen.

.gitea/workflows/ansible-lint.yaml

@@ -1,5 +1,5 @@
 name: ansible-lint
-on: [push, pull_request]
+on: [push, pull_request] # yamllint disable-line rule:truthy
 
 jobs:
   build:
@@ -14,7 +14,7 @@ jobs:
 
       - name: Run ansible-lint
         # replace `main` with any valid ref, or tags like `v6`
-        uses: https://github.com/ansible/ansible-lint-action@main
+        uses: https://github.com/ansible/ansible-lint-action@v6
         # optional:
         # with:
         #   path: "playbooks/"  # <-- only one value is allowed

handlers/backup.yaml

@@ -0,0 +1,29 @@
+- name: Get stats of docker-compose.yaml
+  ansible.builtin.stat:
+    path: /opt/gitea/docker-compose.yaml
+  register: docker_compose_stat
+  listen:
+    - Backup Gitea
+
+- name: Stop Gitea for backup
+  community.docker.docker_compose_v2:
+    project_src: /opt/gitea
+    state: stopped
+  register: docker_compose
+  listen:
+    - Backup Gitea
+  notify:
+    - Ensure Gitea is running
+  when: docker_compose_stat.stat.exists is defined and docker_compose_stat.stat.exists
+
+- name: Backup Gitea directory
+  community.general.archive:
+    path: "{{ gitea_vars.base_path }}/"
+    dest: "/var/backups/gitea-{{ gitea.hostname }}.{{ gitea.domain }}@{{ lookup('pipe', 'date -u +%Y-%m-%dT%H:%M:%SZ') }}.tar.gz"
+    force_archive: true
+    format: gz
+    owner: root
+    mode: "400"
+  listen:
+    - Backup Gitea
+  register: backup

handlers/main.yaml

@@ -0,0 +1,37 @@
+- name: Import backup handler
+  ansible.builtin.import_tasks:
+    file: backup.yaml
+
+- name: Ensure Docker images are up to date
+  community.docker.docker_compose_v2_pull:
+    project_src: /opt/gitea
+
+- name: Ensure Gitea is restarted
+  community.docker.docker_compose_v2:
+    project_src: /opt/gitea
+    state: restarted
+    recreate: always
+  register: docker_compose
+
+- name: Ensure Gitea is running
+  community.docker.docker_compose_v2:
+    project_src: /opt/gitea
+  register: docker_compose
+
+- name: Get Gitea HTTP response
+  ansible.builtin.uri:
+    url: "https://{{ gitea.hostname }}.{{ gitea.domain }}"
+  register: gitea_http_response
+  failed_when: 400 <= gitea_http_response.status < 500
+
+- name: Wait until Gitea is up
+  ansible.builtin.uri:
+    url: "https://{{ gitea.hostname }}.{{ gitea.domain }}"
+  register: gitea_http_response
+  until: gitea_http_response.status == 200
+  retries: 30
+  delay: 2
+
+- name: Output docker compose state
+  ansible.builtin.debug:
+    var: docker_compose

requirements.yml

@@ -0,0 +1,8 @@
+# actions/run-ansible-lint forces me to name this file .yml instead of .yaml :(
+
+collections:
+  - name: community.docker
+    source: https://galaxy.ansible.com
+
+  - name: community.general
+    source: https://galaxy.ansible.com

tasks/main.yaml

@@ -5,114 +5,86 @@
 #       - docker.io
 #       - python3-docker
 
-- name: Create git USER
+- name: Ensure git user exists
   ansible.builtin.user:
     name: git
   register: git_user
 
-- name: Create Gitea
+- name: Ensure Gitea directories exist
   ansible.builtin.file:
-    path: "/opt/gitea"
+    path: "{{ item }}"
     state: directory
     owner: root
     mode: "755"
+  with_items: ["/opt/gitea", "{{ gitea_vars.base_path }}"]
 
-- name: Create Data Directory
+- name: Ensure data and config directories exist
   ansible.builtin.file:
-    path: "/opt/gitea/data"
+    path: "{{ gitea_vars.base_path }}/{{ item }}"
     state: directory
     owner: "{{ git_user.uid }}"
     group: "{{ git_user.group }}"
     mode: "700"
+  with_items: ["data", "config"]
 
-- name: Create Config Directory
+- name: Ensure docker daemon is started
-  ansible.builtin.file:
-    path: "/opt/gitea/config"
-    state: directory
-    owner: "{{ git_user.uid }}"
-    group: "{{ git_user.group }}"
-    mode: "700"
-
-- name: Start Docker Daemon
   ansible.builtin.systemd:
     name: docker
     enabled: true
     state: started
 
-- name: Backup Files
+- name: Ensure old backups will get deleted
-  block:
+  ansible.builtin.cron:
-    - name: Stop Gitea for Backup
+    name: gitea backup cleanup
-      community.docker.docker_compose:
+    minute: "0"
-        project_src: /opt/gitea
+    hour: "8"
-        state: present
+    user: root
-        stopped: true
+    job: find /var/backups -path '/var/backups/gitea-*' -mtime +7 -type f -exec rm {} +
+    cron_file: gitea-backup-cleanup
 
-    - name: Backup Gitea Directory
+- name: Check if environment.env will get changed
-      ansible.builtin.copy:
-        src: /opt/gitea
-        dest: "/opt/gitea.backup@{{ ansible_date_time.iso8601 }}"
-        mode: "700"
-        remote_src: true
-        directory_mode: true
-      register: backup
-
-- name: Apply Changes
-  block:
-    - name: Upload Environment File
   ansible.builtin.template:
     src: environment.env.j2
     dest: "/opt/gitea/environment.env"
     owner: root
     mode: "600"
-      register: gitea_env
+  register: env_diff
+  check_mode: true
+  notify:
+    - Backup Gitea
 
-    - name: Upload docker-compose.yaml
+- name: Check if docker-compose.yaml will get changed
   ansible.builtin.template:
     src: docker-compose.yaml.j2
     dest: /opt/gitea/docker-compose.yaml
     owner: root
     mode: "600"
-      register: gitea_container
+  register: docker_compose_diff
+  check_mode: true
+  notify:
+    - Backup Gitea
 
-    - name: Create / Recreate Gitea
+- name: Execute handlers before changing configfiles
-      community.docker.docker_compose:
+  ansible.builtin.meta: flush_handlers
-        project_src: /opt/gitea
-        state: present
-        restarted: true
-      when: gitea_env.changed or gitea_container.changed
 
-    - name: Check if {{ gitea.hostname }}.{{ gitea.domain }} is available and returning status 200
+- name: Upload environment.env
-      ansible.builtin.uri:
+  ansible.builtin.template:
-        url: "https://{{ gitea.hostname }}.{{ gitea.domain }}"
+    src: environment.env.j2
-      register: _result
+    dest: "/opt/gitea/environment.env"
-      until: _result.status == 200
+    owner: root
-      retries: 30
+    mode: "600"
-      delay: 2
+  notify:
+    - Ensure Gitea is restarted
+    - Wait until Gitea is up
 
-  rescue:
+- name: Upload docker-compose.yaml
-    - name: Stop Gitea for Backup
+  ansible.builtin.template:
-      community.docker.docker_compose:
+    src: docker-compose.yaml.j2
-        project_src: /opt/gitea
+    dest: /opt/gitea/docker-compose.yaml
-        state: present
+    owner: root
-        stopped: true
+    mode: "600"
-
+  notify:
-    - name: Restore Gitea Directory from Backup
+    - Ensure Docker images are up to date
-      ansible.builtin.copy:
+    - Output docker compose state
-        src: "{{ backup.dest }}"
+    - Ensure Gitea is restarted
-        dest: "{{ backup.src }}"
+    - Wait until Gitea is up
-        remote_src: true
-        mode: "700"
-
-    - name: Create / Recreate Gitea
-      community.docker.docker_compose:
-        project_src: /opt/gitea
-        state: present
-        restarted: true
-  always:
-    - name: Check if {{ gitea.hostname }}.{{ gitea.domain }} is available and returning status 200
-      ansible.builtin.uri:
-        url: "https://{{ gitea.hostname }}.{{ gitea.domain }}"
-      register: _result
-      until: _result.status == 200
-      retries: 30
-      delay: 2

templates/docker-compose.yaml.j2

@@ -4,8 +4,6 @@
 # -- Diese Datei wird via Ansible verwaltet und automatisch überschrieben!
 # https://azubi-gitea.int.sernet.de/mmeyer/ansible-role-gitea/src/branch/main/templates/docker-compose.yaml.j2
 
-version: "3.8"
-
 networks:
   gitea:
     external: false
@@ -13,10 +11,10 @@ networks:
 services:
   gitea:
     image: gitea/gitea:{{ gitea_vars['version'] }}-rootless
-    restart: always
+    restart: unless-stopped
     volumes:
-      - ./data:/var/lib/gitea
+      - {{ gitea_vars.base_path }}/data:/var/lib/gitea
-      - ./config:/etc/gitea
+      - {{ gitea_vars.base_path }}/config:/etc/gitea
       - /etc/timezone:/etc/timezone:ro
       - /etc/localtime:/etc/localtime:ro
     ports:
@@ -31,7 +29,7 @@ services:
 
   db:
     image: "{{ gitea_vars['database']['db_type'] }}:{{ gitea_vars['database']['docker_image_tag'] }}"
-    restart: always
+    restart: unless-stopped
     environment:
       - "MYSQL_DATABASE={{ gitea_vars.database.name }}"
       - "MYSQL_USER={{ gitea_vars.database.user }}"
@@ -40,5 +38,6 @@ services:
     networks:
       - gitea
     volumes:
-      - ./mysql:/var/lib/mysql
+      - {{ gitea_vars.base_path }}/mysql:/var/lib/mysql
-
+    cap_add:
+      - SYS_NICE

templates/environment.env.j2

@@ -47,9 +47,6 @@ GITEA__database__SQLITE_JOURNAL_MODE={{ gitea_vars.database.sqlite_journal_mode
 {% if 'iterate_buffer_size' in gitea_vars['database'] %}
 GITEA__database__ITERATE_BUFFER_SIZE={{ gitea_vars.database.iterate_buffer_size }}
 {% endif %}
-{% if 'charset' in gitea_vars['database'] %}
-GITEA__database__CHARSET={{ gitea_vars.database.charset }}
-{% endif %}
 {% if 'path' in gitea_vars['database'] %}
 GITEA__database__PATH={{ gitea_vars.database.path }}
 {% endif %}
@@ -93,7 +90,7 @@ GITEA__service__ENABLE_NOTIFY_MAIL={{ gitea_vars.service.enable_notify_mail }}
 GITEA__service__DEFAULT_KEEP_EMAIL_PRIVATE={{ gitea_vars.service.default_keep_email_private }}
 {% endif %}
 {% if 'default_allow_create_organization' in gitea_vars['service'] %}
-GITEA__service__DEFAULT_ALLOW_CREATE_ORGANIZATION ={{ gitea_vars.service.default_allow_create_organization }}
+GITEA__service__DEFAULT_ALLOW_CREATE_ORGANIZATION={{ gitea_vars.service.default_allow_create_organization }}
 {% endif %}
 {% if 'default_enable_timetracking' in gitea_vars['service'] %}
 GITEA__service__DEFAULT_ENABLE_TIMETRACKING={{ gitea_vars.service.default_enable_timetracking }}
@@ -187,7 +184,7 @@ GITEA__attachment__MINIO_BASE_PATH={{ gitea_vars.attachment.minio_base_path }}
 GITEA__attachment__MINIO_USE_SSL={{ gitea_vars.attachment.minio_use_ssl }}
 {% endif %}
 {% endif %} {# /attachment #}
-
+{#  Disabled logging for now
 {% if 'log' in gitea_vars %}
 {% if 'root_path' in gitea_vars['log'] %}
 GITEA__log__ROOT_PATH={{ gitea_vars.log.root_path }}
@@ -208,7 +205,7 @@ GITEA__log__ENABLE_log_LOG={{ gitea_vars.log.enable_log_log }}
 GITEA__log__ENABLE_XORM_LOG={{ gitea_vars.log.enable_xorm_log }}
 {% endif %}
 {% endif %} {# /logging#}
-
+#}
 {% if 'ssh' in gitea_vars %}
 {% if 'minimum_key_sizes' in gitea_vars['ssh'] %}
 {% if 'ed25519' in gitea_vars['ssh']['minimum_key_sizes'] %}
@@ -305,3 +302,18 @@ GITEA__actions__ENABLED={{ gitea_vars.actions.enabled }}
 GITEA__actions__DEFAULT_ACTIONS_URL={{ gitea_vars.actions.default_actions_url }}
 {% endif %}
 {% endif %} {# /actions #}
+
+{% if 'metrics' in gitea_vars %}
+{% if 'enabled' in gitea_vars['metrics'] %}
+GITEA__metrics__ENABLED={{ gitea_vars.metrics.enabled }}
+{% endif %}
+{% if 'enabled_issue_by_label' in gitea_vars['metrics'] %}
+GITEA__metrics__ENABLED_ISSUE_BY_LABEL={{ gitea_vars.metrics.enabled_issue_by_label }}
+{% endif %}
+{% if 'enabled_issue_by_repository' in gitea_vars['metrics'] %}
+GITEA__metrics__ENABLED_ISSUE_BY_REPOSITORY={{ gitea_vars.metrics.enabled_issue_by_repository }}
+{% endif %}
+{% if 'token' in gitea_vars['metrics'] %}
+GITEA__metrics__TOKEN={{ gitea_vars.metrics.token }}
+{% endif %}
+{% endif %} {# /actions #}