Skip to content

Commit 911fe1e

Browse files
authored
Merge pull request #61715 from danielclowers/CNV-26876
CNV-26876: Document golden images
2 parents 80ff67e + 793f6a4 commit 911fe1e

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

modules/virt-golden-images.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="virt-about-golden-images_{context}"]
7+
= About golden images
8+
9+
A golden image is a pre-configured snapshot of a virtual machine (VM) that you can use as a resource to deploy new VMs. For example, you can use golden images to provision the same system environment consistently and deploy systems more quickly and efficiently.
10+
11+
[id="virt-how-golden-images-work_{context}"]
12+
== How do golden images work?
13+
14+
Golden images are created by installing and configuring an operating system and software applications on a reference machine or virtual machine. This includes setting up the system, installing required drivers, applying patches and updates, and configuring specific options and preferences.
15+
16+
After the golden image is created, it is saved as a template or image file that can be replicated and deployed across multiple clusters. The golden image can be updated by its maintainer periodically to incorporate necessary software updates and patches, ensuring that the image remains up to date and secure, and newly created VMs are based on this updated image.
17+
18+
[id="virt-golden-images-implementation_{context}"]
19+
== Red Hat implementation of golden images
20+
21+
Red Hat publishes golden images as container disks in the registry for versions of :op-system-base:. Container disks are virtual machine images that are stored as a container image in a container image registry. Any published image will automatically be made available in connected clusters after the installation of OpenShift Virtualization. After the images are available in a cluster, they are ready to use to create VMs.

virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
You can build a virtual machine image into a container disk and store it in your container registry. You can then import the container disk into persistent storage for a virtual machine or attach it directly to the virtual machine for ephemeral storage.
9+
You can build a virtual machine image into a container disk, commonly known as a golden image, and store it in your container registry. You can then import the container disk into persistent storage for a virtual machine or attach it directly to the virtual machine for ephemeral storage.
1010

1111
[IMPORTANT]
1212
====
@@ -16,6 +16,7 @@ If you use large container disks, I/O traffic might increase, impacting worker n
1616
* xref:../../../nodes/nodes/nodes-nodes-garbage-collection.adoc#nodes-nodes-garbage-collection-configuring_nodes-nodes-configuring[Configuring garbage collection]
1717
====
1818

19+
include::modules/virt-golden-images.adoc[leveloffset=+1]
1920
include::modules/virt-about-container-disks.adoc[leveloffset=+1]
2021
include::modules/virt-preparing-container-disk-for-vms.adoc[leveloffset=+1]
2122

0 commit comments

Comments
 (0)