DOCTEAM-1713 Managing Virtual machines through Cockpit -Added new topics

articles/cockpit.asm.xml

@@ -22,13 +22,15 @@ xmlns="http://docbook.org/ns/docbook">
 <resource href="../concepts/cockpit-selinux.xml" xml:id="_cockpit-selinux"/> 
 <resource href="../concepts/cockpit-system-update.xml" xml:id="_cockpit-system-update"/>
 <resource href="../concepts/cockpit-packages.xml" xml:id="_cockpit-packages"/>
+<resource href="../concepts/cockpit-virtual-machines.xml" xml:id="_cockpit-virtual-machines"/>
 <!-- glue -->
 <resource href="../glues/cockpit-managing-filesystem.xml" xml:id="_cockpit-managingfs-glue"/> 
 <resource href="../glues/cockpit-storage-plugin.xml" xml:id="_cockpit-storage-plugin"/> 
 <resource href="../glues/cockpit-networking-plugin.xml" xml:id="_cockpit-networking-plugin"/> 
 <resource href="../glues/cockpit-containers-plugin.xml" xml:id="_cockpit-containers-plugin"/> 
 <resource href="../glues/cockpit-user-management.xml" xml:id="_cockpit-user-management"/> 
 <resource href="../glues/cockpit-managing-services.xml" xml:id="_cockpit-managing-services"/>
+<resource href="../glues/cockpit-virtual-machines-plugin.xml" xml:id="_cockpit-virtual-machines-plugin"/>
 <!-- tasks -->
 <resource href="../tasks/cockpit-primary-servers.xml" xml:id="_cockpit-primary-servers"/> 
 <resource href="../tasks/cockpit-secondary-servers.xml" xml:id="_cockpit-secondary-servers"/> 
@@ -66,6 +68,11 @@ xmlns="http://docbook.org/ns/docbook">
 <resource href="../tasks/cockpit-manage-subscriptions.xml" xml:id="_cockpit-manage-subscriptions"/>
 <resource href="../tasks/cockpit-software-repositories.xml" xml:id="_cockpit-software-repositories"/> 
 <resource href="../tasks/cockpit-troubleshooting-selinux.xml" xml:id="_cockpit-troubleshooting-selinux"/>
+<resource href="../tasks/cockpit-managing-networks.xml" xml:id="_cockpit-managing-networks"/>
+<resource href="../tasks/cockpit-managing-storage-pools.xml" xml:id="_cockpit-storage-pools"/>
+<resource href="../tasks/cockpit-managing-virtual-machines.xml" xml:id="_cockpit-managing-virtual-machines"/>
+<resource href="../tasks/cockpit-creating-virtual-machines.xml" xml:id="_cockpit-creating-virtual-machines"/>
+<resource href="../tasks/cockpit-installing-virtual-machines.xml" xml:id="_cockpit-installing-virtual-machines"/>
 <!-- references -->
 <resource href="../references/cockpit-logs.xml" xml:id="_cockpit-logs-reference"/> 
 </resources>
@@ -83,7 +90,7 @@ xmlns="http://docbook.org/ns/docbook">
 <title>Administering &productname; Using &cockpit;</title>
 <!-- History -->
 <revhistory xml:id="rh-sles-cockpit">
-<revision><date>2025-11-04</date>
+<revision><date>2026-01-02</date>
 <revdescription>
 <para>
 Initial version
@@ -289,10 +296,8 @@ zone.
 <merge>
 <title>Managing RAID using &cockpit;</title>
 <abstract>
-<para>
-Using &cockpit;, you can create or modify software RAID of
-different levels.
-</para>
+<para>Using &cockpit;, you can create or modify software RAID of
+different levels.</para>
 </abstract>
 </merge>
 <module renderas="section" resourceref="_cockpit-creating-raids">
@@ -357,6 +362,18 @@ different levels.
 <module renderas="section" resourceref="_cockpit-managing-bridge"/>
 <module renderas="section" resourceref="_cockpit-managing-vlans"/>
 </module>
+<module renderas="section" resourceref="_cockpit-virtual-machines-plugin">
+<merge>
+<abstract>
+<para/>
+</abstract>
+</merge>
+<module renderas="section" resourceref="_cockpit-creating-virtual-machines"/>
+<module renderas="section" resourceref="_cockpit-installing-virtual-machines"/>
+<module renderas="section" resourceref="_cockpit-managing-virtual-machines"/>
+<module renderas="section" resourceref="_cockpit-storage-pools"/>
+<module renderas="section" resourceref="_cockpit-managing-networks"/>
+</module>
 <module renderas="section" resourceref="_cockpit-containers-plugin">
 <merge>
 <abstract>

