From nobody Mon Nov 25 17:54:34 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) client-ip=207.211.31.81; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1596105220; cv=none; d=zohomail.com; s=zohoarc; b=HXUsNau80yI6gltfAExQPRNteTceQZ/S3qMbIJBCwyEtZs1wcV5ATbYjKEwNXGkWd1r9+ikaB8khru+NhMjaMzB1ZMWRILZolZ67mUgR/wh6yxBfK/K7jJd4mOLZxH/eiNnjIo/yXoHjW0c8+C8oylNNW0vt96Bv95Q+f9g+vd4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1596105220; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=DmHRBmVdvC1CjVIExA9Y7MzduOvdfwPnq46/sRoXpa4=; b=ac2YPLo5EdUD7YSzXIXg0/5uGdnvYDVs7GjvJPvo2buomqX6LlndDri3u3BtL5mQmM7goMTBz9wvqktNZapzVCSXzaEqvVW3GTRXD7qbnIfvOAkjGwepW2dLfWtSCjZ7pqRqf1qiOnerDPCNohIBgy67WWkgGvPp7OuyCUZUhoM= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-1.mimecast.com [207.211.31.81]) by mx.zohomail.com with SMTPS id 1596105220982403.39654075691726; Thu, 30 Jul 2020 03:33:40 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-401-BevRsrOkM4moQve_DebHiA-1; Thu, 30 Jul 2020 06:33:37 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 74B5D57; Thu, 30 Jul 2020 10:33:32 +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 524758A19E; Thu, 30 Jul 2020 10:33:32 +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 1F5FD95A7E; Thu, 30 Jul 2020 10:33:32 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 06UAUbvn021001 for ; Thu, 30 Jul 2020 06:30:37 -0400 Received: by smtp.corp.redhat.com (Postfix) id C76DC7193A; Thu, 30 Jul 2020 10:30:37 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3389E71906 for ; Thu, 30 Jul 2020 10:30:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1596105219; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=DmHRBmVdvC1CjVIExA9Y7MzduOvdfwPnq46/sRoXpa4=; b=ARpIagACsedayJnHHWu/6xyaVorihBb1VyYfb0yQVz8cwEvRRZDiUTnBXnqEO5Xp2qmHHz hGE/OW3mfxkXWNLmXsjqOopU2azez9DIs7wlqTOt5/j/T9A3NCdSZ24lvJwtybp/uhNwlx eFfecsRzabXGOSG0DCO3mZtJW1+IVJU= X-MC-Unique: BevRsrOkM4moQve_DebHiA-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 1/3] docs: kbase: Convert 'kbase' article registry to RST Date: Thu, 30 Jul 2020 12:30:30 +0200 Message-Id: <4dcaea53d8c18e040406f66eba96857f4dfd9ee5.1596104822.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-loop: libvir-list@redhat.com 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko Reviewed-by: Michal Privoznik --- docs/kbase.html.in | 54 ---------------------------------------------- docs/kbase.rst | 43 ++++++++++++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 44 insertions(+), 55 deletions(-) delete mode 100644 docs/kbase.html.in create mode 100644 docs/kbase.rst diff --git a/docs/kbase.html.in b/docs/kbase.html.in deleted file mode 100644 index 3ca0d0734d..0000000000 --- a/docs/kbase.html.in +++ /dev/null @@ -1,54 +0,0 @@ - - - - -

Knowledge base

