Tab completion for jailops
Shell completion for the jailops command on FreeBSD: what Tab completes (commands, flags, and the names of jails, images, networks, projects and firewall policies from the server), how to install it for bash, zsh and fish, and how to turn it on.
What it completes
More than command names.
Commands and flags complete on their own, offline. The names come from the server you are connected to, so Tab offers what exists:
- Jails:
jailops start,stop,shell,exec,info,configand every other command that takes a jail. - Configuration keys: after the jail in
jailops config set JAIL, the keys of that jail (boot.autostart,limits.memoryand so on), and afterfirewall.policiesthe names of the firewall policies, also in a comma separated list. - Flags that name something:
--image,--network,--storage,--profile,--dependsand--firewall-policyoffer the images, networks, storage grants, profiles, jails and firewall policies of the project. - Access: in
jailops app allow APP --fromit completes the app and the source: the kindsjail:,set:andhost, then the jails or the address sets of the project. - References: wherever a firewall rule, an address set,
firewall testorapp allowtakes one (--from,--to,--address), Tab offers the kindsjail:,set:,tag:andany, and after a kind the names that exist in the project. Rules have their own words too:jailops firewall rule add web in --actionoffersallowanddeny, andrule remove weblists the rules of the policy with their comments. - Projects, backups and operations by name.
When no server answers, the shell gets no names and no error. Nothing is slow and nothing breaks: you type the name yourself.
Bash on FreeBSD
Two packages and one line.
The client package installs the completion script where bash-completion looks for it, /usr/local/share/bash-completion/completions/jailops. Bash itself does not load it until the bash-completion package is installed and its script is sourced from your .bashrc. FreeBSD's default shell is not bash, so install it and, if you want it for your login, make it your shell:
# pkg install bash bash-completion # chsh -s /usr/local/bin/bash youruser
Then add the line that the bash-completion package prints to the .bashrc of that user:
[[ $PS1 && -f /usr/local/share/bash-completion/bash_completion.sh ]] && \
source /usr/local/share/bash-completion/bash_completion.shOpen a new shell and try it: jailops st and Tab. If a jail name does not complete, the shell is not connected to a server (check with jailops list), not a problem with completion.
zsh and fish
Little to do.
- zsh: the package installs
/usr/local/share/zsh/site-functions/_jailops. It works oncecompinitis on:autoload -U compinit && compinitin~/.zshrc. - fish: finds it by itself, from
/usr/local/share/fish/vendor_completions.d/.
A binary installed by hand
The command prints the script.
Without the package, for example a binary from the release archives or from just build-freebsd, the command prints the script for each shell:
$ source <(jailops completion bash) $ jailops completion zsh > "${fpath[1]}/_jailops" $ jailops completion fish > ~/.config/fish/completions/jailops.fish
For bash you can also save the output as /usr/local/share/bash-completion/completions/jailops instead of sourcing it in every shell.
Other hosts
It follows the remote you are on.
The names are asked of the server the command would talk to: the local socket on the host, or the remote you chose on a workstation. With a client on your laptop that talks to a host, jailops start and Tab lists the jails of that host's project, which is the quickest way to see what is there before you type anything. jailops-sync has its completion too.
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 jailTest 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 controlsVolumes: data that outlives a jail
Keep the data in a volume and the jail disposable. One volume can be attached to several jails, has its own snapshots and its own backup.
Read the article: Volumes: data that outlives a jailBack 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.