From nobody Fri May  3 20:59:31 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
Return-Path: <libvir-list-bounces@redhat.com>
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1522922713749630.4173207647891;
 Thu, 5 Apr 2018 03:05:13 -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 1D84B1B282B;
	Thu,  5 Apr 2018 10:05:12 +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 91E566A259;
	Thu,  5 Apr 2018 10:05:11 +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 778581800C9F;
	Thu,  5 Apr 2018 10:05:10 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com
	[10.11.54.3])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id w35A58ba027783 for <libvir-list@listman.util.phx.redhat.com>;
	Thu, 5 Apr 2018 06:05:08 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 9EAB41208F7F; Thu,  5 Apr 2018 10:05:08 +0000 (UTC)
Received: from t460.redhat.com (unknown [10.33.36.58])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 26C9A1208F7E;
	Thu,  5 Apr 2018 10:05:05 +0000 (UTC)
From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= <berrange@redhat.com>
To: libvir-list@redhat.com
Date: Thu,  5 Apr 2018 11:05:04 +0100
Message-Id: <20180405100504.24971-1-berrange@redhat.com>
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.78 on 10.11.54.3
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH v2] docs: add page describing goals for host
	platform version support
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	<libvir-list.redhat.com>
List-Unsubscribe: <https://www.redhat.com/mailman/options/libvir-list>,
	<mailto:libvir-list-request@redhat.com?subject=unsubscribe>
List-Archive: <https://www.redhat.com/archives/libvir-list>
List-Post: <mailto:libvir-list@redhat.com>
List-Help: <mailto:libvir-list-request@redhat.com?subject=help>
List-Subscribe: <https://www.redhat.com/mailman/listinfo/libvir-list>,
	<mailto:libvir-list-request@redhat.com?subject=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.11
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]);
 Thu, 05 Apr 2018 10:05:12 +0000 (UTC)
X-ZohoMail: RSF_0  Z_629925259 SPT_0

Described how we decide which host platforms to support for libvirt,
which in turn makes it easier to decide when a platform / software
version can be dropped.

Signed-off-by: Daniel P. Berrang=C3=A9 <berrange@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: John Ferlan <jferlan@redhat.com>
Reviewed-by: Pavel Hrdina <phrdina@redhat.com>
---
 docs/index.html.in     |   2 +-
 docs/platforms.html.in | 105 +++++++++++++++++++++++++++++++++++++++++++++=
++++
 2 files changed, 106 insertions(+), 1 deletion(-)
 create mode 100644 docs/platforms.html.in

diff --git a/docs/index.html.in b/docs/index.html.in
index 1b3a7a3db6..4783c39e3c 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -28,7 +28,7 @@
         The libvirt project:
       </p>
       <ul>
-        <li>is a toolkit to manage virtualization hosts</li>
+        <li>is a toolkit to manage <a href=3D"platforms.html.in">virtualiz=
ation platforms</a></li>
         <li>is accessible from C, Python, Perl, Java and more</li>
         <li>is licensed under open source licenses</li>
         <li>supports <a href=3D"drvqemu.html">KVM</a>,
diff --git a/docs/platforms.html.in b/docs/platforms.html.in
new file mode 100644
index 0000000000..776e930e78
--- /dev/null
+++ b/docs/platforms.html.in
@@ -0,0 +1,105 @@
+<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<!DOCTYPE html>
+<html xmlns=3D"http://www.w3.org/1999/xhtml">
+  <body>
+    <h1>Supported host platforms</h1>
+
+    <ul id=3D"toc"></ul>
+
+    <h2>Build targets</h2>
+
+    <p>
+      Libvirt drivers aim to support building and executing on multiple
+      host OS platforms. This document outlines which platforms are the
+      major build targets. These platforms are used as the basis for decid=
ing
+      upon the minimum required versions of 3rd party software libvirt dep=
ends
+      on. If a platform is not listed here, it does not imply that libvirt
+      won't work. If an unlisted platform has comparable software versions
+      to a listed platform, there is every expectation that it will work.
+      Bug reports are welcome for problems encountered on unlisted platfor=
ms
+      unless they are clearly older vintage that what is described here.
+    </p>
+
+    <p>
+      Note that when considering software versions shipped in distros as
+      support targets, libvirt considers only the version number, and assu=
mes
+      the features in that distro match the upstream release with the same
+      version. IOW, if a distro backports extra features to the software in
+      their distro, libvirt upstream code will not add explicit support for
+      those backports, unless the feature is auto-detectable in a manner t=
hat
+      works for the upstream releases too.
+    </p>
+
+    <p>
+      The Repology site is a useful resource to identify currently shipped
+      versions of software in various operating systems, though it does not
+      cover all distros listed below.
+    </p>
+
+    <ul>
+      <li><a href=3D"https://repology.org/metapackage/libvirt/versions">li=
bvirt</a></li>
+      <li><a href=3D"https://repology.org/metapackage/qemu/versions">qemu<=
/a></li>
+    </ul>
+
+
+    <h3>Linux OS</h3>
+
+    <p>
+      For distributions with frequent, short-lifetime releases, the project
+      will aim to support all versions that are not end of life by their
+      respective vendors. For the purposes of identifying supported softwa=
re
+      versions, the project will look at Fedora, Ubuntu &amp; OpenSUSE dis=
tros.
+      Other short-lifetime distros will be assumed to ship similar software
+      versions.
+    </p>
+
+    <p>
+      For distributions with long-lifetime releases, the project will aim =
to
+      support the most recent major version at all times. Support for the
+      previous major version will be dropped 2 years after the new major
+      version is released. For the purposes of identifying supported softw=
are
+      versions, the project will look at RHEL, Debian, Ubuntu LTS &amp; SL=
ES
+      distros. Other long-lifetime distros will be assumed to ship similar
+      software versions.
+    </p>
+
+    <h3>Windows</h3>
+
+    <p>
+      The project supports building with current versions of the MinGW
+      toolchain, hosted on Linux.
+    </p>
+
+    <h3>macOS</h3>
+
+    <p>
+      The project supports building with the current version of macOS,
+      with the current homebrew package set available.
+    </p>
+
+    <h3>FreeBSD</h3>
+
+    <p>
+      The project aims to support the most recent major version
+      at all times. Support for the previous major version will
+      be dropped 2 years after the new major version is released.
+    </p>
+
+    <h2>Virtualization platforms</h2>
+
+    <p>
+      For <a href=3D"drivers.html">hypervisor drivers</a> which execute
+      locally (QEMU, LXC, VZ, libxl, etc), the set of supported operating
+      system platforms listed above will inform choices as to the minimum
+      required versions of 3rd party libraries and hypervisor management
+      APIs.
+    </p>
+    <p>
+      If a hypervisor is not commonly shipped directly by any distro
+      listed above, (VMware ESX, HyperV, VZ), the project aims to
+      support versions up to 5 years, or until the vendor discontinues
+      support, whichever comes first.
+    </p>
+
+  </body>
+</html>
--=20
2.14.3

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list