- -
-
-
Disk locking
-
Ensuring exclusive guest access to disks with - virtlockd or - Sanlock
- -
Secure usage
-
Secure usage of the libvirt APIs
- -
Protected virtualiz= ation on s390
-
Running secure s390 guests with IBM Secure Execution
- -
Launch security=
-
Securely launching VMs with AMD SEV
- -
Domain state - capture
-
Comparison between different methods of capturing domain - state
- -
RPM deployment
-
Explanation of the different RPM packages and illustration of - which to pick for installation
- -
Backing chain management=
-
Explanation of how disk backing chain specification impacts li= bvirt's - behaviour and basic troubleshooting steps of disk problems.
- -
Security with= QEMU passthrough
-
Examination of the security protections used for QEMU and how = they need - configuring to allow use of QEMU passthrough with host files/dev= ices.
- -
Virtio-FS
-
Share a filesystem between the guest and the host
- -
KVM real time
-
Run real time workloads in guests on a KVM hypervisor
- -
Incremental = backup internals
-
Incremental backup implementation details relevant for users -
-
- -
- - - diff --git a/docs/kbase.rst b/docs/kbase.rst new file mode 100644 index 0000000000..509fb6e34e --- /dev/null +++ b/docs/kbase.rst @@ -0,0 +1,43 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Knowledge base +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. container:: panel + + `Disk locking `__ + Ensuring exclusive guest access to disks with + `virtlockd `__ or + `Sanlock `__ + + `Secure usage `__ + Secure usage of the libvirt APIs + + `Protected virtualization on s390 `__ + Running secure s390 guests with IBM Secure Execution + + `Launch security `__ + Securely launching VMs with AMD SEV + + `Domain state capture `__ + Comparison between different methods of capturing domain state + + `RPM deployment `__ + Explanation of the different RPM packages and illustration of which = to + pick for installation + + `Backing chain management `__ + Explanation of how disk backing chain specification impacts libvirt's + behaviour and basic troubleshooting steps of disk problems. + + `Security with QEMU passthrough `= __ + Examination of the security protections used for QEMU and how they n= eed + configuring to allow use of QEMU passthrough with host files/devices. + + `Virtio-FS `__ + Share a filesystem between the guest and the host + + `KVM real time `__ + Run real time workloads in guests on a KVM hypervisor + + `Incremental backup internals `__ + Incremental backup implementation details relevant for users diff --git a/docs/meson.build b/docs/meson.build index c2d7fd1bf4..2f06e8eace 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -87,7 +87,6 @@ docs_html_in_files =3D [ 'index', 'internals', 'java', - 'kbase', 'logging', 'migration', 'nss', @@ -119,6 +118,7 @@ docs_rst_files =3D [ 'formatbackup', 'formatcheckpoint', 'hacking', + 'kbase', 'libvirt-go', 'libvirt-go-xml', 'newreposetup', --=20 2.26.2 From nobody Mon Nov 25 17:54:34 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) client-ip=205.139.110.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1596105160; cv=none; d=zohomail.com; s=zohoarc; b=BjfeVN0AC07gvlvYhbH1yDAvb+5+h2HzLvEETVoEin6bMr96vKraRU3maEmUQaNE8FKuLma377ECzvRpEFMZF9Xsyvu7FYhuOpZ6hdSFkcb4dCse4usdn/hODstaXSu47+ysxZNWnRER956KokScU3Lp21xkX2S5rnb5Bb+y+vo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1596105160; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=tV3RCED5WcsYNJcJXjBmavGgk61Pgmc46hXJE9k3xaY=; b=Lo2OQuQcdbVmMXdnMDiHKcse+O8FE0AYaUAyHKgrHSl9Lx86u42IMbuYaxZNNvS1X00+V0kBvprOdcHJrdoqorFg93ndNkvCjBdVQdcwVSlaD0WqEoRIUzala2e71A8vrevEhgyYhxQ+KcIHN3t0pCFrFoRbYoCSkY/2oE9PxTQ= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) by mx.zohomail.com with SMTPS id 1596105160476175.87425132345152; Thu, 30 Jul 2020 03:32:40 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-420-XKyHKUhhMVCdaiZWIvCzrQ-1; Thu, 30 Jul 2020 06:32:36 -0400 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 mimecast-mx01.redhat.com (Postfix) with ESMTPS id 33018800474; Thu, 30 Jul 2020 10:32:31 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 10B48712FF; Thu, 30 Jul 2020 10:32:31 +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 D0D951809554; Thu, 30 Jul 2020 10:32:30 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 06UAUeO6021015 for ; Thu, 30 Jul 2020 06:30:40 -0400 Received: by smtp.corp.redhat.com (Postfix) id A3D965F1E5; Thu, 30 Jul 2020 10:30:40 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0F107726AC for ; Thu, 30 Jul 2020 10:30:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1596105159; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=tV3RCED5WcsYNJcJXjBmavGgk61Pgmc46hXJE9k3xaY=; b=JZ0Xq9HoEWXkyRDWv0I6e7JKA0h1lRDQ/rEekqeFIems5hv4VNWO3L4IkM8Gks+ph3rh/N ZNryIVzlLQUEn+sjTJPsWNUTWYLzJNurlrFsLjGoMCxavfHz8v2y0vYMFdmC9DaBuzDkun ycK2RjqoMIYJQbFGwyvyfS4AtGRYRiU= X-MC-Unique: XKyHKUhhMVCdaiZWIvCzrQ-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 2/3] docs: kbase: Make kbase article directory wider Date: Thu, 30 Jul 2020 12:30:31 +0200 Message-Id: <10cb1d38a42978c7f2a62b2d4f8ef4a8eb00d1f9.1596104822.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-loop: libvir-list@redhat.com 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: , 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-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Set the width to our default value of 70em (max 95%) to prevent unnecessary line breaks if we have just one panel as it's in the kbase directory. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko Reviewed-by: Michal Privoznik --- docs/kbase.rst | 2 +- docs/libvirt.css | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/kbase.rst b/docs/kbase.rst index 509fb6e34e..767c08e637 100644 --- a/docs/kbase.rst +++ b/docs/kbase.rst @@ -2,7 +2,7 @@ Knowledge base =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D -.. container:: panel +.. container:: panel widepanel `Disk locking `__ Ensuring exclusive guest access to disks with diff --git a/docs/libvirt.css b/docs/libvirt.css index 3f0fd93089..551adac2f2 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -402,6 +402,14 @@ div.panel { background: rgb(230, 230, 230); } +div.widepanel { + width: 70em; + max-width: 95%; + margin-left: 0px; + float: left; + background: rgb(230, 230, 230); +} + div.panel h2 { margin-top: 0px; padding: 0.5em; --=20 2.26.2 From nobody Mon Nov 25 17:54:34 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) client-ip=207.211.31.81; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1596105103; cv=none; d=zohomail.com; s=zohoarc; b=WBh0eO+si0A5yRstjtdU4ux6vjEiUBd5teCNTBrS5P9O1LugJKvmep3rRTr4+Murzp5QNVl7RI5BMnfGCM+dNVYdMYv0a9kW8vM+rIDcXNzoFWrPlykA4dqZmYAe1N5kAg75T0gTp2gLWxCPmhTLcOyhRnlj6YlpINdgP1WBsF8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1596105103; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=DuN9M8IGcULXPXuCY2qiBH/5nmnsbfFgzXPBbLZV+GU=; b=NcsqO+6i85DcaQ+ktQIu8HWyYvt7jte9ZSgvumrL7EgtROdILPQ01AFXGEzL5PEtCmIBR3KWjjhmcRFPtoZQU1IvnkhNqZzMn9tB0jJWk0LVaTRhbuIJIPAg6L4tIa24MMyZmRiGjaRGwNP8/Wxb94sVtlPRXROz873m11jbzt4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-1.mimecast.com [207.211.31.81]) by mx.zohomail.com with SMTPS id 1596105103265419.6208905687562; Thu, 30 Jul 2020 03:31:43 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-317-DgzBG0ViMIenH8p-UOYgLw-1; Thu, 30 Jul 2020 06:31:39 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id D3F59800597; Thu, 30 Jul 2020 10:31:32 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id D8D5B8A191; Thu, 30 Jul 2020 10:31:30 +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 AE7781809554; Thu, 30 Jul 2020 10:31:25 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 06UAUfpf021023 for ; Thu, 30 Jul 2020 06:30:41 -0400 Received: by smtp.corp.redhat.com (Postfix) id 9EA425F1E5; Thu, 30 Jul 2020 10:30:41 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0BC9671934 for ; Thu, 30 Jul 2020 10:30:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1596105102; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=DuN9M8IGcULXPXuCY2qiBH/5nmnsbfFgzXPBbLZV+GU=; b=ZNs287AfG4omubOhEfKVkAz4RhBhlhYHVHNGdPd2i7FK0yZOq5wXXLMySwxjecX7qzAEXM 0XzIlmXEjRsMBm5G4H7RaU6e8Av3+ZB6374LgxBG+DP9eFmKCS7q6/WKERyM3rq1r1I6hw RZDK/WrwUkVFUyE4Dt2m6x6JyhsBOGo= X-MC-Unique: DgzBG0ViMIenH8p-UOYgLw-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 3/3] docs: kbase: Port 'debuglogs' document from libvirt's wiki Date: Thu, 30 Jul 2020 12:30:32 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-loop: libvir-list@redhat.com 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Provide debug log configuration insight in our kbase. There are two modifications of the document compared to the wiki version: 1) The link for reporting a bug agains libvirt was modified to use the gitlab issue tracker. 2) The link to URI specification details is changed to 'https' protocol. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko Reviewed-by: Michal Privoznik --- docs/kbase.rst | 3 + docs/kbase/debuglogs.rst | 148 +++++++++++++++++++++++++++++++++++++++ docs/kbase/meson.build | 1 + 3 files changed, 152 insertions(+) create mode 100644 docs/kbase/debuglogs.rst diff --git a/docs/kbase.rst b/docs/kbase.rst index 767c08e637..78daaa5989 100644 --- a/docs/kbase.rst +++ b/docs/kbase.rst @@ -4,6 +4,9 @@ Knowledge base .. container:: panel widepanel + `Debug logs `__ + Configuration of logging and tips on how to file a good bug report. + `Disk locking `__ Ensuring exclusive guest access to disks with `virtlockd `__ or diff --git a/docs/kbase/debuglogs.rst b/docs/kbase/debuglogs.rst new file mode 100644 index 0000000000..decc53a69b --- /dev/null +++ b/docs/kbase/debuglogs.rst @@ -0,0 +1,148 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Debug Logs +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. contents:: + +Turning on debug logs +--------------------- + +If you `report a bug `__ +against libvirt, in most cases you will be asked to attach debug logs. The= se +are bare text files which tracks transition between different states of +libvirtd, what it has tried to achieve, etc. Because of client -- server s= chema +used in libvirt, the logs can be either client or server too. Usually, it's +server side that matters as nearly all interesting work takes place there. +Moreover, libvirt catches stderr of all running domains. These can be usef= ul as +well. + + +How to turn on debug logs for libvirt +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Persistent setting +^^^^^^^^^^^^^^^^^^ + +The daemon configuration files location is dependent on `connection +URI `__. For ``qemu:///system``: + + + +- open ``/etc/libvirt/libvirtd.conf`` in your favourite editor +- find & replace, or set these variables: + +:: + + # LEGACY SETTINGS PRIOR LIBVIRT 4.4.0 SEE BELOW! # + log_level =3D 1 + log_filters=3D"1:qemu 3:remote 4:event 3:util.json 3:rpc" + log_outputs=3D"1:file:/var/log/libvirt/libvirtd.log" + +:: + + # PREFERRED SETTINGS AFTER LIBVIRT 4.4.0 # + log_filters=3D"3:remote 4:event 3:util.json 3:rpc 1:*" + log_outputs=3D"1:file:/var/log/libvirt/libvirtd.log" + +- save and exit +- restart libvirtd service + +:: + + systemctl restart libvirtd.service + +In the config variables above, we have set logging level to 1 (debug level= ), set +some filters (to filter out noise), e.g. from rpc only warnings (=3Dlevel = 3) and +above will be reported. The logs are saved into +``/var/log/libvirt/libvirtd.log``. Since libvirt **4.4.0** log filters sup= port +shell globbing, therefore the usage of ``log_level`` is considered depreca= ted in +favour of pure usage of ``log_filters``. + +In case you want to get the client logs, you need to set this environment +variable: + +:: + + export LIBVIRT_LOG_OUTPUTS=3D"1:file:/tmp/libvirt_client.log" + + +However, when you are using the session mode ``qemu:///session`` or you ru= n the +``libvirtd`` as unprivileged user you will find configuration file under +``$XDG_CONFIG_HOME/libvirt/libvirt.conf``. + +Runtime setting +^^^^^^^^^^^^^^^ + +Debugging anomalies can be very painful, especially when trying to reprodu= ce it +after the daemon restarts, since the new session can make the anomaly +"disappear". Therefore, it's possible to enable the debug logs during runt= ime +using libvirt administration API. To use it conveniently, there's a virt-a= dmin +client provided by the libvirt-admin package. Use the package manager prov= ided +by your distribution to install this package. Once you have it installed, = run +the following as root to see the set of log filters currently being active: + +:: + + # virt-admin daemon-log-filters + Logging filters: 3:remote 4:util.json 4:rpc + +In order to change this set, run the same command as root, this time with = your +own set of filters: + +:: + + ## LEGACY APPROACH ENUMERATING ALL THE DESIRED MODULES ## + # virt-admin daemon-log-filters "1:util 1:libvirt 1:storage 1:network 1= :nodedev 1:qemu" + +:: + + ## CURRENT APPROACH USING SHELL GLOBBING ## + # virt-admin daemon-log-filters "3:remote 4:util.json 4:rpc 1:*" + +Analogically, the same procedure can be performed with log outputs: + +:: + + # virt-admin daemon-log-outputs + Logging outputs: 3:syslog:libvirtd + # virt-admin daemon-log-outputs "1:file:/var/log/libvirt/libvirtd.log" + +NOTE: It's always good practice to return the settings to the original sta= te +once you're finished debugging, just remember to save the original sets of +filters and outputs and restore them at the end the same way as described = above. + +Removing filters and outputs +'''''''''''''''''''''''''''' + +It's also possible to remove all the filters and produce an enormous log f= ile, +but it is not recommended since some of libvirt's modules can produce a la= rge +amount of noise. However, should you really want to do this, you can speci= fy an +empty set of filters: + +:: + + # virt-admin daemon-log-filters "" + Logging filters: + +The situation is a bit different with outputs, since libvirt always has to= log +somewhere and resetting the outputs to an empty set will restore the defau= lt +setting which depends on the host configuration, *journald* in our case: + +:: + + # virt-admin daemon-log-outputs + Logging outputs: 1:file:/var/log/libvirt/libvirtd.log + # virt-admin daemon-log-outputs "" + Logging outputs: 2:journald + +What to attach? +~~~~~~~~~~~~~~~ + +Now you should go and reproduce the bug. Once you're finished, attach: + +- ``/var/log/libvirt/libvirtd.log`` or whatever path you set for the daem= on + logs. +- If the problem is related to a domain attach + ``/var/log/libvirt/qemu/$dom.log`` then. Or substitute ``qemu`` with wh= atever + hypervisor you are using. +- If you are asked for client logs, ``/tmp/libvirt_client.log``. diff --git a/docs/kbase/meson.build b/docs/kbase/meson.build index f72e426223..d7f254e163 100644 --- a/docs/kbase/meson.build +++ b/docs/kbase/meson.build @@ -1,5 +1,6 @@ docs_kbase_files =3D [ 'backing_chains', + 'debuglogs', 'domainstatecapture', 'incrementalbackupinternals', 'kvm-realtime', --=20 2.26.2