Skip to content

[enterprise-4.20] DOCPLAN#193 - DITA compliance for getting started page #109573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ousleyp merged 1 commit into from
Apr 6, 2026
Merged

[enterprise-4.20] DOCPLAN#193 - DITA compliance for getting started page #109573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions modules/virt-getting-started-tour.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Module included in the following assemblies:
//
// * virt/getting_started/virt-getting-started.adoc

:_mod-docs-content-type: PROCEDURE
[id="virt-getting-started-tour_{context}"]
= Getting started tour

[role="_abstract"]
The *Getting started* tour introduces several key aspects of using {VirtProductName}. There are two ways to start the tour.

.Prerequisites

* You have access to the {product-title} web console.

.Procedure

* If you see the *Welcome to {VirtProductName}* dialog, click *Start Tour*.
* Otherwise, go to *Virtualization* -> *Overview* -> *Settings* -> *User* -> *Getting started resources* -> *Guided tour*.
19 changes: 19 additions & 0 deletions modules/virt-quick-starts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Module included in the following assemblies:
//
// * virt/getting_started/virt-getting-started.adoc

:_mod-docs-content-type: PROCEDURE
[id="virt-quick-starts_{context}"]
= Quick start tours

[role="_abstract"]
You can explore several {VirtProductName} capabilities by taking quick start tours in the web console.

.Prerequisites

* You have access to the {product-title} web console.

.Procedure

. Click the *Help* icon *?* in the menu bar on the header of the {product-title} web console.
. Select *Quick Starts*. You can filter the list of tours by entering the keyword `virtual` in the *Filter* field.
145 changes: 37 additions & 108 deletions virt/getting_started/virt-getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,131 +6,60 @@ include::_attributes/common-attributes.adoc[]

toc::[]

You can explore the features and functionalities of {VirtProductName} by installing and configuring a basic environment.
[role="_abstract"]
Explore {VirtProductName} by taking guided tours, installing the Operator, and configuring a basic environment. Learn how to migrate from your current platform, then learn more about how to deploy and manage virtual machines (VMs) by following the additional resources links.

[NOTE]
====
Cluster configuration procedures require `cluster-admin` privileges.
====

// Hiding in ROSA/OSD for now - unsure if supported
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
[id="tours-quick-starts_{context}"]
== Tours and quick starts

You can start exploring {VirtProductName} by taking tours in the {product-title} web console.

[discrete]
[id="virt-intro-tour_{context}"]
=== Getting started tour

This short guided tour introduces several key aspects of using {VirtProductName}. There are two ways to start the tour:

* On the *Welcome to {VirtProductName}* dialog, click *Start Tour*.
* Go to *Virtualization* -> *Overview* -> *Settings* -> *User* -> *Getting started resources* and click *Guided tour*.

[discrete]
[id="virt-quick-starts_{context}"]
=== Quick starts

Quick start tours are available for several {VirtProductName} features. To access quick starts, complete the following steps:

. Click the *Help* icon *?* in the menu bar on the header of the {product-title} web console.
. Select *Quick Starts*.

You can filter the available tours by entering the keyword `virtual` in the *Filter* field.
include::modules/virt-getting-started-tour.adoc[leveloffset=+1]
include::modules/virt-quick-starts.adoc[leveloffset=+1]
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
include::modules/migrating-to-virt.adoc[leveloffset=+1]

[id="planning-and-installing-virt_{context}"]
== Planning and installing {VirtProductName}

Plan and install {VirtProductName} on an {product-title} cluster:

// Hiding in ROSA/OSD, not supported
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
* xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#virt-planning-bare-metal-cluster-for-ocp-virt_preparing-to-install-on-bare-metal[Plan your bare metal cluster for {VirtProductName}].
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
* xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Prepare your cluster for {VirtProductName}].
* xref:../../virt/install/installing-virt.adoc#virt-installing-virt-operator_installing-virt[Install the {VirtProductName} Operator].
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#installing-virtctl_virt-using-the-cli-tools[Install the `virtctl` command-line interface (CLI) tool].


[discrete]
[id="additional-resources_planning-and-installing"]
[role="_additional-resources"]
=== Planning and installation resources
== Additional resources

