Commit 6f608888 authored by Simon Cornet's avatar Simon Cornet
Browse files

feat: add readme

parent 3d83fde6
Loading
Loading
Loading
Loading
Loading

readme.md

0 → 100644
+40 −0
Original line number Diff line number Diff line
# 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"
```