From 1b24b3629fe05014d39e09c458bcafddec393e25 Mon Sep 17 00:00:00 2001 From: Mary Camp Date: Fri, 18 Oct 2019 12:20:13 -0400 Subject: [PATCH] Editorial changes in Hyper-v guide for grammar and formatting. (#871) * Editorial changes for grammar and formatting. Signed-off-by: MCamp859 * Closes #774 * Added reviewer feedback. Signed-off-by: MCamp859 --- .../virtual-machine-install/hyper-v.rst | 84 +++++++++---------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/source/get-started/virtual-machine-install/hyper-v.rst b/source/get-started/virtual-machine-install/hyper-v.rst index bef6ea8b..35038c57 100644 --- a/source/get-started/virtual-machine-install/hyper-v.rst +++ b/source/get-started/virtual-machine-install/hyper-v.rst @@ -4,7 +4,7 @@ ################################ This page explains how to run a |CL-ATTR| :abbr:`VM (virtual machine)` on a -a Microsoft Hyper-V\* hypervisor. +Microsoft\* Hyper-V\* hypervisor. .. contents:: :local: @@ -15,41 +15,41 @@ Overview ******** Hyper-V is a type 1 bare-metal hypervisor that runs directly on system -hardware. +hardware. It is available for `Windows\* server`_ and client operating systems, +including `Windows 10`_. -Hyper-V is available both on server and client Windows operating systems as -`Hyper-V on Windows Server`_ and `Hyper-V on Windows 10`_. +|CL| provides a virtual disk image for Hyper-V, which also includes +a :ref:`Hyper-V specific kernel ` and drivers. Prerequisites ************* -* Enable virtualization, such as `Intel® Virtualization Technology`_ - (Intel® VT) and `Intel® Virtualization Technology for Directed I/O`_ (Intel® - VT-d), on the host system from EFI/BIOS. +* Enable virtualization on the host system from EFI/BIOS, such as: -* Hyper-V installed on a capable Windows operating system. Refer to the - Microsoft documentation on `Install the Hyper-V role on Windows Server`_ or - `Install Hyper-V on Windows 10`_. + * `Intel® Virtualization Technology`_ (Intel® VT) + * `Intel® Virtualization Technology for Directed I/O`_ (Intel® VT-d) -* Configure appropriate virtual networking in Hyper-V. Refer to the Microsoft - documentation on `Create a virtual network on Window Server`_ or `Create a - virtual network on Window 10`_. +* Install Hyper-V on the appropriate Windows operating system: + + * `Install the Hyper-V role on Windows Server`_ + * `Install Hyper-V on Windows 10`_ + +* Configure the appropriate virtual networking in Hyper-V: + + * `Create a virtual network on Windows Server`_ + * `Create a virtual network on Windows 10`_ Download the |CL| disk image for Hyper-V **************************************** -|CL| provide a virtual disk image for Hyper-V with |CL| pre-installed. This -includes a |CL| :ref:`Hyper-V specific kernel ` with -Hyper-V Linux drivers ready-to-go. Get the latest |CL| image for Microsoft* -Hyper-V from the `downloads`_ website. The file is named -:file:`clear-[VERSION]-hyperv.vhdx.gz`. +#. Download the :file:`clear-[VERSION]-hyperv.vhdx.gz` for Microsoft* Hyper-V + from the `downloads`_ website. -We also provide instructions for downloading and verifying a Clear Linux -images. For more information, refer to :ref:`download-verify-decompress`. +#. Verify and extract the image using these instructions: + :ref:`download-verify-decompress`. -After extraction, the file should be named -:file:`clear-[VERSION]-hyperv.vhdx`. + After extraction, the file should be named :file:`clear-[VERSION]-hyperv.vhdx`. Create and configure new VM @@ -64,9 +64,8 @@ Create and configure new VM Figure 1: Hyper-V Manager from the Start menu -#. Create a *New Virtual Machine* by clicking the :guilabel:`Action` menu and - selecting the :guilabel:`New` submenu, and selecting :guilabel:`Virtual - Machine...`. +#. Create a *New Virtual Machine* by clicking the :guilabel:`Action` menu, + then selecting :guilabel:`New` and :guilabel:`Virtual Machine...`. .. figure:: figures/hyper-v/hyper-v-02.png :scale: 100% @@ -77,54 +76,55 @@ Create and configure new VM #. Follow the *New Virtual Machine Wizard* to create a new virtual machine specifying the options below: - - **Name**: Choose name (e.g. ClearLinuxOS-VM). + - **Name**: Choose name (for example, ClearLinuxOS-VM) - **Generation**: Generation 2 - **Startup memory**: 2048 MB or more - - **Connect Virtual Hard Disk**: select :guilabel:`Use an existing virtual + - **Connect Virtual Hard Disk**: Select :guilabel:`Use an existing virtual hard disk` and browse to find the :file:`clear-[VERSION]-hyperv.vhdx` file. After finishing the wizard, the VM will be created but not powered on. -#. Go to *Virtual Machine Settings* by right-clicking the newly created |CL| - VM in the Hyper-V Manager and selecting :guilabel:`Settings...` +#. Configure the VM by right-clicking it in the Hyper-V Manager and selecting + :guilabel:`Settings...`. + Figure 3 shows the Settings page after configuration selections. - Under :guilabel:`Firmware`, select the Virtual disk and click - :guilabel:`Move Up...` until it is at the top of the list. + :guilabel:`Move Up...` until it is at the top of the list. - Under :guilabel:`Security`, uncheck the :guilabel:`Enable Secure Boot` checkbox. - Under :guilabel:`Processor`, consider increasing the number of virtual - processors assigned to the |CL| VM for performance. + processors assigned to the |CL| VM to improve performance. .. figure:: figures/hyper-v/hyper-v-03.png :scale: 100% :alt: |CL| VM Settings in Hyper-V Manager - Figure 3: |CL| VM Settings page after selections + Figure 3: |CL| VM Settings page after configuration #. Click :guilabel:`Apply` at the bottom of the VM Settings screen. -#. Click :guilabel:`OK` at the bottom of the VM Setting screen. +#. Click :guilabel:`OK` at the bottom of the VM Settings screen. Start the VM ************ #. Start the |CL| VM by right-clicking the VM in Hyper-V Manager and selecting - :guilabel:`Start` + :guilabel:`Start`. #. Connect to the VM console by right-clicking the VM in Hyper-V Manager and selecting :guilabel:`Connect...`. A new *Virtual Machine Connection* window - will appear. + is displayed. -#. After |CL| is booted, login to the console with user *root*. You will be - prompted to set a new password immediately. +#. After |CL| is booted, log in to the console with user *root*. You are + prompted to set a new password immediately. .. code-block:: console - > User: root + > User: root |CL-ATTR| on Microsoft Hyper-V\* is ready for use. @@ -135,13 +135,13 @@ Related topics -.. _`Hyper-V on Windows Server`: https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/hyper-v-on-windows-server -.. _`Hyper-V on Windows 10`: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/index +.. _`Windows\* Server`: https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/hyper-v-on-windows-server +.. _`Windows 10`: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/index .. _`Intel® Virtualization Technology`: http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html .. _`Intel® Virtualization Technology for Directed I/O`: https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices .. _`Install the Hyper-V role on Windows Server`: https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/get-started/install-the-hyper-v-role-on-windows-server .. _Install Hyper-V on Windows 10: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v -.. _`Create a virtual network on Window Server`: https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/get-started/create-a-virtual-switch-for-hyper-v-virtual-machines -.. _`Create a virtual network on Window 10`: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network +.. _`Create a virtual network on Windows Server`: https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/get-started/create-a-virtual-switch-for-hyper-v-virtual-machines +.. _`Create a virtual network on Windows 10`: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network .. _downloads: https://clearlinux.org/downloads