mirror of
https://github.com/hackacad/bastille.git
synced 2025-12-20 17:20:12 +01:00
docs: Reorder boot and priority + minor fixes
This commit is contained in:
@@ -1,46 +0,0 @@
|
|||||||
Boot and Priority
|
|
||||||
=================
|
|
||||||
|
|
||||||
Boot
|
|
||||||
----
|
|
||||||
|
|
||||||
The boot setting controls whether a jail will be started on system startup. If
|
|
||||||
you have enabled bastille with ``sysrc bastille_enable=YES``, all jails with
|
|
||||||
``boot=on`` will start on system startup. Any jail(s) with ``boot=off`` will not
|
|
||||||
be started on system startup.
|
|
||||||
|
|
||||||
You can also use ``bastille start --boot TARGET`` to make Bastille respect the
|
|
||||||
boot setting. If ``-b|--boot`` is not used, the targeted jail(s) will start,
|
|
||||||
regardless of the boot setting.
|
|
||||||
|
|
||||||
Jails will still shut down on system shutdown, regardless of this setting.
|
|
||||||
|
|
||||||
The ``-b|--boot`` can also be used with the ``stop`` command. Any jails with
|
|
||||||
``boot=off`` will not be touched if ``stop`` is called with ``-b|--boot``. Same
|
|
||||||
goes for the ``restart`` command.
|
|
||||||
|
|
||||||
When jails are created with Bastille, the boot setting is set to ``on`` by
|
|
||||||
default. This can be overridden using the ``--no-boot`` flag. See ``bastille
|
|
||||||
create --no-boot TARGET...``.
|
|
||||||
|
|
||||||
This value can be changed using ``bastille config TARGET boot [on|off]``.
|
|
||||||
|
|
||||||
This value will be shown using ``bastille list all``.
|
|
||||||
|
|
||||||
Priority
|
|
||||||
--------
|
|
||||||
|
|
||||||
The priority value determines in what order commands are executed if multiple
|
|
||||||
jails are targetted. This 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 priority VALUE``.
|
|
||||||
|
|
||||||
This value will be shown using ``bastille list all``.
|
|
||||||
44
docs/chapters/startup-configuration.rst
Normal file
44
docs/chapters/startup-configuration.rst
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
Startup Configuration
|
||||||
|
=====================
|
||||||
|
|
||||||
|
Bastille can start jails on system startup, and stop them on system shutdown. To enable this functionality, we
|
||||||
|
must first enable Bastille as a service using ``sysrc bastille_enable=YES``. Once you reboot your host, all jails
|
||||||
|
with ``boot=on`` will be started when the host boots.
|
||||||
|
|
||||||
|
If you have certain jails that must be started before other jails, you can use the priority option. 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.
|
||||||
|
|
||||||
|
See the chapter on targeting for more info.
|
||||||
|
|
||||||
|
Boot
|
||||||
|
----
|
||||||
|
|
||||||
|
The boot setting controls whether a jail will be started on system startup. If you have enabled bastille
|
||||||
|
with ``sysrc bastille_enable=YES``, all jails with ``boot=on`` will start on system startup. Any jail(s)
|
||||||
|
with ``boot=off`` will not be started on system startup.
|
||||||
|
|
||||||
|
By default, when jails are created with Bastille, the boot setting is set to ``on`` by default. This can be overridden using
|
||||||
|
the ``--no-boot`` flag. See ``bastille create --no-boot TARGET...``.
|
||||||
|
|
||||||
|
You can also use ``bastille start --boot TARGET`` to make Bastille respect the boot setting. If ``-b|--boot`` is not
|
||||||
|
used, the targeted jail(s) will start, regardless of the boot setting.
|
||||||
|
|
||||||
|
Jails will still shut down on system shutdown, regardless of this setting.
|
||||||
|
|
||||||
|
The ``-b|--boot`` can also be used with the ``stop`` command. Any jails with ``boot=off`` will
|
||||||
|
not be touched if ``stop`` is called with ``-b|--boot``. Same goes for the ``restart`` command.
|
||||||
|
|
||||||
|
This value can be changed using ``bastille config TARGET boot [on|off]``.
|
||||||
|
|
||||||
|
This value will be shown using ``bastille list all``.
|
||||||
|
|
||||||
|
Startup Delay
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Sometimes it is necessary to let a jail start fully before continuing to the next jail.
|
||||||
|
|
||||||
|
We can do this with another sysrc value called ``bastille_startup_delay``. Setting ``bastille_startup_delay=5`` will
|
||||||
|
tell Bastille to wait 5 seconds between starting each jail.
|
||||||
|
|
||||||
|
You can also use ``bastille start -d|--delay 5 all`` or ``bastille restart -d|--delay 5 all`` to achieve the same thing.
|
||||||
@@ -19,6 +19,6 @@ Restart jail(s).
|
|||||||
Options:
|
Options:
|
||||||
|
|
||||||
-b | --boot Respect jail boot setting.
|
-b | --boot Respect jail boot setting.
|
||||||
-d | --delay VALUE Time (seconds) to wait after starting/stopping jail(s).
|
-d | --delay VALUE Time (seconds) to wait after starting each jail.
|
||||||
-v | --verbose Print every action on jail start.
|
-v | --verbose Print every action on jail start.
|
||||||
-x | --debug Enable debug mode.
|
-x | --debug Enable debug mode.
|
||||||
|
|||||||
@@ -16,6 +16,6 @@ Start jail(s).
|
|||||||
Options:
|
Options:
|
||||||
|
|
||||||
-b | --boot Respect jail boot setting.
|
-b | --boot Respect jail boot setting.
|
||||||
-d | --delay VALUE Time (seconds) to wait after starting jail(s).
|
-d | --delay VALUE Time (seconds) to wait after starting each jail.
|
||||||
-v | --verbose Print every action on jail start.
|
-v | --verbose Print every action on jail start.
|
||||||
-x | --debug Enable debug mode.
|
-x | --debug Enable debug mode.
|
||||||
|
|||||||
@@ -16,6 +16,5 @@ Stop jail(s).
|
|||||||
Options:
|
Options:
|
||||||
|
|
||||||
-b | --boot Respect jail boot setting.
|
-b | --boot Respect jail boot setting.
|
||||||
-d | --delay VALUE Time (seconds) to wait after stopping jail(s).
|
|
||||||
-v | --verbose Print every action on jail stop.
|
-v | --verbose Print every action on jail stop.
|
||||||
-x | --debug Enable debug mode.
|
-x | --debug Enable debug mode.
|
||||||
|
|||||||
@@ -67,3 +67,19 @@ Examples: Releases
|
|||||||
+-----------+--------------+--------------+------------------------------------+
|
+-----------+--------------+--------------+------------------------------------+
|
||||||
| verify | 12.4-RELEASE | --- | verify 12.4-RELEASE release |
|
| verify | 12.4-RELEASE | --- | verify 12.4-RELEASE release |
|
||||||
+-----------+--------------+--------------+------------------------------------+
|
+-----------+--------------+--------------+------------------------------------+
|
||||||
|
|
||||||
|
Priority
|
||||||
|
--------
|
||||||
|
|
||||||
|
The priority value determines in what order commands are executed if multiple jails are targetted, including the 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 priority VALUE``.
|
||||||
|
|
||||||
|
This value will be shown using ``bastille list all``.
|
||||||
@@ -14,11 +14,10 @@ https://docs.bastillebsd.org.
|
|||||||
chapters/installation
|
chapters/installation
|
||||||
chapters/gettingstarted
|
chapters/gettingstarted
|
||||||
chapters/configuration
|
chapters/configuration
|
||||||
chapters/boot-and-priority
|
chapters/targeting
|
||||||
chapters/upgrading
|
chapters/startup-configuration
|
||||||
chapters/networking
|
chapters/networking
|
||||||
chapters/usage
|
chapters/usage
|
||||||
chapters/targeting
|
|
||||||
chapters/upgrading
|
chapters/upgrading
|
||||||
chapters/subcommands/index
|
chapters/subcommands/index
|
||||||
chapters/template
|
chapters/template
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ usage() {
|
|||||||
Options:
|
Options:
|
||||||
|
|
||||||
-b | --boot Respect jail boot setting.
|
-b | --boot Respect jail boot setting.
|
||||||
-d | --delay VALUE Time (seconds) to wait after starting/stopping jail(s).
|
-d | --delay VALUE Time (seconds) to wait after starting each jail.
|
||||||
-v | --verbose Print every action on jail start.
|
-v | --verbose Print every action on jail start.
|
||||||
-x | --debug Enable debug mode.
|
-x | --debug Enable debug mode.
|
||||||
|
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ usage() {
|
|||||||
Options:
|
Options:
|
||||||
|
|
||||||
-b | --boot Respect jail boot setting.
|
-b | --boot Respect jail boot setting.
|
||||||
-d | --delay VALUE Time (seconds) to wait after starting jail(s).
|
-d | --delay VALUE Time (seconds) to wait after starting each jail.
|
||||||
-v | --verbose Print every action on jail start.
|
-v | --verbose Print every action on jail start.
|
||||||
-x | --debug Enable debug mode.
|
-x | --debug Enable debug mode.
|
||||||
|
|
||||||
|
|||||||
@@ -38,7 +38,6 @@ usage() {
|
|||||||
Options:
|
Options:
|
||||||
|
|
||||||
-b | --boot Respect jail boot setting.
|
-b | --boot Respect jail boot setting.
|
||||||
-d | --delay VALUE Time (seconds) to wait after stopping jail(s).
|
|
||||||
-v | --verbose Print every action on jail stop.
|
-v | --verbose Print every action on jail stop.
|
||||||
-x | --debug Enable debug mode.
|
-x | --debug Enable debug mode.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user