concepts/cockpit-storage-pools.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!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="concept-storage-pools"
+ role="concept" 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>Managing storage pools</title>
+    <meta name="maintainer" content="shalaka.harne@suse.com" its:translate="no"/>
+    <abstract>
+  <para>A storage pool is a storage resource on the VM Host Server that can be used for storing volumes (VM guest disks and partitions). &cockpit; enables you to create storage pools and manage them.</para>
+    </abstract>
+  </info>
+<para></para>
+</topic>

glues/cockpit-virtual-machines-plugin.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic
+[
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<topic xml:id="glue-cockpit-vm"
+ 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>Managing virtual machines using &cockpit;</title>
+    <meta name="maintainer" content="shalaka.harne@suse.com"/>
+  </info>
+  <para>
+The <guimenu>Virtual machines</guimenu> section allows you to view, create and manage virtual machines, storage pools and networks, and also to import virtual machines.
+  </para>
+<note>
+<title><guimenu>Virtual machines</guimenu> not visible</title>
+  <para>If you do not see the plug-in in your &cockpit; instance, you need to install the <literal>kvm_server</literal> pattern.</para>
+  <screen>&prompt.sudo; zypper install -t pattern kvm_server
+&prompt.sudo; systemctl enable --now libvirtd
+  </screen>
+  </note>
+<para>Using the <guimenu>Virtual machines</guimenu> screen,  you can perform the following tasks:</para>
+  <itemizedlist>
+<listitem><para>Install virtual machines in <xref linkend="task-install-cockpit-vm"/></para></listitem>
+<listitem><para>Create virtual machines in <xref linkend="section-create-vm"></xref></para></listitem>
+<listitem><para>Modify virtual machine configurations in <xref linkend="task-managing-vm-cockpit"/></para></listitem>
+<listitem><para>Import a virtual machine in <xref linkend="section-import-vm"/></para></listitem>
+<listitem><para>Clone a virtual machine in <xref linkend="section-clone-vm"/></para></listitem>
+<listitem><para>Rename a virtual machine in <xref linkend="section-rename-vm"/></para></listitem>
+<listitem><para>Delete a virtual machine in <xref linkend="section-delete-vm"/></para></listitem>
+</itemizedlist>
+</topic>

tasks/cockpit-creating-virtual-machines.xml

@@ -0,0 +1,160 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!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="section-create-vm"
+ role="task" 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>Creating virtual machines using &cockpit;</title>
+    <meta name="maintainer" content="shalaka.harne@suse.com" its:translate="no"/>
+    <abstract>
+    <para>The &cockpit; Web console allows you to create virtual machines.</para>
+  </abstract>
+  </info>
+  <para>To create a virtual machine using &cockpit;:</para>
+    <procedure>
+    <step>
+      <para>
+        Navigate to the <guimenu>Virtual machines</guimenu> page.
+      </para>
+    </step>
+    <step>
+      <para>
+        Click <guimenu>Create VM</guimenu>.
+      </para>
+    </step>
+    <step>
+      <para>
+        Select the <guilabel>Connection</guilabel> as either <guimenu>System</guimenu> or  <guimenu>User session</guimenu>.</para>
+      <para>For more information on the connections, click the information icon next to <guimenu>Connection</guimenu>.</para>
+      </step>
+    <step><para>Select an installation type from the drop-down list and proceed with creating the VM.</para>
+      <itemizedlist>
+        <listitem><para><xref linkend="download-OS"/></para>
+        <para>For this installation type, &cockpit; provides a list of popular Linux distributions (Fedora, Ubuntu, Rocky Linux, etc.). It automatically downloads the official ISO and starts the installer.</para></listitem>
+        <listitem><para><xref linkend="cloud-base-image"/></para>
+        <para>For this installation type, you create a virtual machine from the cloud image file on the host's file system. You must provide the path to the file for this. This installation type supports unattended installation, where you can pre-fill a username, password, and SSH key in &cockpit;. The VM then boots and configures itself automatically.</para></listitem>
+        <listitem><para><xref linkend="local-install-media"/></para>
+        <para>For this installation type, you manually provide a path to an .iso file already stored on your server’s hard drive.</para></listitem>
+        <listitem><para><xref linkend="URL"/></para>
+        <para>For this installation type, you provide a Web link to an installation tree (common for automated network installs).</para></listitem>
+        <listitem><para><xref linkend="network-boot-PXE"/></para>
+        <para>For this installation type, the system boots the VM from a network server. This is typically used in enterprise environments with existing deployment infrastructure.</para></listitem>
+      </itemizedlist>
+    </step>
+  </procedure>
+  <section xml:id="download-OS"><title >Download an OS</title>
+    <para>
+    You can select <guilabel>Download an OS</guilabel> to create a VM with your preferred OS. &cockpit; provides a list of popular Linux distributions (like OpenSUSE Leap, Fedora, Ubuntu, or CentOS). When you select the distribution, &cockpit; downloads the official ISO image from the internet and creates a VM based on the given configurations. </para>
+  <procedure>
+    <step><para>Select the distribution from the <guilabel>Operating system</guilabel> drop-down list.</para></step>
+    <step>
+      <para>
+        Define the <guimenu>Storage limit</guimenu> and <guimenu>Memory</guimenu>.</para>
+        <para>The available storage limit and memory are displayed so that you can configure the storage limit and memory accordingly. </para>
+    </step>
+    <step>
+      <para>To run the VM after creation, click <guimenu>Create and run</guimenu>.</para>
+    <para>The virtual machine has been installed.</para>
+    </step>
+    <step><para>To edit the VM parameters after creation, click <guimenu>Create and edit</guimenu>.</para>
+    <para>Modify the parameters and click <guimenu>Install</guimenu>.</para>
+  <para>For more information on modifying the parameters, see <xref linkend="task-managing-vm-cockpit"/>.</para></step>
+  </procedure></section>
+
+  <section xml:id="cloud-base-image"><title>Cloud base image</title>
+    <para>
+    You can create a virtual machine from the cloud image file on the host's file system. You must provide the path to the file for this. This installation type supports unattended installation, where you can pre-fill a username, password, and SSH key in &cockpit;. The VM then boots and configures itself automatically.  
+  </para>
+  <procedure>
+    <step><para>Select the path to the cloud image file on the host's file system from the <guilabel>Installation source</guilabel> drop-down list.</para>
+    </step>
+    <step><para>Select the distribution from the <guilabel>Operating system</guilabel> drop-down list.</para></step>
+    <step>
+      <para>
+        Define the <guimenu>Storage limit</guimenu> and <guimenu>Memory</guimenu>.</para>
+        <para>The available storage limit and memory are displayed so that you can configure the storage limit and memory accordingly. </para>
+    </step>
+    <step>
+      <para>To run the VM after creation, click <guimenu>Create and run</guimenu>.</para>
+    <para>The virtual machine has been installed.</para>
+    </step>
+    <step><para>To edit the VM parameters after creation, click <guimenu>Create and edit</guimenu>.</para>
+    <para>Modify the parameters and click <guimenu>Install</guimenu>.</para>
+  <para>For more information on modifying the parameters, see <xref linkend="task-managing-vm-cockpit"/>.</para></step>
+  </procedure></section>
+  <section xml:id="local-install-media"><title>Local installation media (ISO image or distro install tree)</title>
+    <para>
+    You can create a VM from the local installation media using the path to the ISO file on the host's file system. In this, you must provide the direct file path in which the ISO image is stored, and the VM boots from that local file and begins the installation.
+  </para>
+  <procedure>
+     <step><para>Select the path to the ISO file on the host's file system from the <guilabel>Installation source</guilabel> drop-down list.</para>
+    </step>
+    <step><para>Select the distribution from the <guilabel>Operating system</guilabel> drop-down list.</para></step>
+   <step>
+      <para>
+        Define the <guimenu>Storage limit</guimenu> and <guimenu>Memory</guimenu>.</para>
+        <para>The available storage limit and memory are displayed so that you can configure the storage limit and memory accordingly. </para>
+    </step>
+    <step>
+      <para>To run the VM after creation, click <guimenu>Create and run</guimenu>.</para>
+   <para>The virtual machine has been installed.</para>
+    </step>
+    <step><para>To edit the VM parameters after creation, click <guimenu>Create and edit</guimenu>.</para>
+    <para>Modify the parameters and click <guimenu>Install</guimenu>.</para>
+  <para>For more information on modifying the parameters, see <xref linkend="task-managing-vm-cockpit"/>.</para></step>
+  </procedure></section>
+  <section xml:id="URL"><title>URL (ISO image or distro install tree)</title>
+    <para>
+   You can create a virtual machine by downloading the OS from a URL of the ISO image or distro install tree. In this type of installation, you can point the VM to a remote installation source via a web link (HTTP/HTTPS/FTP). It is particularly useful for network-based installations where the host doesn't have the image saved locally but can pull the necessary boot files directly from a public or private mirror.
+  </para>
+  <procedure>
+     <step><para>Specify the URL of the ISO file in the <guilabel>Installation source</guilabel>.</para>
+    </step>
+    <step><para>Select the distribution from the <guilabel>Operating system</guilabel> drop-down list.</para></step>
+    <step>
+      <para>
+        Define the <guimenu>Storage limit</guimenu> and <guimenu>Memory</guimenu>.</para>
+        <para>The available storage limit and memory are displayed so that you can configure the storage limit and memory accordingly. </para>
+    </step>
+    <step>
+      <para>To run the VM after creation, click <guimenu>Create and run</guimenu>.</para>
+   <para>The virtual machine has been installed.</para>
+    </step>
+    <step><para>To edit the VM parameters after creation, click <guimenu>Create and edit</guimenu>.</para>
+    <para>Modify the parameters and click <guimenu>Install</guimenu>.</para>
+  <para>For more information on modifying the parameters, see <xref linkend="task-managing-vm-cockpit"/>.</para></step>
+  </procedure></section>
+  <section xml:id="network-boot-PXE"><title>Network boot (PXE)</title>
+    <para>
+    You can create a VM by installing the OS over the network using the Network boot PXE (Preboot eXecution Environment). In this type of installation, the VM starts without a local OS and requests boot files from a PXE server over the network. The PXE server supplies the bootloader, kernel, initrd, and OS installation files, allowing the operating system to install directly from the network.
+  </para>
+  <procedure>
+    <step><para>Select the installation source from the <guilabel>Installation source</guilabel> drop-down list.</para>
+    </step>
+    <step><para>Select the distribution from the <guilabel>Operating system</guilabel> drop-down list.</para></step>
+    <step>
+      <para>
+        Define the <guimenu>Storage limit</guimenu> and <guimenu>Memory</guimenu>.</para>
+        <para>The available storage limit and memory are displayed so that you can configure the storage limit and memory accordingly. </para>
+    </step>
+    <step>
+      <para>To run the VM after creation, click <guimenu>Create and run</guimenu>.</para>
+      <para>The virtual machine has been installed.</para>
+    </step>
+    <step><para>To edit the VM parameters after creation, click <guimenu>Create and edit</guimenu>.</para>
+    <para>Modify the parameters and click <guimenu>Install</guimenu>.</para>
+  <para>For more information on modifying the parameters, see <xref linkend="task-managing-vm-cockpit"/>.</para></step>
+  </procedure></section>
+</topic>

tasks/cockpit-installation.xml

@@ -31,7 +31,7 @@
   &cockpit; can be installed during the system installation using &agama;, or you can install it
   later from the running system. To verify if &cockpit; is installed on your system, run:
   </para>
-  <screen os="sles">&prompt.user;<command>zypper se -i cockpit</command></screen>
+  <screen os="sles">&prompt.sudo;<command>zypper se -i cockpit</command></screen>
   <para os="sles">
   If &cockpit; is not installed, proceed as described in <xref linkend="cockpit-installing-cockpit"/>.
   </para>
@@ -91,9 +91,9 @@
           </step>
           <step>
             <para>
-              Restart <literal>cockpit.socket</literal> by running:
+               Install &selnx; policies for &cockpit; and restart <literal>cockpit.socket</literal> by running:
             </para>
-<screen>&prompt.sudo;<command>sudo zypper in -f cockpit-selinux-policies &amp;&amp; sudo systemctl restart cockpit.socket</command></screen>
+<screen>&prompt.sudo;<command>zypper in -f cockpit-selinux-policies &amp;&amp; sudo systemctl restart cockpit.socket</command></screen>
           </step>
         </substeps>
       </step>

tasks/cockpit-installing-virtual-machines.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!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="task-install-cockpit-vm"
+ role="task" 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>Installing a virtual machine using &cockpit;</title>
+    <meta name="maintainer" content="shalaka.harne@suse.com" its:translate="no"/>
+    <abstract>
+    <para> To install an already created VM, navigate to the <guimenu>Virtual machines</guimenu> page and click <guimenu>Install</guimenu> corresponding to the VM.</para>
+  </abstract>
+  </info>
+
+  <note>
+    <para>You can also create a VM and install it.</para>
+  <para>For more information on creating a VM, see <xref linkend="section-create-vm"/>.</para>
+    </note>
+</topic>