Mirrors/hackacad
2
0
Fork 0
mirror of https://github.com/hackacad/bastille.git synced 2025-12-24 19:22:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #860 from tschettervictor/doc-updates

Browse Source 
More Doc updates
This commit is contained in:
tschettervictor
2025-02-20 12:49:12 -07:00
committed by GitHub
parent 779e7b7ce7 63c008b25e
commit 1cb4513622
4 changed files with 40 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/chapters/subcommands/update.rst
View File

@@ -2,8 +2,8 @@
update
======
The `update` command targets a release instead of a container. Because every container is
based on a release, when the release is updated all the containers are automatically
The `update` command targets a release or a thick jail. Because thin jails are
based on a release, when the release is updated all the thin jails are automatically
updated as well.
If no updates are available, a message will be shown:
@@ -20,8 +20,7 @@ If no updates are available, a message will be shown:
No updates needed to update system to 11.4-RELEASE-p4.
No updates are available to install.
The older the release, however, the more updates will be available:
The older the release or jail, however, the more updates will be available:
.. code-block:: shell
@@ -38,4 +37,7 @@ The older the release, however, the more updates will be available:
The following files will be added as part of updating to 13.2-RELEASE-p4:
...[snip]...
To be safe, you may want to restart any containers that have been updated live.
To be safe, you may want to restart any jails that have been updated live.
If the jail is a thin jail, an error will be shown. If it is a thick jail, it will be updated just like
the release shown above.

16
docs/chapters/subcommands/upgrade.rst Normal file
View File

@@ -0,0 +1,16 @@
=======
upgrade
=======
The `upgrade` command targets a thick or thin jail. Thin jails will be updated by changing the
release mount point that it is based on. Thick jails will be upgraded normally.
.. code-block:: shell
ishmael ~ # bastille upgrade help
Usage: bastille upgrade [option(s)] TARGET [NEWRELEASE|install]
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-f | --force Force upgrade a jail.
-x | --debug Enable debug mode.

9
docs/chapters/template.rst
View File

@@ -60,6 +60,15 @@ Template Hook Descriptions
ARG - set an ARG value to be used in the template
ARGS will default to the value set inside the template, but can be changed by including `--arg ARG=VALUE` when
running the template. Multiple ARGS can also be specified as seen below. If no ARG value is given, the template
will show a warning, but will still continue.
.. code-block:: shell
ishmael ~ # bastille template azkaban sample/template --arg ARG=VALUE --arg ARG1=VALUE
CMD - run the specified command
CONFIG - set the specified property and value

8
docs/chapters/upgrading.rst
View File

@@ -9,6 +9,10 @@ To keep releases updated, use `bastille update RELEASE`
To keep thick jails updated, use `bastille update TARGET`
======================
Minor Release Upgrades
======================
To upgrade Bastille jails for a minor release (ie; 13.1→13.2) you can do the following:
Thick Jails
@@ -35,6 +39,10 @@ Thin Jails
8. start the jail(s)
8. upgrade complete!
======================
Major Release Upgrades
======================
To upgrade Bastille jails for a major release (ie; 12.4→13.2) you can do the following:
Thick Jails