Skip to content

Commit c8606f3

Browse files
apinnickapinnick
authored
Merge pull request #46767 from bgaydosrh/CNV-16812
CNV-16812: Update Start Here page
2 parents d2c7150 + 5d26cc1 commit c8606f3

File tree

3 files changed

+64
-103
lines changed

3 files changed

+64
-103
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3058,7 +3058,7 @@ Topics:
30583058
- Name: About OKD Virtualization
30593059
File: about-virt
30603060
Distros: openshift-origin
3061-
- Name: Start here with OpenShift Virtualization
3061+
- Name: Getting started with OpenShift Virtualization
30623062
File: virt-learn-more-about-openshift-virtualization
30633063
Distros: openshift-enterprise
30643064
- Name: Start here with OKD Virtualization

‎virt/install/preparing-cluster-for-virt.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ If you install your cluster in xref:../../installing/installing-fips.adoc#instal
2727

2828
include::modules/virt-hardware-os-requirements.adoc[leveloffset=+1]
2929

30+
* If your cluster uses worker nodes with different CPUs, live migration failures can occur because different CPUs have different capabilities. To avoid such failures, use CPUs with appropriate capacity for each node and set node affinity on your virtual machines to ensure successful migration. See xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity-configuring-required_nodes-scheduler-node-affinity[Configuring a required node affinity rule] for more information.
31+
3032
[role="_additional-resources"]
3133
.Additional resources
3234

‎virt/virt-learn-more-about-openshift-virtualization.adoc

Lines changed: 61 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,68 @@
11
:_content-type: ASSEMBLY
22
[id="virt-learn-more-about-openshift-virtualization"]
33
include::_attributes/common-attributes.adoc[]
4-
= Start here with {VirtProductName}
4+
= Getting started with {VirtProductName}
55
:context: virt-learn-more-about-openshift-virtualization
66

77
toc::[]
88

