From nobody Mon Feb 9 06:48:26 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1532017963735441.729627736411; Thu, 19 Jul 2018 09:32:43 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 64F77C04B948; Thu, 19 Jul 2018 16:32:42 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 1B74C60172; Thu, 19 Jul 2018 16:32:42 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id BB52D14B14; Thu, 19 Jul 2018 16:32:41 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id w6JGWKdp003759 for ; Thu, 19 Jul 2018 12:32:20 -0400 Received: by smtp.corp.redhat.com (Postfix) id 7A1651C5B7; Thu, 19 Jul 2018 16:32:20 +0000 (UTC) Received: from inaba.usersys.redhat.com (unknown [10.43.2.44]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 1B9E31C5B8 for ; Thu, 19 Jul 2018 16:32:19 +0000 (UTC) From: Andrea Bolognani To: libvir-list@redhat.com Date: Thu, 19 Jul 2018 18:32:08 +0200 Message-Id: <20180719163208.23126-9-abologna@redhat.com> In-Reply-To: <20180719163208.23126-1-abologna@redhat.com> References: <20180719163208.23126-1-abologna@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 X-loop: libvir-list@redhat.com Subject: [libvirt] [jenkins-ci PATCH 8/8] guests: Update documentation X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Thu, 19 Jul 2018 16:32:43 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" The usage has once again changed slightly; additionally, a few concrete examples are now provided. Signed-off-by: Andrea Bolognani Reviewed-by: Erik Skultety --- guests/README.markdown | 38 ++++++++++++++++++++++++++++++++------ 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/guests/README.markdown b/guests/README.markdown index 4a40619..ddf0149 100644 --- a/guests/README.markdown +++ b/guests/README.markdown @@ -4,22 +4,48 @@ libvirt CI - guest management tools The tools contained in this directory simplify and automate the management of the guests used by the Jenkins-based libvirt CI environment. =20 + +Usage and examples +------------------ + There are two steps to bringing up a guest: =20 -* `./lcitool -a install -h $guest` will perform an unattended installation +* `lcitool -a install -h $guest` will perform an unattended installation of `$guest`. Not all guests can be installed this way: see the "FreeBSD" section below; =20 -* `./lcitool -a update -h $guest` will go through all the post-installation - configuration steps required to make the newly-created guest usable; +* `lcitool -a update -h $guest -p $project` will go through all the + post-installation configuration steps required to make the newly-created + guest usable and ready to be used for building `$project`; =20 Once those steps have been performed, maintainance will involve running: =20 -* `./lcitool -a update -h $guest` + lcitool -a update -h $guest -p $project =20 periodically to ensure the guest configuration is sane and all installed packages are updated. =20 +To get a list of known guests and projects, run + + lcitool -a hosts + +and + + lcitool -a projects + +respectively. You can run operations involving multiple guests and projects +at once by providing a list on the command line: for example, running + + lcitool -a update -h '*fedora*' -p '*osinfo*' + +will update all Fedora guests and get them ready to build libosinfo and +related projects, while running + + lcitool -a update -h all -p libvirt,libvirt+mingw + +will update all hosts and prepare them to build libvirt both as a native +library and, where supported, as a Windows library using MinGW. + =20 Host setup ---------- @@ -40,13 +66,13 @@ you'll want to use the `libvirt_guest` variant of the p= lugin. To keep guests up to date over time, it's recommended to have an entry along the lines of =20 - 0 0 * * * cd ~/libvirt-jenkins-ci/guests && ./lcitool -a update -h all + 0 0 * * * ~/libvirt-jenkins-ci/guests/lcitool -a update -h all -p all =20 in your crontab. =20 =20 Test use ---------------- +-------- =20 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 --=20 2.17.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list