[libvirt-ci PATCH 13/13] guests: README: Document the existence and usage of config.toml
Signed-off-by: Erik Skultety <eskultet(a)redhat.com>
---
guests/README.markdown | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
diff --git a/guests/README.markdown b/guests/README.markdown
index 7dbefed..d9afbd3 100644
--- a/guests/README.markdown
+++ b/guests/README.markdown
@@ -64,13 +64,16 @@ branches out of those with
Host setup
----------
-Ansible and `virt-install` need to be available on the host.
+`ansible`, `python3-toml` and `virt-install` need to be available on the host,
+the former two can be either installed system-wide using your package manager
+or using by `pip` (see the provided requirements.txt file). The latter can only
+be installed with your package manager as `virt-install` is not distributed via
+PyPi.
-Before you can start bringing up guests, you'll have to store your
-site-specific root password in the `~/.config/lcitool/root-password` file.
-This password will only be necessary for serial console access in case
-something goes horribly wrong; for day to day operations, SSH key
-authentication will be used instead.
+Before you can start bringing up guests, you need to create (ideally by
+copying the `config.toml` template) ~/.config/lcitool/config.toml and set at
+least the options marked as "(mandatory)" depending on the flavor (`test`,
+`jenkins`, `gitlab`) you wish to use with your machines.
Ansible expects to be able to connect to the guests by name: installing and
enabling the [libvirt NSS plugin](https://wiki.libvirt.org/page/NSS_module)
@@ -123,8 +126,8 @@ Jenkins CI use
--------------
You'll need to configure `lcitool` to use the `jenkins` flavor for
-guests: to do so, just write `jenkins` in the `~/.config/lcitool/flavor`
-file.
+guests. To do so, simply set the flavor to 'jenkins' in
+`~/.config/lcitool/config.toml`.
Once a guest has been prepared, you'll be able to log in as root either
via SSH (your public key will have been authorized) or on the serial
--
2.25.3