[libvirt] [libvirt-jenkins-ci PATCH 6/6] guests: Update documentation
Signed-off-by: Andrea Bolognani <abologna(a)redhat.com>
---
guests/README.markdown | 45 ++++++++++++++++++++++++---------------------
1 file changed, 24 insertions(+), 21 deletions(-)
diff --git a/guests/README.markdown b/guests/README.markdown
index 100ca31..51d9012 100644
--- a/guests/README.markdown
+++ b/guests/README.markdown
@@ -11,8 +11,7 @@ There are two steps to bringing up a guest:
section below;
* `./lcitool prepare $guest` will go through all the post-installation
- configuration steps required to make the newly-created guest usable as
- part of the Jenkins CI setup.
+ configuration steps required to make the newly-created guest usable;
Once those steps have been performed, maintainance will involve running:
@@ -46,14 +45,6 @@ along the lines of
in your crontab.
-Adding new guests
------------------
-
-Adding new guests will require tweaking the inventory and host variables,
-but it should be very easy to eg. use the Fedora 26 configuration to come
-up with a working Fedora 27 configuration.
-
-
Development use
---------------
@@ -61,22 +52,26 @@ If you are a developer trying to reproduce a bug on some OS you
don't
have easy access to, you can use these tools to create a suitable test
environment.
-Since the tools are intended mainly for CI use, you'll have to tweak them
-a bit first, including:
+The `developer` flavor is used by default, so you don't need to do
+anything special in order to use it: just follow the steps outlined
+above. Once a guest has been prepared, you'll be able to log in as
+`developer` either via SSH (your public key will have been authorized)
+or on the serial console (password: `developer`).
-* trimming down the `inventory` file to just the guest you're interested in;
+Once logged in, you'll be able to perform administrative tasks using
+`sudo`. Regular root access will still be available, either through
+SSH or on the serial console.
-* removing any references to the `jenkins` pseudo-project from
- `host_vars/$guest/main.yml`, along with any references to projects you're
- not interested to (this will cut down on the number of packages installed)
- and any references to `jenkins_secret`;
-* deleting `host_vars/$guest/vault.yml` altogether.
+CI use
+------
-After performing these tweaks, you should be able to use the same steps
-outlined above.
+You'll need to configure `lcitool` to use the `ci` flavor for guests:
+to do so, just write `ci` in the `~/.config/lcitool/flavor` file.
-A better way to deal with this use case will be provided in the future.
+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
+console (using the password configured earlier).
FreeBSD
@@ -95,3 +90,11 @@ Some manual tweaking will be needed, in particular:
Once these steps have been performed, FreeBSD guests can be managed just
like all other guests.
+
+
+Adding new guests
+-----------------
+
+Adding new guests will require tweaking the inventory and host variables,
+but it should be very easy to eg. use the Fedora 26 configuration to come
+up with a working Fedora 27 configuration.
--
2.13.6