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

docs: Add etcupdate.rst #856

Merged
Merged
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
46 changes: 46 additions & 0 deletions docs/chapters/subcommands/etcupdate.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
=========
etcupdate
=========

This command will update the contents of `/etc` inside a jail. It should be run after a jail upgrade

First we need to bootstrap a release for `etcupdate` to use.

.. code-block:: shell

ishmael ~ # bastille etcupdate bootstrap 14.1-RELEASE
bastille_bootstrap_archives: base -> src
/usr/local/bastille/cache/14.1-RELEASE/MANIFES 1046 B 1134 kBps 00s
/usr/local/bastille/cache/14.1-RELEASE/src.txz 205 MB 2711 kBps 01m18s
bastille_bootstrap_archives: src -> base
Building tarball, please wait...
Etcupdate bootstrap complete: 14.1-RELEASE

Next we can use the `update` command to apply the update to the jail.

.. code-block:: shell

ishmael ~ # bastille etcupdate ishmael update 14.1-RELEASE

The output will show you which files were added, updated, changed, deleted, or have conflicts.
To automatically resolve the conflicts, run the `resolve` command.

.. code-block:: shell

ishmael ~ # bastille etcupdate ishmael resolve

To show only the differences between the releases, use the `diff` command.

.. code-block:: shell

ishmael ~ # bastille etcupdate ishmael diff 14.1-RELEASE

.. code-block:: shell

ishmael ~ # bastille etcupdate help
Usage: bastille etcupdate [option(s)] [bootstrap|TARGET] [diff|resolve|update RELEASE]
Options:

-d | --dry-run Show output, but do not apply.
-f | --force Force a re-bootstrap of a RELEASE.
-x | --debug Enable debug mode.