|
| 1 | +:_content-type: ASSEMBLY |
| 2 | +[id="virt-getting-started"] |
| 3 | +include::_attributes/common-attributes.adoc[] |
| 4 | += Getting started with {VirtProductName} |
| 5 | +:context: virt-getting-started |
| 6 | + |
| 7 | +toc::[] |
| 8 | + |
| 9 | +You can explore the features and functionalities of {VirtProductName} by installing and configuring a basic environment. |
| 10 | + |
| 11 | +[NOTE] |
| 12 | +==== |
| 13 | +Cluster configuration procedures require `cluster-admin` privileges. |
| 14 | +==== |
| 15 | + |
| 16 | +[id="planning-and-installing-virt_{context}"] |
| 17 | +== Planning and installing {VirtProductName} |
| 18 | + |
| 19 | +Plan and install {VirtProductName} on an {product-title} cluster: |
| 20 | + |
| 21 | +* 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}]. |
| 22 | +* xref:../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Prepare your cluster for {VirtProductName}]. |
| 23 | +* xref:../virt/install/installing-virt-web.adoc#virt-installing-virt-operator_installing-virt-web[Install the {VirtProductName} Operator]. |
| 24 | +* xref:../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[Install the `virtctl` command line interface (CLI) tool]. |
| 25 | + |
| 26 | +[discrete] |
| 27 | +[id="additional-resources-planning-and-installing"] |
| 28 | +[role="_additional-resources"] |
| 29 | +=== Planning and installation resources |
| 30 | +* xref:../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Using a CSI-enabled storage provider]. |
| 31 | +* xref:../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-configuring-local-storage-for-vms[Configuring local storage for virtual machines]. |
| 32 | +* xref:../networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#installing-the-kubernetes-nmstate-operator-cli[Installing the Kubernetes NMState Operator]. |
| 33 | +* xref:../virt/virtual_machines/advanced_vm_management/virt-specifying-nodes-for-vms.adoc#virt-specifying-nodes-for-vms[Specifying nodes for virtual machines]. |
| 34 | +* xref:../virt/virt-using-the-cli-tools.adoc#virt-virtctl-commands_virt-using-the-cli-tools[`Virtctl` commands]. |
| 35 | + |
| 36 | +[id='configuring-networks_{context}'] |
| 37 | +=== Configuring secondary networks |
| 38 | + |
| 39 | +Configuring a secondary network is optional. VMs are connected to the default pod network. |
| 40 | + |
| 41 | +Configure a Linux bridge network: |
| 42 | + |
| 43 | +* xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-creating-linux-bridge-nncp_virt-attaching-vm-multiple-networks[Create a node network configuration policy]. |
| 44 | +* xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-creating-linux-bridge-nad-web_virt-attaching-vm-multiple-networks[Create a network attachment definition for the Linux bridge network]. |
| 45 | +* xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-vm-creating-nic-web_virt-attaching-vm-multiple-networks[Attach a VM to the Linux bridge network]. |
| 46 | + |
| 47 | +Configure an SR-IOV network: |
| 48 | + |
| 49 | +* xref:../networking/hardware_networks/installing-sriov-operator.adoc#installing-sriov-operator[Install the SR-IOV Operator]. |
| 50 | +* xref:../virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc#virt-configuring-sriov-device-for-vms[Configure an SR-IOV network device]. |
| 51 | +* xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc#virt-attaching-vm-to-sriov-network[Attach a VM to the SR-IOV network]. |
| 52 | + |
| 53 | +[id="creating-and-managing-vms_{context}"] |
| 54 | +== Creating and managing virtual machines |
| 55 | + |
| 56 | +Create virtual machines (VMs) by using the web console: |
| 57 | + |
| 58 | +* xref:../virt/virtual_machines/virt-create-vms.adoc#virt-quick-creating-vm_virt-create-vms[Quick create a VM]. |
| 59 | +* xref:../virt/virtual_machines/virt-create-vms.adoc#virt-creating-vm-custom-template_virt-create-vms[Customize a template to create a VM]. |
| 60 | + |
| 61 | +Connect to the VMs: |
| 62 | + |
| 63 | +* Connect to the 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] of a VM by using the web console. |
| 64 | +* xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-accessing-vmi-ssh_virt-accessing-vm-consoles[Connect to a VM by using SSH]. |
| 65 | +* xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-vm-rdp-console-web_virt-accessing-vm-consoles[Connect to a Windows VM by using RDP]. |
| 66 | + |
| 67 | +Manage VM states: |
| 68 | + |
| 69 | +* xref:../virt/virtual_machines/virt-controlling-vm-states.adoc#virt-controlling-vm-states[Stop, start, pause, and restart a VM by using the web console]. |
| 70 | +* xref:../virt/virt-using-the-cli-tools.adoc#virt-virtctl-commands_virt-using-the-cli-tools[Manage a VM, expose a port, or connect to the serial console by using the `virtctl` CLI tool]. |
| 71 | + |
| 72 | +[id="next-steps"] |
| 73 | +== Next steps |
| 74 | + |
| 75 | +* xref:../virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc#virt-reviewing-virtualization-overview[Monitor resources, details, status, and top consumers by using the web console]. |
| 76 | +* xref:../virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc#virt-viewing-information-about-vm-workloads[View high-level information about VM workloads by using the web console]. |
| 77 | +* xref:../virt/logging_events_monitoring/virt-logs.adoc#virt-logs[View {VirtProductName} logs by using the CLI]. |
| 78 | +* xref:../virt/virtual_machines/virt-automating-windows-sysprep.adoc#virt-automating-windows-sysprep[Automate Windows VM deployments with `sysprep`]. |
| 79 | +* xref:../virt/live_migration/virt-live-migration.adoc#virt-live-migration[Live migrate VMs]. |
| 80 | +* xref:../virt/backup_restore/virt-backup-restore-overview.adoc#virt-backup-restore-overview[Back up and restore VMs]. |
0 commit comments