From nobody Tue Feb 10 01:15:28 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 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=1646668826; cv=none; d=zohomail.com; s=zohoarc; b=GFoB5FSKEiPMeHQ54g8wOF4PFyspwDyVjsv4dXOzfXqaS4BFVK94STWPzvv4ABrZPOPQDfHNdcsSJq1ERhyBYE4UOIwVu1td51ywQ+qZuoEQjx2XBEyUPt+ZlwybOk0KE7QVwmQHFdYWtRhTzZpq3w7+gwI/yX66TzTmpR5bOcY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1646668826; 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=UwNpQyqWoC5lhkIUncLClk961ijJ7Xk4yzRnoX4kig8=; b=jJZfbZ81f78WONe8+kMt9iqxYxviO03fPW6B4My8vDfPiK2y10E+kfKlTXKk5vWdoh0BnhJhw5SdUAk3oBBae3nvmugYVw/5wD0aKySfCE+lNVdVtWvTToto130qZhUPpO7olv32ZTH41NKd0GijJJHKmPCDlcPkA8sj+m2sRr4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1646668826915969.4204408840415; Mon, 7 Mar 2022 08:00:26 -0800 (PST) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-96-CzcQ9UnBOsqw6C2T7nswaA-1; Mon, 07 Mar 2022 11:00:21 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 8916F80159B; Mon, 7 Mar 2022 16:00:03 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 69928400E43D; Mon, 7 Mar 2022 16:00:03 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 26FBC1931BEA; Mon, 7 Mar 2022 16:00:03 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id E6778196BB8F for ; Mon, 7 Mar 2022 16:00:01 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 9F7B27D3CE; Mon, 7 Mar 2022 16:00:01 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.30]) by smtp.corp.redhat.com (Postfix) with ESMTP id EDF6982769 for ; Mon, 7 Mar 2022 16:00:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1646668826; 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=UwNpQyqWoC5lhkIUncLClk961ijJ7Xk4yzRnoX4kig8=; b=gjlIIpBfLhkm+8BqdhchPD8zkR/Dnb5zPhLZlTQCN3+/bWzOXYHIb4xuwcONB7meTHGSlx GHZZSFdHtWxZOTBkE1GkgcH16A+0WS7EKeH7zYnCzpxaW00k1X2wAn35hws00XCXmUm2vK Ie0p4935H3H8A7exTxxzrU5RaySOglc= X-MC-Unique: CzcQ9UnBOsqw6C2T7nswaA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 04/17] docs: Convert 'goals' to rST Date: Mon, 7 Mar 2022 16:59:24 +0100 Message-Id: <00bfc4cbd54dead65223b21d2c6ef39f2b349f86.1646668723.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1646668832185100001 Content-Type: text/plain; charset="utf-8" Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/goals.html.in | 64 ---------------------------------------------- docs/goals.rst | 56 ++++++++++++++++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 57 insertions(+), 65 deletions(-) delete mode 100644 docs/goals.html.in create mode 100644 docs/goals.rst diff --git a/docs/goals.html.in b/docs/goals.html.in deleted file mode 100644 index f1639338ad..0000000000 --- a/docs/goals.html.in +++ /dev/null @@ -1,64 +0,0 @@ - - - - -

Terminology and goals

-

To avoid ambiguity about the terms used, here are the definitions - for some of the specific concepts used in libvirt documentation:

-
    -
  • a node is a single physical machine
    • -
  • an hypervisor is a layer of software allowing to - virtualize a node in a set of virtual machines with possibly different - configurations than the node itself
    • -
  • a domain is an instance of an operating system - (or subsystem in the case of container virtualization) running on a - virtualized machine provided by the hypervisor
    • -
-

Now we can define the goal of libvirt: to provide a common and - stable layer sufficient to securely manage domains on a node, possibly - remote.

-

As a result, libvirt should provide all APIs needed to do the - management, such as: provision, create, modify, monitor, control, migr= ate - and stop the domains - within the limits of the support of the hypervi= sor - for those operations. - Not all hypervisors provide the same operations; but if an operation is - useful for domain management of even one specific hypervisor it is wor= th - providing in libvirt. - Multiple nodes - may be accessed with libvirt simultaneously, but the APIs are limited = to - single node operations. Node resource operations which are needed - for the management and provisioning of domains are also in the scope of - the libvirt API, such as interface setup, firewall rules, storage mana= gement - and general provisioning APIs. Libvirt will also provide the state - monitoring APIs needed to implement management policies, obviously - checking domain state but also exposing local node resource consumptio= n. -

