1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

CNV-5775 Create a user story around the default OS images concept and flow

This commit is contained in:
Bob Gaydos
2021-05-12 17:34:59 -04:00
committed by openshift-cherrypick-robot
parent 69b326c775
commit ec33f92039
4 changed files with 33 additions and 21 deletions

View File

@@ -2786,7 +2786,7 @@ Topics:
File: virt-storage-defaults-for-datavolumes
- Name: Creating and using boot sources
File: virt-creating-and-using-boot-sources
Name: Hot-plugging virtual disks
- Name: Hot-plugging virtual disks
File: virt-hot-plugging-virtual-disks
- Name: Using container disks with virtual machines
File: virt-using-container-disks-with-vms

View File

@@ -0,0 +1,17 @@
// Module included in the following assemblies:
//
// * virt/virtual_machines/virtual_disks/virt-creating-and-using-boot-sources.adoc
// * virt/vm_templates/virt-creating-vm-template.adoc
[id="virt-about-vms-and-boot-sources_{context}"]
= About virtual machines and boot sources
Virtual machines consist of a virtual machine definition and one or more disks that are backed by data volumes. Virtual machine templates enable you to create virtual machines using predefined virtual machine specifications.
To use the boot sources feature, install the latest release of {VirtProductName}. The namespace `openshift-virtualization-os-images` enables the feature and is installed with the {VirtProductName} Operator.
Once the boot source feature is installed, you can create boot sources, attach them to templates, and create virtual machines from the templates.
Every virtual machine template requires a boot source, which is a fully configured virtual machine disk image including configured drivers. Each virtual machine template contains a virtual machine definition with a pointer to the boot source. Each boot source has a predefined name and namespace. For some operating systems, a boot source is automatically provided. If it is not provided, then an administrator must prepare a custom boot source.
Define a boot source by using a persistent volume claim (PVC) that is populated by uploading a local file, cloning an existing PVC, importing from a registry, or by URL. Attach a boot source to a virtual machine template by using the web console. After the boot source is attached to a virtual machine template, you create any number of fully configured ready-to-use virtual machines from the template.

View File

@@ -5,28 +5,21 @@ include::modules/virt-document-attributes.adoc[]
toc::[]
A _boot source_ contains a bootable operating system (OS) and all of the configuration settings for the OS, such as drivers.
include::modules/virt-about-vms-and-boot-sources.adoc[leveloffset=+1]
You use a boot source to create virtual machine templates with specific configurations. These templates can be used to create any number of available virtual machines.
include::modules/virt-importing-rhel-image-boot-source-web.adoc[leveloffset=+1]
.Prerequisites
* To add a boot source, you must be logged in as a user with the `os-images.kubevirt.io:edit` RBAC role or as an administrator. You do not need special privileges to create a virtual machine from a template with a boot source attached.
[NOTE]
====
For information about requirements for Microsoft Windows, refer to link:https://www.openshift.com/blog/creating-an-operating-system-image-using-the-microsoft-windows-installation-media-with-openshift-virtualization[Creating installation media for Windows boot sources].
====
// Commenting this module with list of supported DV names for 2.6. It is relevant only to 2.6.1 when the CLI flow is introduced
// include::modules/virt-using-supported-boot-source-names.adoc[leveloffset=+1]
// Placeholder for module CNV-9002 Importing (Preparing?) a custom boot source image on Linux
include::modules/virt-adding-a-boot-source-web.adoc[leveloffset=+1]
include::modules/virt-creating-a-vm-from-a-template-with-an-attached-boot-source.adoc[leveloffset=+1]
include::modules/virt-importing-rhel-image-boot-source-web.adoc[leveloffset=+1]
[id="additional-resources_creating-and-using-boot-sources"]
== Additional resources
* xref:../../../virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-web.adoc#virt-uploading-local-disk-images-web[Uploading local disk images]
* xref:../../../virt/virtual_machines/virt-create-vms.adoc#virt-create-vms[Creating virtual machines]
* xref:../../../virt/vm_templates/virt-creating-vm-template.adoc#virt-create-vms[Creating virtual machine templates]
* link:https://www.openshift.com/blog/creating-windows-virtual-machines-from-existing-images-with-openshift-virtualization[Creating a Microsoft Windows boot source from a cloud image]
* link:https://www.openshift.com/blog/customizing-virtual-machine-templates-in-openshift-1[Customizing existing Microsoft Windows boot sources in {product-title}]
* link:https://www.openshift.com/blog/creating-default-os-images-to-auto-clone-in-openshift-virtualization[Setting a PVC as a boot source for a Microsoft Windows template using the CLI]
* link:https://www.openshift.com/blog/creating-a-windows-base-image-for-openshift[Creating boot sources using automated scripting]
* link:https://www.openshift.com/blog/automatic-installation-of-a-windows-vm-using-openshift-virtualization[Creating a boot source automatically within a pod]

View File

@@ -6,6 +6,7 @@ include::modules/virt-document-attributes.adoc[]
toc::[]
include::modules/virt-about-vm-templates.adoc[leveloffset=+1]
include::modules/virt-about-vms-and-boot-sources.adoc[leveloffset=+1]
include::modules/virt-adding-a-boot-source-web.adoc[leveloffset=+1]
include::modules/virt-template-fields-for-boot-source.adoc[leveloffset=+2]
include::modules/virt-marking-vm-templates-favorites.adoc[leveloffset=+1]
@@ -25,6 +26,7 @@ include::modules/virt-storage-wizard-fields-web.adoc[leveloffset=+2]
include::modules/virt-cloud-init-fields-web.adoc[leveloffset=+2]
:vmtemplate!:
== Additional Resources
* See xref:../../virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc#virt-configuring-sriov-device-for-vms[Configuring the SR-IOV Network Operator] for further details on the SR-IOV Network Operator.
[id="additional-resources_creating-vm-template"]
== Additional resources
* xref:../../virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc#virt-configuring-sriov-device-for-vms[Configuring the SR-IOV Network Operator]
* xref:../../virt/virtual_machines/virtual_disks/virt-creating-and-using-boot-sources.adoc#virt-creating-and-using-boot-sources[Creating and using boot sources]