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.

Sign up for GitHub

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

Update zfs-support.rst #685

Closed
wants to merge 1 commit into from
Closed

Update zfs-support.rst #685

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion docs/chapters/zfs-support.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Two values are required for Bastille to use ZFS. The default values in the ``bas
bastille_zfs_enable="" ## default: ""
bastille_zfs_zpool="" ## default: ""
bastille_zfs_prefix="bastille" ## default: "${bastille_zfs_zpool}/bastille"
bastille_prefix="/bastille" ## default: "/usr/local/bastille". ${bastille_zfs_prefix} gets mounted here
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is OK since it needs to be on par with the Bastille config sample.

bastille_zfs_options="-o compress=lz4 -o atime=off" ## default: "-o compress=lz4 -o atime=off"

Example
Expand All @@ -26,3 +25,8 @@ Example

Replace ``ZPOOL_NAME`` with the zpool you want Bastille to use. Tip: ``zpool list`` and ``zpool status`` will help.
If you get 'no pools available' you are likely not using ZFS and can safely ignore these settings.

If you are going to use a zpool other than zroot (eg. ``tank``) you must also edit the ``bastille_prefix`` (at the top of the ``bastille.conf`` file) to specify the path to the zpool.

Example
If you choose to run bastille on a pool you have created called ``tank`` you must set ``bastille_prefix=/tank/bastille`` otherwise it will try to use the default ``/usr/local/bastille`` prefix, causing issues with trying to create your containers on your speicified zpool.
Comment on lines +29 to +32
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why we should add this since there is the bastille_zfs_zpool configuration option?

That said, the bastille.conf.sample needs a patch here:

bastille/usr/local/etc/bastille/bastille.conf.sample

Line 44 in c7f46c3

bastille_zfs_prefix="bastille" ## default: "${bastille_zfs_zpool}/bastille"

Note that it says a default value in the comment, but it's not used in the configuration option, so that should be root cause of the described behavior in your PR, could be a bug rather than doing what you describe.