* xref:../../virt/install/preparing-cluster-for-virt.adoc#virt-about-storage-volumes-for-vm-disks_preparing-cluster-for-virt[About storage volumes for virtual machine disks].
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Using a CSI-enabled storage provider].
* xref:../../virt/storage/virt-configuring-local-storage-with-hpp.adoc#virt-configuring-local-storage-with-hpp[Configuring local storage for virtual machines].
// Hiding in ROSA/OSD, as feature is TP
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
* xref:../../networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#installing-the-kubernetes-nmstate-operator-cli[Installing the Kubernetes NMState Operator].
* xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#virt-planning-bare-metal-cluster-for-ocp-virt_preparing-to-install-on-bare-metal[Plan your bare-metal cluster for {VirtProductName}]
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
* xref:../../virt/managing_vms/advanced_vm_management/virt-specifying-nodes-for-vms.adoc#virt-specifying-nodes-for-vms[Specifying nodes for virtual machines].
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#virtctl-commands_virt-using-the-cli-tools[`Virtctl` commands].

[id="creating-and-managing-vms_{context}"]
== Creating and managing virtual machines

Create a virtual machine (VM):

* xref:../../virt/creating_vms_advanced/creating_vms_advanced_web/virt-creating-vms-from-rh-images-overview.adoc#virt-creating-vms-from-rh-images-overview[Create a VM from a Red Hat image].
* xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Prepare your cluster for {VirtProductName}]
* xref:../../virt/install/preparing-cluster-for-virt.adoc#virt-about-storage-volumes-for-vm-disks_preparing-cluster-for-virt[Learn about storage volumes for VM disks]
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Use a CSI-enabled storage provider]
* xref:../../virt/storage/virt-configuring-local-storage-with-hpp.adoc#virt-configuring-local-storage-with-hpp[Configure local storage for virtual machines]
* xref:../../virt/install/installing-virt.adoc#installing-virt-operator_installing-virt[Install the {VirtProductName} Operator]
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
+
You can create a VM by using a Red Hat template or an xref:../../virt/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[instance type].
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
+
You can create a VM by using a Red Hat template.
* xref:../../networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#installing-the-kubernetes-nmstate-operator-cli[Install the Kubernetes NMState Operator]
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]

* You can create a VM by xref:../../virt/creating_vms_advanced/creating_vms_advanced_web/virt-creating-vms-from-web-images.adoc#virt-creating-vms-from-web-images[importing a custom image from a container registry or a web page], by xref:../../virt/creating_vms_advanced/creating_vms_advanced_web/virt-creating-vms-uploading-images.adoc#virt-creating-vms-uploading-images[uploading an image from your local machine], or by xref:../../virt/creating_vms_advanced/creating_vms_cli/virt-creating-vms-by-cloning-pvcs.adoc#virt-creating-vms-by-cloning-pvcs[cloning a persistent volume claim (PVC)].

Connect a VM to a secondary network:

// Linux bridge and SR-IOV not supported in ROSA/OSD
* xref:../../virt/managing_vms/advanced_vm_management/virt-specifying-nodes-for-vms.adoc#virt-specifying-nodes-for-vms[Specify nodes for virtual machines]
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#installing-virtctl_virt-using-the-cli-tools[Install the `virtctl` command-line interface (CLI) tool]
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#virtctl-commands_virt-using-the-cli-tools[Use `virtctl` commands]
* xref:../../virt/creating_vms_advanced/creating_vms_advanced_web/virt-creating-vms-from-rh-images-overview.adoc#virt-creating-vms-from-rh-images-overview[Create a VM from a Red{nbsp}Hat image]
* xref:../../virt/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[Create a VM from an instance type]
* xref:../../virt/creating_vms_advanced/creating_vms_advanced_web/virt-creating-vms-from-web-images.adoc#virt-creating-vms-from-web-images[Import a custom image from a web page]
* xref:../../virt/creating_vms_advanced/creating_vms_advanced_web/virt-creating-vms-uploading-images.adoc#virt-creating-vms-uploading-images[Upload an image from your local machine]
* xref:../../virt/creating_vms_advanced/creating_vms_cli/virt-creating-vms-by-cloning-pvcs.adoc#virt-creating-vms-by-cloning-pvcs[Clone a persistent volume claim (PVC)]
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Linux bridge network].
* xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Open Virtual Network (OVN)-Kubernetes secondary network].
* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Single Root I/O Virtualization (SR-IOV) network].
+
[NOTE]
====
VMs are connected to the pod network by default.
====
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Connect a VM to a Linux bridge network]
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
* xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Open Virtual Network (OVN)-Kubernetes secondary network].
+
[NOTE]
====
VMs are connected to the pod network by default.
====
* xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Connect a VM to an Open Virtual Network (OVN)-Kubernetes secondary network]
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Connect a VM to a Single Root I/O Virtualization (SR-IOV) network]
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]

