From nobody Thu Apr 18 02:41:18 2024 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 ARC-Seal: i=1; a=rsa-sha256; t=1562595275; cv=none; d=zoho.com; s=zohoarc; b=Eq8zQEVQm6ZA6Qf9Q7kafCmIgNB+oG7ix+UcXX7GUH+Py7mtHXAqtCH0x2fl17gKGdFZf2W/6cVuTarfQtcAH0Lf0Jv2GHIRNL59z+eSptuQv4gZIKY5DULELQ7Macrcm3jiuUTLKWvmxUUxyoPTE54s+5TIB41OYKxHQYVmPqg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1562595275; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To:ARC-Authentication-Results; bh=x2382mxifjuO38enJi7JfwOqf1XAJTRMrIomFMlIMvw=; b=WUS7gvDdV85xjYC/D4UsvjiBxaZWpvic/aHKw8n78YRrcuKT4VDz9nJWaA+Kyxx1AinPbisfLRXkAORFnALhpn/LYlsB43QuhErCYPu92zuLgFt7FarYe8JXHSoKWb0cD5K3PWbeWQiakvrnUvCBtNwfSjO+GHwk1GouES1Dpg4= ARC-Authentication-Results: i=1; mx.zoho.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 header.from= (p=none dis=none) header.from= Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1562595275397843.7411915578429; Mon, 8 Jul 2019 07:14:35 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 6A75230860B1; Mon, 8 Jul 2019 14:14:23 +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 436C02D259; Mon, 8 Jul 2019 14:14:20 +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 E97191833003; Mon, 8 Jul 2019 14:14:15 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x68EEExM026121 for ; Mon, 8 Jul 2019 10:14:14 -0400 Received: by smtp.corp.redhat.com (Postfix) id DA44B5D9C8; Mon, 8 Jul 2019 14:14:14 +0000 (UTC) Received: from dhcp-17-95.lcy.redhat.com (unknown [10.42.17.95]) by smtp.corp.redhat.com (Postfix) with ESMTP id 549B45DA5B; Mon, 8 Jul 2019 14:14:11 +0000 (UTC) From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Mon, 8 Jul 2019 15:14:11 +0100 Message-Id: <20190708141411.21435-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH v2] docs: introduce a "knowledge base" for task oriented guides 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: , Content-Type: text/plain; charset="utf-8" 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.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.44]); Mon, 08 Jul 2019 14:14:29 +0000 (UTC) The previously added AMD SEV doc was not linked from anywhere on the website. Address this by introducing a new "Knowledge base" section that can hold task oriented guide to various features. Moving the SEV, disk locking and secure usage guides under this section. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Eric Blake --- docs/Makefile.am | 15 +++++++++++- docs/docs.html.in | 9 ++----- docs/kbase.html.in | 25 ++++++++++++++++++++ docs/{ =3D> kbase}/launch_security_sev.html.in | 0 docs/{ =3D> kbase}/locking-lockd.html.in | 0 docs/{ =3D> kbase}/locking-sanlock.html.in | 0 docs/{ =3D> kbase}/locking.html.in | 0 docs/{ =3D> kbase}/secureusage.html.in | 0 8 files changed, 41 insertions(+), 8 deletions(-) create mode 100644 docs/kbase.html.in rename docs/{ =3D> kbase}/launch_security_sev.html.in (100%) rename docs/{ =3D> kbase}/locking-lockd.html.in (100%) rename docs/{ =3D> kbase}/locking-sanlock.html.in (100%) rename docs/{ =3D> kbase}/locking.html.in (100%) rename docs/{ =3D> kbase}/secureusage.html.in (100%) diff --git a/docs/Makefile.am b/docs/Makefile.am index 977be471ad..1cfa38dc80 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -132,6 +132,10 @@ internals_html_in =3D \ $(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/internals/*.html.in)) internals_html =3D $(internals_html_in:%.html.in=3D%.html) =20 +kbase_html_in =3D \ + $(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/kbase/*.html.in)) +kbase_html =3D $(kbase_html_in:%.html.in=3D%.html) + # Since we ship pre-built html in the tarball, we must also # ship the sources, even when those sources are themselves # generated. @@ -187,6 +191,7 @@ EXTRA_DIST=3D \ $(xml) $(qemu_xml) $(lxc_xml) $(admin_xml) $(fig) $(png) $(css) \ $(javascript) $(logofiles) \ $(internals_html_in) $(internals_html) $(fonts) \ + $(kbase_html_in) $(kbase_html) \ aclperms.htmlinc \ hvsupport.pl \ $(schema_DATA) @@ -202,6 +207,7 @@ MAINTAINERCLEANFILES =3D \ $(addprefix $(srcdir)/,$(apihtml)) \ $(addprefix $(srcdir)/,$(devhelphtml)) \ $(addprefix $(srcdir)/,$(internals_html)) \ + $(addprefix $(srcdir)/,$(kbase_html)) \ $(srcdir)/hvsupport.html.in $(srcdir)/aclperms.htmlinc =20 timestamp=3D"$(shell if test -n "$$SOURCE_DATE_EPOCH"; \ @@ -218,7 +224,8 @@ qemu_api: $(srcdir)/libvirt-qemu-api.xml $(srcdir)/libv= irt-qemu-refs.xml lxc_api: $(srcdir)/libvirt-lxc-api.xml $(srcdir)/libvirt-lxc-refs.xml admin_api: $(srcdir)/libvirt-admin-api.xml $(srcdir)/libvirt-admin-refs.xml =20 -web: $(dot_html) $(internals_html) html/index.html devhelp/index.html +web: $(dot_html) $(internals_html) $(kbase_html) \ + html/index.html devhelp/index.html =20 hvsupport.html: $(srcdir)/hvsupport.html.in =20 @@ -381,6 +388,9 @@ install-data-local: $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/internals for f in $(internals_html); do \ $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR)/internals; done + $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/kbase + for f in $(kbase_html); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR)/kbase; done $(mkinstalldirs) $(DESTDIR)$(DEVHELP_DIR) for file in $(devhelphtml) $(devhelppng) $(devhelpcss); do \ $(INSTALL) -m 0644 $(srcdir)/$${file} $(DESTDIR)$(DEVHELP_DIR) ; \ @@ -405,6 +415,9 @@ uninstall-local: for f in $(internals_html); do \ rm -f $(DESTDIR)$(HTML_DIR)/$$f; \ done + for f in $(kbase_html); do \ + rm -f $(DESTDIR)$(HTML_DIR)/$$f; \ + done for f in $(devhelphtml) $(devhelppng) $(devhelpcss); do \ rm -f $(DESTDIR)$(DEVHELP_DIR)/$$(basename $$f); \ done diff --git a/docs/docs.html.in b/docs/docs.html.in index c8674e1457..9e1ef6be41 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -86,11 +86,6 @@
URI format
The URI formats used for connecting to libvirt
=20 -
Disk locking
-
Ensuring exclusive guest access to disks with - virtlockd or - Sanlock
-
CGroups
Control groups integration
=20 @@ -120,8 +115,8 @@
Driver support
matrix of API support per hypervisor per release
=20 -
Secure usage
-
Secure usage of the libvirt APIs
+
Knowledge Base
+
Task oriented guides to key features
=20 diff --git a/docs/kbase.html.in b/docs/kbase.html.in new file mode 100644 index 0000000000..78f2a4e0c5 --- /dev/null +++ b/docs/kbase.html.in @@ -0,0 +1,25 @@ + + + + +

Knowledge base

+ +
+
+
Disk locking
+
Ensuring exclusive guest access to disks with + virtlockd or + Sanlock
+ +
Secure usage
+
Secure usage of the libvirt APIs
+ +
Launch security=
+
Securely launching VMs with AMD SEV
+
+
+ +
+ + + diff --git a/docs/launch_security_sev.html.in b/docs/kbase/launch_security_= sev.html.in similarity index 100% rename from docs/launch_security_sev.html.in rename to docs/kbase/launch_security_sev.html.in diff --git a/docs/locking-lockd.html.in b/docs/kbase/locking-lockd.html.in similarity index 100% rename from docs/locking-lockd.html.in rename to docs/kbase/locking-lockd.html.in diff --git a/docs/locking-sanlock.html.in b/docs/kbase/locking-sanlock.html= .in similarity index 100% rename from docs/locking-sanlock.html.in rename to docs/kbase/locking-sanlock.html.in diff --git a/docs/locking.html.in b/docs/kbase/locking.html.in similarity index 100% rename from docs/locking.html.in rename to docs/kbase/locking.html.in diff --git a/docs/secureusage.html.in b/docs/kbase/secureusage.html.in similarity index 100% rename from docs/secureusage.html.in rename to docs/kbase/secureusage.html.in --=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list