9-
Use the following tables to find content to help you learn about and use {VirtProductName}.
10-
11-
[id="virt-learn-more-cluster-administrator"]
12-
== Cluster administrator
13-
14-
[options="header",cols="4*"]
15-
|===
16-
|Learn |Plan |Deploy |Additional resources
17-
18-
| xref:../virt/about-virt.adoc#about-virt[Learn about {VirtProductName}]
19-
| xref:../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Configuring your cluster for {VirtProductName}]
20-
| xref:../networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc#k8s-nmstate-updating-node-network-config[Updating your node network configuration]
21-
| xref:../virt/logging_events_monitoring/virt-collecting-virt-data.adoc#virt-collecting-virt-data[Getting Support]
22-
23-
| link:https://access.redhat.com/documentation/en-us/openshift_container_platform/[Learn more about {product-title}]
24-
| xref:../virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc#virt-features-for-storage[Plan storage for virtual machine disks]
25-
| xref:../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes]
26-
|
27-
28-
| xref:../virt/live_migration/virt-live-migration.adoc#virt-live-migration[Learn about virtual machine live migration]
29-
|
30-
| Installing {VirtProductName} using the xref:../virt/install/installing-virt-web.adoc#installing-virt-web[{VirtProductName} console] or xref:../virt/install/installing-virt-cli.adoc#installing-virt-cli[CLI]
31-
|
32-
33-
| xref:../virt/node_maintenance/virt-about-node-maintenance.adoc#virt-about-node-maintenance[Learn about node maintenance]
34-
|
35-
|
36-
|
37-
38-
|
39-
|===
40-
41-
[id="virt-learn-more-virtualization-administrator"]
42-
== Virtualization administrator
43-
44-
[options="header",cols="4*"]
45-
|===
46-
|Learn |Deploy |Manage |Use
47-
48-
| xref:../virt/about-virt.adoc#about-virt[Learn about {VirtProductName}]
49-
| Connecting virtual machines to the xref:../virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc#virt-using-the-default-pod-network-with-virt[default pod network for virtual machines] and xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-attaching-vm-multiple-networks[external networks]
50-
| xref:../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[Enabling the `virtctl` client]
51-
| xref:../migration_toolkit_for_containers/about-mtc.adoc#about-mtc[Importing virtual machines with the Migration Toolkit for containers]
52-
53-
| xref:../virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc#virt-features-for-storage[Learn about storage features for virtual machine disks]
54-
| xref:../virt/virtual_machines/virtual_disks/virt-creating-data-volumes.adoc#virt-customizing-storage-profile_virt-creating-data-volumes[Customizing the storage profile]
55-
| xref:../virt/virt-using-the-cli-tools.adoc#virt-using-the-cli-tools[Using the CLI tools]
56-
| xref:../virt/live_migration/virt-live-migration.adoc#virt-live-migration[Using live migration]
57-
58-
|
59-
| xref:../virt/virtual_machines/virtual_disks/virt-creating-and-using-boot-sources.adoc#virt-creating-and-using-boot-sources[Creating boot sources and attaching them to templates]
60-
| Viewing xref:../virt/logging_events_monitoring/virt-logs.adoc#virt-logs[logs] and xref:../virt/logging_events_monitoring/virt-events.adoc#virt-events[events]
61-
|
62-
63-
|
64-
| link:https://www.openshift.com/blog/updating-a-boot-source-image[Updating boot source templates]
65-
| xref:../virt/logging_events_monitoring/virt-monitoring-vm-health.adoc#virt-monitoring-vm-health[Monitoring virtual machine health]
66-
|
67-
68-
|
69-
|===
70-
71-
[id="virt-learn-more-developer"]
72-
== Virtual machine administrator / developer
73-
74-
[options="header",cols="4*"]
75-
|===
76-
|Learn |Use |Manage |Additional resources
77-
78-
| xref:../virt/about-virt.adoc#about-virt[Learn about {VirtProductName}]
79-
| xref:../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[Enabling the `virtctl` client]
80-
| Viewing xref:../virt/logging_events_monitoring/virt-logs.adoc#virt-logs[logs] and xref:../virt/logging_events_monitoring/virt-events.adoc#virt-events[events]
81-
| xref:../virt/logging_events_monitoring/virt-collecting-virt-data.adoc#virt-collecting-virt-data[Getting Support]
82-
83-
|
84-
| xref:../virt/virtual_machines/virt-create-vms.adoc#virt-create-vms[Creating virtual machines]
85-
| xref:../virt/logging_events_monitoring/virt-monitoring-vm-health.adoc#virt-monitoring-vm-health[Monitoring virtual machine health]
86-
|
87-
88-
|
89-
| xref:../virt/virtual_machines/virt-manage-vmis.adoc#virt-manage-vmis[Managing virtual machines instances]
90-
| xref:../virt/virtual_machines/virtual_disks/virt-managing-vm-snapshots.adoc#virt-managing-vm-snapshots[Creating and managing virtual machine snapshots]
91-
|
92-
93-
|
94-
| xref:../virt/virtual_machines/virt-controlling-vm-states.adoc#virt-controlling-vm-states[Controlling virtual machine states]
95-
|
96-
|
97-
98-
|
99-
| xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-accessing-vm-consoles[Accessing the virtual machine consoles]
100-
|
101-
|
102-
103-
|
104-
| xref:../virt/virtual_machines/virt-managing-configmaps-secrets-service-accounts.adoc#virt-managing-configmaps-secrets-service-accounts[Pass configuration data to virtual machines using secrets, configuration maps, and service accounts]
105-
|
106-
|
107-
108-
|
109-
|===
9+
You can install and configure a basic {VirtProductName} environment in order to explore its features and functionality.
10+
11+
[NOTE]
12+
====
13+
Cluster configuration procedures require `cluster-admin` privileges.
14+
====
15+
16+
[id="virt-getting-started-before-you-begin"]
17+
== Before you begin
18+
19+
* Review the xref:../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[installation requirements].
20+
* Review the xref:../virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc#virt-features-for-storage[storage features] required for cloning, snapshots, and live migration. See xref:../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Using a CSI-enabled storage provider] for details.
21+
* Install the xref:../virt/install/installing-virt-web.adoc#virt-installing-virt-operator_installing-virt-web[{VirtProductName} Operator] and the xref:../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[`virtctl` tool].
22+
23+
[id="virt-getting-started"]
24+
== Getting started
25+
26+
Create a virtual machine:
27+
28+
* Create a xref:../virt/virtual_machines/virt-create-vms.adoc#virt-creating-vm-wizard-web_virt-create-vms[RHEL virtual machine] using the wizard.
29+
* Create a Windows virtual machine:
30+
** Create and customize link:https://cloud.redhat.com/blog/virtual-machines-as-code-with-openshift-gitops-and-openshift-virtualization[Windows boot sources].
31+
** Create a xref:../virt/virtual_machines/virt-create-vms.adoc#virt-creating-vm-wizard-web_virt-create-vms[Windows virtual machine] using the wizard.
32+
** Install xref:../virt/virtual_machines/virt-installing-qemu-guest-agent.adoc#virt-installing-virtio-drivers-installing-windows_virt-installing-qemu-guest-agent[VirtIO drivers and the QEMU guest agent] on the virtual machine.
33+
34+
Connect to a virtual machine:
35+
36+
* Connect to a virtual machine using a xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-vm-serial-console-web_virt-accessing-vm-consoles[serial console] or xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-connecting-vnc-console_virt-accessing-vm-consoles[VNC console].
37+
* Connect to a Windows virtual machine using xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-vm-rdp-console-web_virt-accessing-vm-consoles[RDP].
38+
* Connect to a virtual machine using SSH:
39+
** xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-accessing-vmi-ssh_virt-accessing-vm-consoles[Create a service] to expose the SSH port of the virtual machine to an external network.
40+
** Use the service to connect to the virtual machine with xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-accessing-vmi-ssh_virt-accessing-vm-consoles[SSH].
41+
42+
xref:../virt/virtual_machines/virt-controlling-vm-states.adoc#virt-controlling-vm-states[Stop, start, pause, and restart] the virtual machine.
43+
44+
[id="virt-getting-started-next-steps"]
45+
== Next steps
46+
47+
Configure additional networks:
48+
49+
* Configure a Linux bridge network by creating a xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-creating-linux-bridge-nncp_virt-attaching-vm-multiple-networks[creating a Linux bridge node network configuration policy], xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-creating-linux-bridge-nad-web_virt-attaching-vm-multiple-networks[creating a network attachment definition], and xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-vm-creating-nic-web_virt-attaching-vm-multiple-networks[attaching a virtual machine to the network]. See xref:../networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#k8s-nmstate-about-the-k8s-nmstate-operator[About the Kubernetes NMState Operator] for more information.
50+
* Configure an SR-IOV network by instaling the xref:../networking/hardware_networks/installing-sriov-operator.adoc#installing-sriov-operator[SR-IOV Operator], configuring a xref:../virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc#virt-configuring-sriov-device-for-vms[SR-IOV network device], and xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc#virt-attaching-vm-to-sriov-network[attaching a virtual machine to the SR-IOV network].
51+
52+
Monitor your {VirtProductName} environment:
53+
54+
* Monitor virtualization resources, details, status, and top consumers on the xref:../virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc#virt-reviewing-virtualization-overview[*Virtualization Overview* page].
55+
* View high-level information about your virtual machines on the xref:../virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc#virt-viewing-information-about-vm-workloads[*Virtual Machines* dashboard].
56+
* View virtual machine xref:../virt/logging_events_monitoring/virt-logs.adoc#virt-logs[logs].
57+
58+
[id="{context}_additional-resources"]
59+
[role="_additional-resources"]
60+
== Additional resources
61+
62+
* xref:../virt/virtual_machines/advanced_vm_management/virt-specifying-nodes-for-vms.adoc#virt-specifying-nodes-for-vms[Specifying nodes for virtual machines]
63+
* xref:../virt/live_migration/virt-live-migration.adoc#virt-live-migration[Live migration]
64+
* xref:../virt/vm_templates/virt-creating-vm-template.adoc#virt-creating-vm-template[Virtual machine templates]
65+
* xref:../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-configuring-local-storage-for-vms[Configuring local storage]
66+
* xref:../virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc#virt-automating-virtual-machine-creation-with-ansible_virt-automating-management-tasks[Automating virtual machine deployments with Ansible]
67+
* xref:../virt/virtual_machines/virt-automating-windows-sysprep.adoc#virt-automating-windows-sysprep[Automating Windows virtual machine deployments with `sysprep`]
68+
* xref:../virt/backup_restore/virt-backup-restore-overview.adoc#virt-backup-restore-overview[Backup and restore]

0 commit comments

Comments
 (0)