From 6f60888886b548f73db33ab67d5bfe5de244b820 Mon Sep 17 00:00:00 2001 From: Simon Cornet Date: Fri, 10 Apr 2026 08:31:55 +0200 Subject: [PATCH] feat: add readme --- readme.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..e87e69e --- /dev/null +++ b/readme.md @@ -0,0 +1,40 @@ +# Ansible Role: NFS Server + +Install and configure an NFS server with customizable exports. + +## Variables + +| Variable | Required | Default | Description | +|----------|----------|---------|-------------| +| `shares` | Yes | `[]` | List of NFS shares to export | +| `shares[].name` | Yes | - | Description of the share | +| `shares[].path` | Yes | - | Directory path to export | +| `shares[].client_ip` | Yes | - | Client IP address or network | +| `shares[].client_options` | Yes | - | NFS export options | +| `shares[].owner` | No | `root` | Directory owner | +| `shares[].group` | No | `root` | Directory group | +| `shares[].mode` | No | `0770` | Directory permissions | + +## Example + +```yaml +shares: + + # production data + - name: "production data" + path: "/srv/nfs/production" + client_ip: "10.0.0.0/24" + client_options: "rw,sync,no_subtree_check" + owner: "nobody" + group: "nogroup" + mode: "0775" + + # backup storage + - name: "backup storage" + path: "/srv/nfs/backups" + client_ip: "10.0.1.100" + client_options: "rw,no_root_squash,no_subtree_check" + owner: "backup" + group: "backup" + mode: "0700" +```