Skip to content

Runroot: Update doc according to the storage.config change #4238

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

Merged
dragon512 merged 1 commit into from
Sep 13, 2018
Merged

Runroot: Update doc according to the storage.config change #4238

Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions doc/admin-guide/files/storage.config.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,3 +184,10 @@ following rules are stored in :manpage:`devfs.conf(5)`::

# Assign /dev/ada1 and /dev/ada2 to the tserver user
own ada[12] tserver:tserver

Advanced
--------

Because relative paths in :file:`storage.config` are relative to the base prefix, when using customized runroot
it may be necessary to adjust such paths in :file:`storage.config` or adjust ``runroot_path.yml`` itself.
Despite the name, the cachedir value is not used for this file.
9 changes: 9 additions & 0 deletions doc/appendices/command-line/traffic_layout.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,11 @@ Below is an example of customized yaml file (custom.yml) to construct. ::

If ``traffic_layout init --layout="custom.yml"`` is executed, a runroot following the format above will be created.

.. Note::

:file:`storage.config` does not use the cachedir value, but makes its relatives paths relative to the base prefix.
So please update the directory for cache in ``storage.config`` according to the customized runroot.

remove
------
Find the sandbox to remove in following order:
Expand Down Expand Up @@ -138,6 +143,10 @@ Options

Print usage information and exit.

.. option:: --path

Specify the path of runroot for commands (init, remove, verify).

init
----
.. option:: --force
Expand Down