Volumes: data that outlives a jail
A volume is a dataset of a project that jails attach by name. Create it with an owner and a mode, attach it to one or several jails, snapshot it, and delete a jail without touching the data. A mail server and a desktop sharing one mail directory, and a directory of the host as a volume.
The idea
The jail is disposable, the data is not.
A volume is a dataset that belongs to a project, not to a jail. Jails attach it by name. You can delete, rebuild, upgrade or copy a jail and the volume stays exactly as it was, with its files and its snapshots.
Create and attach
The owner is set once, at creation.
The example is a mail server. The mail belongs to one user, so the volume is made for that user with a mode the group can use:
$ jailops volume create maildir --uid 5000 --gid 5000 --mode 0770 --comment "the mail of every user" $ jailops create mail --image freebsd-15-1 --network lan --storage default $ jailops volume attach mail maildir /var/mail/vhosts
The owner and the mode are set on the empty volume when it is made and cannot be changed later, so the files have the same owner wherever the volume is attached. A jail is changed with jailops volume attach and jailops volume detach while it is stopped; the attachment is there at the next start.
Several jails
One volume, many readers.
The same volume can be attached to more than one jail, at different paths:
$ jailops create desktop --image freebsd-15-1 --network lan --storage default $ jailops volume attach desktop maildir /home/ann/Mail $ jailops volume attach backup maildir /srv/mail --ro
JailOps warns when a volume is attached read-write to several jails, because two writers need to agree among themselves. Attach it read-only where you can. An encrypted volume attaches to one jail only.
Snapshots
Before a risky change.
$ jailops volume snapshot create maildir before-move -m "before the move" $ jailops volume snapshot list maildir $ jailops volume snapshot rollback maildir before-move
A rollback discards what was written since, so it asks you to type the name and is refused while a jail that has the volume attached is running.
When a jail goes away
The data stays.
- Delete a jail: it is detached and the volume stays.
jailops volume liststill shows it. - Snapshot, roll back or upgrade a jail: volumes are never touched. A volume has snapshots of its own.
- Copy a jail: the copy attaches no volume.
- Delete a volume: destroys its files and snapshots, and is refused while a jail attaches it.
The apps of the catalog keep their data the same way: an app's data directories are volumes named after the jail, and they stay when the jail is deleted.
A directory of the host
A mounted storage box as a volume.
A directory that is already on the host, such as a storage box mounted over the network, can be a volume too. Only an administrator creates one, and only below the directories the host's operator approved. JailOps watches that the mount is really there:
$ jailops volume create storagebox --path /mnt/storagebox --watch --on-loss stop--watchchecks that the directory is still a mount of its own, and not an empty directory of the host underneath it.--probe writealso tries to write.--on-loss stopstops the jails that attach it when the mount goes away, andnoneonly reports it. Either way the jail never sees an empty directory instead of its data.- When the mount comes back, JailOps attaches it to the jails again.
See also
- A volume is backed up once, however many jails attach it: Back up volumes once.
- A volume can be encrypted at rest: Encrypted volumes.
More articles
Jail updates without cron
Replace the nightly script that upgrades every jail: automatic jail upgrades per image, with a health check, a rollback and a record of every run, what they leave alone, and how a new FreeBSD release comes in.
Read the article: Jail updates without cronJail search and shell
Ctrl+K, a few letters, Shift+Enter: find a jail by name, label or app and open its shell. Labels that filter the jail list, bash in new jails, and the jailops command next to every step.
Read the article: Jail search and shellGetting started with the JailOps CLI
Root on the host, the command line and nothing else: install JailOps, build an image, create a network and a jail, reach it by name, snapshot it, open a port and install an app.
Read the article: Getting started with the JailOps CLIJailOps on a netcup server, with IPv6 that stays up
A /64, a router pair and a FreeBSD default that drops their probes. How every jail gets its own IPv6 address on netcup, and the one sysctl that ends the random unreachable alerts.
Read the article: JailOps on a netcup server, with IPv6 that stays upOne small cloud server, many services, solid IPv6
Run your database, web tier and workers on one low-cost server, each jail with its own IPv6 address, and fix the alerts a shared /64 causes with one sysctl.
Read the article: One small cloud server, many services, solid IPv6Write your own app: memcached, from package to catalog
Turn a small FreeBSD package into a JailOps app: the definition line by line, the offline check, a local install, the five traps, and the pull request that puts it in the catalog.
Read the article: Write your own app: memcached, from package to catalogFrom catalog to running service in one command
Install nginx from the app catalog with one command, see each of its steps, and find the data, the configuration, the logs and the snapshot afterwards.
Read the article: From catalog to running service in one commandA firewall you can read
Policies, address sets and jails by name (jail:web), each with a comment, so the firewall can be reviewed by someone who did not write it.
Read the article: A firewall you can readPostgreSQL and git, closed except for who needs them
Close a database and a git server, then let in exactly the web jail and the office, with a comment on every entry.
Read the article: PostgreSQL and git, closed except for who needs themProjects are boundaries
A project is a boundary. Another project is an external host, so only addresses cross it, written out on both sides. Why that is simpler to review, and what a project does not isolate.
Read the article: Projects are boundariesThe life of a jail
A jail starts at boot only when you declared it with --autostart. Why JailOps does it this way, how the order is decided, and how to see it with jailops boot.
Read the article: The life of a jailTab completion for jailops
Press Tab and get the names of your jails, networks and firewall policies, even on another host. How to install and turn on completion in bash, zsh and fish.
Read the article: Tab completion for jailopsTest the firewall before you trust it
Ask the firewall whether a connection would pass, and why, before you try it. Read the answer, put it in a script, and know what it cannot tell you.
Read the article: Test the firewall before you trust itSee a connection before it happens
Pick a From and a To, a protocol and a port, press Run, and see the connection flow through the firewall: what passes, what stops it, and which rule decides.
Read the article: See a connection before it happensLimit what a jail can use
Give a jail a ceiling for memory, processes, CPU, disk, firewall states and bandwidth, one command each, and know what happens when it reaches it.
Read the article: Limit what a jail can useStop every jail cleanly when the host shuts down
A host that reboots should stop its databases before it stops the disks. How JailOps stops the jails in order, and how to start them in order again.
Read the article: Stop every jail cleanly when the host shuts downOne line in pf.conf
The host's firewall stays yours. JailOps asks for one line, and everything for the jails lives below it.
Read the article: One line in pf.confWhat the host tells you by itself
A pool that reports an error, an uplink that goes down, a jail that reaches a limit: they show up in the event stream by themselves.
Read the article: What the host tells you by itselfNetworks the host controls
No bridge, no DHCP. The host hands out the addresses, gives each jail a link of its own and is the router, so jails cannot see or impersonate each other.
Read the article: Networks the host controlsBack up volumes once
One copy of a volume, however many jails use it. Leave volumes out when you want to, bring them back with the jail.
Read the article: Back up volumes onceA private Docker registry
A registry of your own with users in a file: one jail, docker-registry and docker-auth, htpasswd for the passwords, the images on a volume.
Read the article: A private Docker registryNames for jails
A jail is reached by its name inside its project: db.shop.internal, or just db. Create a jail and its name is there; delete it and the name is gone.
Read the article: Names for jails
Try it on one server.
Try the console from the screenshots, install on a clean FreeBSD 15.1 machine, or add JailOps to a host you already run.