Update README with repl basic documentation
This commit is contained in:
parent
9d383e3fd9
commit
a6ba43c838
1 changed files with 13 additions and 1 deletions
14
README.md
14
README.md
|
@ -7,7 +7,8 @@ A network of LXC containers, managed through libvirt
|
||||||
This script will most probably break on any other system than Linux, and will
|
This script will most probably break on any other system than Linux, and will
|
||||||
definitely break on anything non-UNIX.
|
definitely break on anything non-UNIX.
|
||||||
|
|
||||||
It relies on `libvirt` and `overlayfs`.
|
It relies on `libvirt`, `overlayfs` and `sudo` (to gain the required privileges
|
||||||
|
to use overlayfs).
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
|
@ -43,6 +44,17 @@ You can spawn a network using
|
||||||
where `topology_description.yml` is a valid topology description file (see
|
where `topology_description.yml` is a valid topology description file (see
|
||||||
below).
|
below).
|
||||||
|
|
||||||
|
When the network is spawned, you will get a (very basic) prompt. The available
|
||||||
|
commands are:
|
||||||
|
|
||||||
|
* `help`: display a list of available commands;
|
||||||
|
* `exit`: cleanup the network and quit the program;
|
||||||
|
* `dom`:
|
||||||
|
* `dom down`: keep the networks up, but cleanup the containers. Useful to
|
||||||
|
reset the containers or update binaries and settings.
|
||||||
|
* `dom up`: spawn the containers, if they were cleaned up beforehand.
|
||||||
|
* `dom restart`: equivalent to `dom down ; dom up`.
|
||||||
|
|
||||||
## Topology description file
|
## Topology description file
|
||||||
|
|
||||||
A topology is described in a [YAML](https://en.wikipedia.org/wiki/YAML) file
|
A topology is described in a [YAML](https://en.wikipedia.org/wiki/YAML) file
|
||||||
|
|
Loading…
Reference in a new issue