Migrating virt-components article (jsc#DOCTEAM-1280) (#307)

Co-authored-by: Daria Vladykina <[email protected]>
SUSE · Aug 28, 2024 · 6091883 · 6091883
1 parent fdd8f20
commit 6091883
Show file tree

Hide file tree

Showing 10 changed files with 464 additions and 355 deletions.
diff --git a/DC-snapper-basic-concepts b/DC-snapper-basic-concepts
@@ -4,8 +4,8 @@
 MAIN="snapper-basic-concepts.asm.xml"
 SRC_DIR="articles"
 
+PROFCONDITION="suse-product"
 PROFOS="sles"
-#PROFCONDITION="suse-product"
 #PROFCONDITION="suse-product;beta"
 #PROFCONDITION="community-project"
 

diff --git a/DC-task-install-virtualization-components → DC-virt-components b/DC-task-install-virtualization-components → DC-virt-components
@@ -1,13 +1,16 @@
 # This file originates from the project https://github.com/openSUSE/doc-kit
 # This file can be edited downstream.
 
-MAIN="task-install-virtualization-components.xml"
-ROOTID="task-install-virtualization-components"
+MAIN="virt-components.asm.xml"
+# Point to the ID of the <structure> of your assembly
+#ROOTID="virt-components"
+SRC_DIR="articles"
+IMG_SRC_DIR="images"
 
 PROFCONDITION="suse-product"
 PROFOS="sles"
 #PROFCONDITION="suse-product;beta"
 #PROFCONDITION="community-project"
 
 STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
-FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
+FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"
diff --git a/articles/virt-components.asm.xml b/articles/virt-components.asm.xml
@@ -0,0 +1,177 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
+<!-- This file can be edited downstream. -->
+<!DOCTYPE assembly
+[
+    <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for file and id naming conventions -->
+<assembly version="5.2" xml:lang="en"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:trans="http://docbook.org/ns/transclusion"
+          xmlns:its="http://www.w3.org/2005/11/its"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns="http://docbook.org/ns/docbook">
+<!-- R E S O U R C E S -->
+  <resources>
+    <resource xml:id="_virt-components-installing-system-role" href="../tasks/virt-components-installing-system-role.xml"/>
+    <resource xml:id="_virt-components-installation-patterns" href="../references/virt-components-installation-patterns.xml"/>
+    <resource xml:id="_virt-components-installation-yast" href="../tasks/virt-components-installation-yast.xml"/>
+    <resource xml:id="_virt-components-intro" href="../glues/virt-components-intro.xml"/>
+    <resource href="../common/legal.xml" xml:id="_legal">
+      <description>Legal Notice</description>
+    </resource>
+    <resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
+      <description>GNU Free Documentation License</description>
+    </resource>
+  </resources>
+<!-- S T R U C T U R E -->
+  <structure renderas="article" xml:id="virt-components" xml:lang="en">
+    <merge>
+      <title>Installing Virtualization Components</title>
+      <revhistory xml:id="rh-virt-components">
+        <revision><date>2024-03-11</date>
+          <revdescription>
+            <para>
+              Initial release
+            </para>
+          </revdescription>
+        </revision>
+      </revhistory>
+      <meta name="maintainer" content="[email protected]" its:translate="no"/>
+<!-- ISO date of last update as YYYY-MM-DD -->
+      <meta name="updated" content="2024-03-06" its:translate="no"/>
+<!-- this does not work yet. Use the dm tags listed below for now
+        <meta name="bugtracker" its:translate="no">
+          <phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase>
+          <phrase role="component">Non-product-specific documentation</phrase>
+          <phrase role="product">Smart Docs</phrase>
+          <phrase role="assignee">[email protected]</phrase>
+        </meta>
+        -->
+<!-- not supported, yet. Use dm: tag for now
+        <meta name="translation" its:translate="no">
+        <phrase role="trans">yes</phrase>
+        <phrase role="language">de-de,cs-cz</phrase>
+        </meta>
+        -->
+<!-- enter the platform identifier or a list of
+        identifiers, separated by ; -->
+<!-- For a full list of meta tags and their values,
+	   see https://confluence.suse.com/x/aQDWNg
+      -->
+      <meta name="architecture" its:translate="no"><phrase>&x86-64;</phrase><phrase>&power;</phrase><phrase>&aarch64;</phrase>
+      </meta>
+      <meta name="productname" its:translate="no"><productname version="16.0" os="sles">&productname;</productname>
+      </meta>
+      <meta name="title" its:translate="yes">Server virtualization components</meta>
+      <meta name="description" its:translate="yes">Installing virtualization components on a virtualization server</meta>
+      <meta name="social-descr" its:translate="yes">Server virtualization components</meta>
+<!-- suitable category, comma-separated list of categories -->
+      <meta name="category" its:translate="no"><phrase>Virtualization</phrase>
+      </meta>
+      <meta name="task" its:translate="no"><phrase>Virtualization</phrase>
+      </meta>
+      <meta name="series" its:translate="no">Product &amp; Solutions</meta>
+      <dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
+        <dm:bugtracker>
+          <dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
+          <dm:component>Smart Docs</dm:component>
+          <dm:product>Documentation</dm:product>
+<!-- provide your BUGZILLA e-mail address, otherwise this does not work correctly-->
+          <dm:assignee>[email protected]</dm:assignee>
+        </dm:bugtracker>
+        <dm:translation>yes</dm:translation>
+      </dm:docmanager>
+      <abstract>
+        <variablelist>
+          <varlistentry>
+            <term>WHAT?</term>
+            <listitem>
+              <para>
+                A virtualization host needs tools to provide virtualization
+                services to guest systems.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>WHY?</term>
+            <listitem>
+              <para>
+                You want to configure a host to run multiple virtualized guest
+                systems under a preferred hypervisor.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>EFFORT</term>
+            <listitem>
+              <para>
+                Less that 10 minutes is enough to study and install needed
+                virtualization components.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>GOAL</term>
+            <listitem>
+              <para>
+                You can turn a &productnameshort; host system into a
+                virtualization host easily.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>REQUIREMENTS</term>
+            <listitem>
+              <itemizedlist>
+                <listitem>
+                  <para>
+                    A bare-metal host that complies with minimal hardware
+                    requirements for &productnameshort;.
+                  </para>
+                </listitem>
+              </itemizedlist>
+            </listitem>
+          </varlistentry>
+        </variablelist>
+      </abstract>
+    </merge>
+    <module resourceref="_virt-components-intro" renderas="section">
+      <merge>
+        <title>Introduction</title>
+      </merge>
+    </module>
+    <module resourceref="_virt-components-installing-system-role" renderas="section">
+      <merge>
+        <title>Specifying a system role</title>
+        <abstract>
+          <para></para>
+        </abstract>
+      </merge>
+    </module>
+    <module resourceref="_virt-components-installation-patterns" renderas="section">
+      <merge>
+        <title>Specifying installation patterns</title>
+        <abstract>
+          <para></para>
+        </abstract>
+      </merge>
+    </module>
+    <module resourceref="_virt-components-installation-yast" renderas="section">
+      <merge>
+        <title>Using the &yast; virtualization module</title>
+        <abstract>
+          <para></para>
+        </abstract>
+      </merge>
+    </module>
+    <module resourceref="_legal"/>
+    <module resourceref="_gfdl">
+      <output renderas="appendix"/>
+    </module>
+  </structure>
+</assembly>
diff --git a/glues/virt-components-intro.xml b/glues/virt-components-intro.xml
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
+<!-- This file can be edited downstream. -->
+<!DOCTYPE topic
+[
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for naming conventions -->
+<!-- metadata is dealt with on the assembly level -->
+<topic xml:id="virt-components-intro"
+ role="glue" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook" version="5.2"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>
+    <title>Introduction to virtualization tools</title>
+    <meta name="maintainer" content="[email protected]" its:translate="no"/>
+    <abstract>
+      <xi:include href="../snippets/virt-components-intro.xml"/>
+    </abstract>
+  </info>
+  <para>
+    You can install the virtualization tools required to run a &vmhost; in one
+    of the following ways:
+  </para>
+  <itemizedlist>
+    <listitem>
+      <para>
+        By selecting a specific system role during a &productname; installation
+        on the &vmhost;
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+        By installing specific installation patterns on an already installed
+        &productname; host
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+        By running the <emphasis>&yast; Virtualization</emphasis> module on an
+        already installed &productname; host
+      </para>
+    </listitem>
+  </itemizedlist>
+</topic>
diff --git a/images/virt-system-roles.png b/images/virt-system-roles.png
diff --git a/references/virt-components-installation-patterns.xml b/references/virt-components-installation-patterns.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
+<!-- This file can be edited downstream. -->
+<!DOCTYPE topic
+[
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for file and id naming conventions -->
+<!-- metadata is dealt with on the assembly level -->
+<topic xml:id="virt-components-installation-patterns"
+ role="reference" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook" version="5.2"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>
+    <title>Installation patterns for virtualization components</title>
+    <meta name="maintainer" content="[email protected]" its:translate="no"/>
+    <abstract>
+      <xi:include href="../snippets/virt-components-intro.xml"/>
+    </abstract>
+  </info>
+  <para>
+    Related software packages from &productname; software repositories are
+    organized into <emphasis>installation patterns</emphasis>. You can use these
+    patterns to install specific virtualization components on an already running
+    &productname; system. Use <command>zypper</command> to install the patterns, for
+    example:
+  </para>
+<screen>&prompt.sudo;zypper install -t pattern <replaceable>kvm_server</replaceable></screen>
+  <variablelist>
+    <varlistentry>
+      <term><literal>kvm_server</literal></term>
+      <listitem>
+        <para>
+          Installs a basic &vmhost; with the &kvm; and &qemu; environments.
+        </para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><literal>kvm_tools</literal></term>
+      <listitem>
+        <para>
+          Installs &libvirt; tools for managing and monitoring &vmguest;s in
+          the &kvm; environment.
+        </para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><literal>xen_server</literal></term>
+      <listitem>
+        <para>
+          Installs a basic &xen; &vmhost;.
+        </para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><literal>xen_tools</literal></term>
+      <listitem>
+        <para>
+          Installs &libvirt; tools for managing and monitoring &vmguest;s in
+          the &xen; environment.
+        </para>
+      </listitem>
+    </varlistentry>
+  </variablelist>
+</topic>
diff --git a/snippets/virt-components-intro.xml b/snippets/virt-components-intro.xml
@@ -0,0 +1,12 @@
+<!DOCTYPE para [
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+  %entities;
+]>
+<para  xmlns="http://docbook.org/ns/docbook"  version="5.2"
+xmlns:xi="http://www.w3.org/2001/XInclude"
+xmlns:xlink="http://www.w3.org/1999/xlink">
+  To run a virtualization server (&vmhost;) that can host multiple guest systems
+  (&vmguest;s), you need to install required virtualization components on the
+  server. These components vary depending on which virtualization technology you
+  want to use.
+</para>