BastilleBSD_bastille/docs/chapters/targeting.rst

Targeting
=========

Bastille uses a ``subcommand TARGET ARGS`` syntax, meaning that each command
requires a target. Targets are usually jails, but can also be releases.

Targeting a jail is done by providing the exact jail name, the JID of the
jail, a tag, or by typing the starting few characters of a jail.

If you use a tag as the TARGET, Bastille will target any and all jails that have
that tag assigned. If you have a jail with the same name as the tag you are trying to
target, Bastille will target the jail, and not the tag.

Targeting a release is done by providing the exact release name. (Note: do not
include the ``-pX`` point-release version.)

Bastille includes a pre-defined keyword of [ALL|all] to target all running
jails. It is also possible to target multiple jails by grouping them in
quotes, as seen below.

.. code-block:: shell

  ishmael ~ # bastille cmd "jail1 jail2 jail3" echo Hello!

Priority
--------

The priority value determines in what order commands are executed if multiple
jails are targetted, including the [ALL|all] target.

It also controls in what order jails are started and stopped on system startup
and shutdown. This requires Bastille to be enabled with ``sysrc bastille_enable=YES``.
Jails will start in order starting at the lowest value, and will stop in order
starting at the highest value. So, jails with a priority value of 1 will start
first, and stop last.

When jails are created with Bastille, this value defaults to ``99``, but can be
overridden with ``-p|--priority VALUE`` on creation.
See ``bastille create --priority 90 TARGET...``.

This value can be changed using ``bastille config TARGET set priority VALUE``.

This value will be shown using ``bastille list all``.

Examples: Jails
---------------

.. code-block:: shell

  ishmael ~ # bastille ...

+-----------+--------+------------------+-------------------------------------------------------------+
| command   | target | args             | description                                                 |
+===========+========+==================+=============================================================+
| cmd       | ALL    | 'sockstat -4'    | execute `sockstat -4` in ALL jails (ip4 sockets)            |
+-----------+--------+-----+------------+-------------------------------------------------------------+
| console   | mariadb02    | ---        | console (shell) access to mariadb02                         |
+----+------+--------+-----+------------+-------------------------------------------------------------+
| pkg       | web01  | 'install nginx'  | install nginx package in web01 jail                         |
+-----------+--------+------------------+-------------------------------------------------------------+
| pkg       | ALL    | upgrade          | upgrade packages in ALL jails                               |
+-----------+--------+------------------+-------------------------------------------------------------+
| pkg       | ALL    | audit            | (CVE) audit packages in ALL jails                           |
+-----------+--------+------------------+-------------------------------------------------------------+
| sysrc     | web01  | nginx_enable=YES | execute `sysrc nginx_enable=YES` in web01 jail              |
+-----------+--------+------------------+-------------------------------------------------------------+
| template  | ALL    | username/base    | apply `username/base` template to ALL jails                 |
+-----------+--------+------------------+-------------------------------------------------------------+
| start     | web02  | ---              | start web02 jail                                            |
+----+------+----+---+------------------+--------------+----------------------------------------------+
| cp | bastion03 | /tmp/resolv.conf-cf etc/resolv.conf | copy host-path to jail-path in bastion03     |
+----+------+----+---+---------------------------------+----------------------------------------------+
| create    | folsom | 13.2-RELEASE 10.17.89.10        | create 13.2 jail named `folsom` with IP      |
+-----------+--------+---------------------------------+----------------------------------------------+


Examples: Releases
------------------

.. code-block:: shell

  ishmael ~ # bastille ...

+-----------+--------------+--------------+------------------------------------+
| command   | target       | args         | description                        |
+===========+==============+==============+====================================+
| bootstrap | 13.2-RELEASE | ---          | bootstrap 13.2-RELEASE release     |
+-----------+--------------+--------------+------------------------------------+
| update    | 12.4-RELEASE | ---          | update 12.4-RELEASE release        |
+-----------+--------------+--------------+------------------------------------+
| verify    | 12.4-RELEASE | ---          | verify 12.4-RELEASE release        |
+-----------+--------------+--------------+------------------------------------+