Merge pull request #23 from tigattack/feat/install_mergerfs_tools

README.md

@@ -58,6 +58,27 @@ Default: `true`
 
 Whether the role should install [prerequisites](defaults/main.yml) for you. If in doubt, leave on default.
 
+### `mergerfs_install_tools`
+
+Default: `false`
+
+Whether to install [mergerfs-tools](https://github.com/trapexit/mergerfs-tools).
+
+> [!NOTE]
+> As mergerfs-tools must be cloned from GitHub to install, this role will also ensure `git` is installed on the host if this variable is `true`.
+
+### `mergerfs_tools_github_repo_url`
+
+Default: [`https://github.com/trapexit/mergerfs-tools`](https://github.com/trapexit/mergerfs-tools)
+
+URL of the mergerfs-tools GitHub repository. Used to clone the repository.
+
+### `mergerfs_tools_clone_dir`
+
+Default: `/tmp/mergerfs-tools`
+
+Temporary directory to clone mergerfs-tools into before install.
+
 ## Dependencies
 
 None.

defaults/main.yml

@@ -19,3 +19,13 @@ mergerfs_install_prerequisites: true
 
 # Whether mergerfs mounts not listed in `mergerfs_mounts` should be unmounted.
 mergerfs_remove_undefined_mounts: false
+
+# Whether to install mergerfs-tools.
+mergerfs_install_tools: false
+
+# URL of the mergerfs-tools GitHub repository.
+# Used to clone the repository.
+mergerfs_tools_github_repo_url: https://github.com/trapexit/mergerfs-tools
+
+# Temporary directory to clone mergerfs-tools into before install.
+mergerfs_tools_clone_dir: /tmp/mergerfs-tools

meta/argument_specs.yml

@@ -33,3 +33,20 @@ argument_specs:
         type: bool
         default: false
         description: 'Whether mergerfs mounts not listed in `mergerfs_mounts` should be unmounted.'
+
+      mergerfs_install_tools:
+        type: bool
+        default: false
+        description: 'Whether to install mergerfs-tools.'
+
+      mergerfs_tools_github_repo_url:
+        type: str
+        default: https://github.com/trapexit/mergerfs-tools
+        description:
+          - URL of the mergerfs-tools GitHub repository.
+          - Used to clone the repository.
+
+      mergerfs_tools_clone_dir:
+        type: str
+        default: /tmp/mergerfs-tools
+        description: 'Temporary directory to clone mergerfs-tools into before install.'

molecule/default/converge.yml

@@ -7,5 +7,6 @@
         branches:
           - /mnt/data*
         options: allow_other,use_ino
+    mergerfs_install_tools: true
   roles:
     - role: ansible-role-mergerfs

tasks/install_mergerfs_tools.yml

@@ -0,0 +1,29 @@
+---
+
+- name: Ensure git is installed
+  ansible.builtin.package:
+    name: git
+    state: present
+
+- name: Clone mergerfs-tools # noqa latest[git]
+  ansible.builtin.git:
+    repo: >-
+      {{
+        mergerfs_tools_github_repo_url if mergerfs_tools_github_repo_url.endswith('.git')
+        else (mergerfs_tools_github_repo_url + '.git')
+      }}
+    dest: "{{ mergerfs_tools_clone_dir }}"
+
+- name: Discover tool files
+  ansible.builtin.find:
+    paths: "{{ mergerfs_tools_clone_dir }}/src"
+    file_type: file
+  register: mergerfs_tools_files
+
+- name: Install mergerfs-tools
+  ansible.builtin.command:
+    cmd: "install -v -m 0755 -o root -g root -D -C {{ item }} /usr/local/bin"
+    chdir: "{{ mergerfs_tools_clone_dir }}/src"
+  loop: "{{ mergerfs_tools_files.files | map(attribute='path') | map('basename') }}"
+  register: mergerfs_tools_install
+  changed_when: mergerfs_tools_install.stdout != ""

tasks/main.yml

@@ -39,6 +39,11 @@
   ansible.builtin.include_tasks:
     file: install_{{ ansible_os_family | lower }}.yml
 
+- name: Install mergerfs-tools
+  ansible.builtin.include_tasks:
+    file: install_mergerfs_tools.yml
+  when: mergerfs_install_tools
+
 - name: Mount mergerfs filesystems
   ansible.posix.mount:
     fstype: fuse.mergerfs