Skip to content

UnionFS

Overview

UnionFS is a Saltbox module that installs and configures MergerFS to create a union filesystem merging local and remote storage paths, managing Docker services during mount operations.


UnionFS is a filesystem service for Linux, FreeBSD and NetBSD which implements a union mount for other file systems.

Deployment

Core Saltbox role.

sb install mounts

Role Defaults

Variables can be customized using the Inventory. (1)

  1. Example override

    local_mount_branch: "custom_value"
    
local_mount_branch
# Type: string
local_mount_branch: "{{ server_local_folder_path }}=RW:"
custom_mount_branch
# Type: string
custom_mount_branch: "" # Format: "/mnt/remote/someremote=NC"
mergerfs_override_service
# Type: bool (true/false)
mergerfs_override_service: true
mergerfs_service_name
# Type: string
mergerfs_service_name: "saltbox_managed_mergerfs.service"