diff --git a/docs/chapters/boot-and-priority.rst b/docs/chapters/boot-and-priority.rst deleted file mode 100644 index 713170aa..00000000 --- a/docs/chapters/boot-and-priority.rst +++ /dev/null @@ -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``. diff --git a/docs/chapters/startup-configuration.rst b/docs/chapters/startup-configuration.rst new file mode 100644 index 00000000..fbb00e70 --- /dev/null +++ b/docs/chapters/startup-configuration.rst @@ -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. \ No newline at end of file diff --git a/docs/chapters/subcommands/restart.rst b/docs/chapters/subcommands/restart.rst index fe78b3ae..3f3e5cdf 100644 --- a/docs/chapters/subcommands/restart.rst +++ b/docs/chapters/subcommands/restart.rst @@ -19,6 +19,6 @@ Restart jail(s). Options: -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. -x | --debug Enable debug mode. diff --git a/docs/chapters/subcommands/start.rst b/docs/chapters/subcommands/start.rst index 54be65bc..fa673cd1 100644 --- a/docs/chapters/subcommands/start.rst +++ b/docs/chapters/subcommands/start.rst @@ -16,6 +16,6 @@ Start jail(s). Options: -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. -x | --debug Enable debug mode. diff --git a/docs/chapters/subcommands/stop.rst b/docs/chapters/subcommands/stop.rst index 4a9ff050..1b993718 100644 --- a/docs/chapters/subcommands/stop.rst +++ b/docs/chapters/subcommands/stop.rst @@ -16,6 +16,5 @@ Stop jail(s). Options: -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. -x | --debug Enable debug mode. diff --git a/docs/chapters/targeting.rst b/docs/chapters/targeting.rst index 4073e377..e6d7b220 100644 --- a/docs/chapters/targeting.rst +++ b/docs/chapters/targeting.rst @@ -67,3 +67,19 @@ Examples: Releases +-----------+--------------+--------------+------------------------------------+ | 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``. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 29611ede..96367100 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,11 +14,10 @@ https://docs.bastillebsd.org. chapters/installation chapters/gettingstarted chapters/configuration - chapters/boot-and-priority - chapters/upgrading + chapters/targeting + chapters/startup-configuration chapters/networking chapters/usage - chapters/targeting chapters/upgrading chapters/subcommands/index chapters/template diff --git a/usr/local/share/bastille/restart.sh b/usr/local/share/bastille/restart.sh index 895313f5..789a5cf3 100644 --- a/usr/local/share/bastille/restart.sh +++ b/usr/local/share/bastille/restart.sh @@ -36,7 +36,7 @@ usage() { Options: -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. -x | --debug Enable debug mode. diff --git a/usr/local/share/bastille/start.sh b/usr/local/share/bastille/start.sh index 93413eb2..8514bba8 100644 --- a/usr/local/share/bastille/start.sh +++ b/usr/local/share/bastille/start.sh @@ -38,7 +38,7 @@ usage() { Options: -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. -x | --debug Enable debug mode. diff --git a/usr/local/share/bastille/stop.sh b/usr/local/share/bastille/stop.sh index fa84d00b..e4728f8a 100644 --- a/usr/local/share/bastille/stop.sh +++ b/usr/local/share/bastille/stop.sh @@ -38,7 +38,6 @@ usage() { Options: -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. -x | --debug Enable debug mode.