Merge pull request #862 from tschettervictor/master

docs: Document -c for destroy
This commit is contained in:
tschettervictor
2025-02-23 09:44:57 -07:00
committed by GitHub
2 changed files with 16 additions and 13 deletions

View File

@@ -2,26 +2,29 @@
destroy
=======
Containers can be destroyed and thrown away just as easily as they were
created. Note: containers must be stopped before destroyed.
Jails can be destroyed and thrown away just as easily as they were
created. Note: containers must be stopped before destroyed. Using
the `-a|--auto` option will automatically stop the jail before destroying it.
.. code-block:: shell
ishmael ~ # bastille stop folsom
ishmael ~ # bastille destroy -a folsom
[folsom]:
folsom: removed
.. code-block:: shell
ishmael ~ # bastille destroy folsom
Deleting Container: folsom.
Note: containers console logs not destroyed.
/usr/local/bastille/logs/folsom_console.log
Release can be destroyed provided there are no child jails. The `force` option
deletes the release cache directory as well:
Release can be destroyed provided there are no child jails. The `-c|--no-cache` option
will retain the releas cache directory, if you choose to keep it.
.. code-block:: shell
ishmael ~ # bastille destroy force 14.0-RELEASE
Deleting base: 14.0-RELEASE
ishmael ~ # bastille destroy help
Usage: bastille destroy [option(s)] [JAIL|RELEASE]
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-f | --force Force unmount any mounted datasets when destroying a jail or release (ZFS only).
-c | --no-cache Do no destroy cache when destroying a release.
-x | --debug Enable debug mode.

View File

@@ -95,6 +95,6 @@ After upgrading all jails from one release to the next you may find that you now
`bastille list releases` to list all bootstrapped releases.
`bastille destroy X.Y-RELEASE` to fully delete the release.
`bastille destroy X.Y-RELEASE` to fully delete the release, including the cache.
`bastille destroy [-f|--force] X.Y-RELEASE` to delete the cache directory as well.
`bastille destroy [-c|--no-cache] X.Y-RELEASE` to retain the cache directory.