diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..136cc75 --- /dev/null +++ b/readme.md @@ -0,0 +1,43 @@ +# Ansible Role: NFS Client + +Install and configure NFS client with systemd-managed mounts. + +## Variables + +| Variable | Required | Default | Description | +|----------|----------|---------|-------------| +| `nfs_mount` | Yes | `[]` | List of NFS mounts to configure | +| `nfs_mount[].nfs_host` | Yes | - | NFS server hostname or IP | +| `nfs_mount[].nfs_dir` | Yes | - | Remote directory path on NFS server | +| `nfs_mount[].local_dir_path` | Yes | - | Local mount point path | +| `nfs_mount[].nfs_opts` | Yes | - | NFS mount options | +| `nfs_mount[].nfs_fstype` | No | `nfs4` | NFS filesystem type | +| `nfs_mount[].local_dir_owner` | No | `root` | Local directory owner | +| `nfs_mount[].local_dir_group` | No | `root` | Local directory group | +| `nfs_mount[].local_dir_mode` | No | `0775` | Local directory permissions | +| `nfs_mount[].before_service` | No | - | List of systemd services to start after mount | + +## Example + +```yaml +nfs_mount: + + # production share + - nfs_host: "10.0.0.10" + nfs_dir: "/srv/nfs/production" + local_dir_path: "/mnt/production" + nfs_opts: "rw,hard,intr,rsize=8192,wsize=8192" + nfs_fstype: "nfs4" + local_dir_owner: "www-data" + local_dir_group: "www-data" + local_dir_mode: "0755" + before_service: + - "nginx.service" + - "php-fpm.service" + + # backup share + - nfs_host: "nfs.example.com" + nfs_dir: "/exports/backups" + local_dir_path: "/mnt/backups" + nfs_opts: "ro,soft,timeo=30" +```