Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More Doc updates #860

Merged
merged 4 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/chapters/subcommands/update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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

Expand All @@ -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 changes: 16 additions & 0 deletions docs/chapters/subcommands/upgrade.rst
Original file line number Diff line number Diff line change
@@ -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 changes: 9 additions & 0 deletions docs/chapters/template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/chapters/upgrading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down