Connect to a VM:

* Connect to the xref:../../virt/managing_vms/virt-accessing-vm-consoles.adoc#serial-console_virt-accessing-vm-consoles[serial console] or xref:../../virt/managing_vms/virt-accessing-vm-consoles.adoc#vnc-console_virt-accessing-vm-consoles[VNC console] of a VM.
* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#virt-accessing-vm-ssh[Connect to a VM by using SSH].
* xref:../../virt/managing_vms/virt-accessing-vm-consoles.adoc#desktop-viewer_virt-accessing-vm-consoles[Connect to the desktop viewer for Windows VMs].

Manage a VM:

* xref:../../virt/managing_vms/virt-controlling-vm-states.adoc#virt-controlling-vm-states[Manage a VM by using the web console].
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#virtctl-commands_virt-using-the-cli-tools[Manage a VM by using the `virtctl` CLI tool].
* xref:../../virt/managing_vms/virt-exporting-vms.adoc#virt-accessing-exported-vm-manifests_virt-exporting-vms[Export a VM].

include::modules/migrating-to-virt.adoc[leveloffset=+1]

[id="next-steps_{context}"]
== Next steps

* xref:../../virt/post_installation_configuration/virt-post-install-config.adoc#virt-post-install-config[Review postinstallation configuration options].
* xref:../../virt/storage/virt-storage-config-overview.adoc#virt-storage-config-overview[Configure storage options and automatic boot source updates].
* xref:../../virt/monitoring/virt-monitoring-overview.adoc#virt-monitoring-overview[Learn about monitoring and health checks].
* xref:../../virt/live_migration/virt-about-live-migration.adoc#virt-about-live-migration[Learn about live migration].
* xref:../../virt/managing_vms/virt-accessing-vm-consoles.adoc#serial-console_virt-accessing-vm-consoles[Connect to the serial console of a VM]
* xref:../../virt/managing_vms/virt-accessing-vm-consoles.adoc#vnc-console_virt-accessing-vm-consoles[Connect to the VNC console of a VM]
* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#virt-accessing-vm-ssh[Connect to a VM by using SSH]
* xref:../../virt/managing_vms/virt-accessing-vm-consoles.adoc#desktop-viewer_virt-accessing-vm-consoles[Connect to the desktop viewer for Windows VMs]
* xref:../../virt/managing_vms/virt-controlling-vm-states.adoc#virt-controlling-vm-states[Manage a VM by using the web console]
* xref:../../virt/managing_vms/virt-exporting-vms.adoc#virt-accessing-exported-vm-manifests_virt-exporting-vms[Export a VM]
* xref:../../virt/post_installation_configuration/virt-post-install-config.adoc#virt-post-install-config[Review post-installation configuration options]
* xref:../../virt/storage/virt-storage-config-overview.adoc#virt-storage-config-overview[Configure storage options and automatic boot source updates]
* xref:../../virt/monitoring/virt-monitoring-overview.adoc#virt-monitoring-overview[Learn about monitoring and health checks]
* xref:../../virt/live_migration/virt-about-live-migration.adoc#virt-about-live-migration[Learn about live migration]
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
* xref:../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#installing-oadp-kubevirt[Back up and restore VMs by using the {oadp-first}].
* xref:../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#installing-oadp-kubevirt[Back up and restore VMs by using the {oadp-first}]
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
* link:https://access.redhat.com/articles/6994974[Tune and scale your cluster].
* link:https://access.redhat.com/articles/6994974[Tune and scale your cluster]