-

This implies the following sub-goals:

-
    -
  • All API can be carried remotely though secure APIs
    • -
  • While most API will be generic in term of hypervisor or Host OS, - some API may be targeted to a single virtualization environment - as long as the semantic for the operations from a domain management - perspective is clear
    • -
  • the API should allow to do efficiently and cleanly all the opera= tions - needed to manage domains on a node, including resource provisioning and - setup
    • -
  • the API will not try to provide high level virtualization polici= es or - multi-nodes management features like load balancing, but the API shoul= d be - sufficient so they can be implemented on top of libvirt
    • -
  • stability of the API is a big concern, libvirt should isolate - applications from the frequent changes expected at the lower level of = the - virtualization framework
    • -
  • the node being managed may be on a different physical machine th= an - the management program using libvirt, to this effect libvirt supports - remote access, but should only do so by using secure protocols.
    • -
  • libvirt will provide APIs to enumerate, monitor and use the reso= urces - available on the managed node, including CPUs, memory, storage, networ= king, - and NUMA partitions.
    • -
-

So libvirt is intended to be a building block for higher level - management tools and for applications focusing on virtualization of a - single node (the only exception being domain migration between node - capabilities which involves more than one node).

- - diff --git a/docs/goals.rst b/docs/goals.rst new file mode 100644 index 0000000000..7385f27b61 --- /dev/null +++ b/docs/goals.rst @@ -0,0 +1,56 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Terminology and goals +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +To avoid ambiguity about the terms used, here are the definitions for some= of +the specific concepts used in libvirt documentation: + +- a **node** is a single physical machine +- an **hypervisor** is a layer of software allowing to virtualize a node = in a + set of virtual machines with possibly different configurations than the= node + itself +- a **domain** is an instance of an operating system (or subsystem in the= case + of container virtualization) running on a virtualized machine provided = by the + hypervisor + +Now we can define the goal of libvirt: **to provide a common and stable la= yer +sufficient to securely manage domains on a node, possibly remote**. + +As a result, libvirt should provide all APIs needed to do the management, = such +as: provision, create, modify, monitor, control, migrate and stop the doma= ins - +within the limits of the support of the hypervisor for those operations. N= ot all +hypervisors provide the same operations; but if an operation is useful for +domain management of even one specific hypervisor it is worth providing in +libvirt. Multiple nodes may be accessed with libvirt simultaneously, but t= he +APIs are limited to single node operations. Node resource operations which= are +needed for the management and provisioning of domains are also in the scop= e of +the libvirt API, such as interface setup, firewall rules, storage manageme= nt and +general provisioning APIs. Libvirt will also provide the state monitoring = APIs +needed to implement management policies, obviously checking domain state b= ut +also exposing local node resource consumption. + +This implies the following sub-goals: + +- All API can be carried remotely though secure APIs +- While most API will be generic in term of hypervisor or Host OS, some A= PI may + be targeted to a single virtualization environment as long as the seman= tic + for the operations from a domain management perspective is clear +- the API should allow to do efficiently and cleanly all the operations n= eeded + to manage domains on a node, including resource provisioning and setup +- the API will not try to provide high level virtualization policies or + multi-nodes management features like load balancing, but the API should= be + sufficient so they can be implemented on top of libvirt +- stability of the API is a big concern, libvirt should isolate applicati= ons + from the frequent changes expected at the lower level of the virtualiza= tion + framework +- the node being managed may be on a different physical machine than the + management program using libvirt, to this effect libvirt supports remote + access, but should only do so by using secure protocols. +- libvirt will provide APIs to enumerate, monitor and use the resources + available on the managed node, including CPUs, memory, storage, network= ing, + and NUMA partitions. + +So libvirt is intended to be a building block for higher level management = tools +and for applications focusing on virtualization of a single node (the only +exception being domain migration between node capabilities which involves = more +than one node). diff --git a/docs/meson.build b/docs/meson.build index adb7ac091e..afed104014 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -53,7 +53,6 @@ docs_html_in_files =3D [ 'formatsecret', 'formatstoragecaps', 'formatstorageencryption', - 'goals', 'governance', 'hooks', 'index', @@ -101,6 +100,7 @@ docs_rst_files =3D [ 'formatsnapshot', 'formatstorage', 'glib-adoption', + 'goals', 'hacking', 'libvirt-go', 'libvirt-go-xml', --=20 2.35.1