aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CONFIG.md
blob: bdc5b02bb5b29add4daea5cb28976686c50a0da7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# jprov Configuration

This document defines the main configuration file and per-jail TOML schema.

## Main Config
Default locations (first found wins):
- `/usr/local/etc/jprov.conf`
- `/etc/jprov.conf`

Schema (TOML):
```toml
base_dir = "/usr/local/jails"

[datasets]
templates_prefix = "zroot/jails/templates/"
containers_prefix = "zroot/jails/containers/"

jail_conf_dir = "/etc/jail.conf.d"
log_dir = "/var/log/jprov"
```

Notes:
- `base_dir` contains `templates/` and `defs/`.
- `templates_prefix` and `containers_prefix` are ZFS dataset name prefixes (must end with `/`).
- `log_dir` is where per-run logs are written.

## Per-jail Config
Location:
- `base_dir/defs/<jailname>/jprov.conf`

Schema (TOML):
```toml
# Required
# Relative to datasets.templates_prefix
# Example: "RELEASE-15.0-p3" resolves to "zroot/jails/templates/RELEASE-15.0-p3"
template = "RELEASE-15.0-p3"

# Required
# Command executed inside the jail via: jexec <jailname> <cmd>
cmd = "/bin/sh /usr/local/sbin/provision.sh"

# Optional
# Overlay defaults to base_dir/defs/<jailname>/overlay/
overlay = "overlay"

# Optional: environment variables passed to the provisioning command
[env]
FOO = "bar"

# Optional: append raw jail.conf content
extra_jail_conf = """
allow.raw_sockets = 1;
"""

# Optional: nullfs mounts
[[mounts]]
host = "/usr/local/jails/volumes/foo"
jail = "/mnt/foo"
readonly = false
```

Notes:
- `cmd` is executed as a direct command (no implicit shell wrapping); jprov only checks its exit code.
- `overlay` is copied into the jail root after it is created.
- All `mounts[*].host` paths must exist on the host and are mounted via `nullfs`.