Align Hyper-V docs to align w change from hyper.vhdx to azure-hyperv.vhd. (#1145)

- Remove images azure-docker, azure-machine-learning, and hyperv.
- Closes #1141
- Revises from Hyper-V Gen 2 to Gen 1, with relative changes to settings.
- Replaces figure 3 because Gen 1 settings are different from Gen 2
- Revises image type to remove previous default `hyperv.vhdx`,
  a Gen 2 image -- no longer supported.
- Respond to reviewer feedback; fix typos.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
This commit is contained in:
michael vincerra
2020-04-29 17:04:08 -07:00
committed by GitHub
parent 9687374e2a
commit acb0f8e2db
5 changed files with 25 additions and 44 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 9.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 12 KiB

@@ -15,8 +15,8 @@ Overview
********
Hyper-V is a type 1 bare-metal hypervisor that runs directly on system
hardware. It is available for `Windows\* server`_ and client operating systems,
including `Windows 10`_.
hardware. It is available for `Windows\* server`_ and client operating
systems, including `Windows 10`_.
|CL| provides a virtual disk image for Hyper-V, which also includes
a :ref:`Hyper-V specific kernel <compatible-kernels>` and drivers.
@@ -43,14 +43,16 @@ Prerequisites
Download the |CL| disk image for Hyper-V
****************************************
#. Download the :file:`clear-[VERSION]-hyperv.vhdx.gz` for Microsoft* Hyper-V
from the `downloads`_ website.
#. Download the :file:`clear-[VERSION]-azure-hyperv.vhd.gz` for Microsoft*
Hyper-V from the `downloads`_ website.
#. Verify and extract the image using these instructions:
:ref:`download-verify-decompress`.
After extraction, the file should be named :file:`clear-[VERSION]-hyperv.vhdx`.
#. Extract the compressed file using software such as the
7-Zip\* tool or the WinZip\* tool.
After extraction, the file should be named :file:`clear-[VERSION]-azure-hyperv.vhd`.
Create and configure new VM
****************************
@@ -63,6 +65,10 @@ Create and configure new VM
Figure 1: Hyper-V Manager from the Start menu
.. note::
You may need to manually enable Hyper-V on a Windows\* machine. Review
``Windows Features``.
#. Create a *New Virtual Machine* by clicking the :guilabel:`Action` menu,
then selecting :guilabel:`New` and :guilabel:`Virtual Machine...`.
@@ -77,23 +83,22 @@ Create and configure new VM
specifying the options below:
- **Name**: Choose name (for example, ClearLinuxOS-VM)
- **Generation**: Generation 2
- **Specify Generation**: Generation 1
- **Startup memory**: 2048 MB or more
- **Configure Networking**: Change :guilabel:`Connection` to `Default Switch`
- **Connect Virtual Hard Disk**: Select :guilabel:`Use an existing virtual
hard disk` and browse to find the :file:`clear-[VERSION]-hyperv.vhdx`
file.
hard disk` and browse to find the
:file:`clear-[VERSION]-azure-hyperv.vhd` file.
After finishing the wizard, the VM will be created but not powered on.
#. 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.
: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.
**Optional**
- Under :guilabel:`Security`, uncheck the :guilabel:`Enable Secure Boot`
checkbox.
- If you wish to `Encrypt state and virtual machine traffic, under
:guilabel:`Security`, select :guilabel:`Add Key Storage Drive`.
- Under :guilabel:`Processor`, consider increasing the number of virtual
processors assigned to the |CL| VM to improve performance.
@@ -112,12 +117,12 @@ Create and configure new VM
Start the VM
************
#. Start the |CL| VM by right-clicking the VM in Hyper-V Manager and selecting
:guilabel:`Start`.
#. Start the |CL| VM by right-clicking the VM in Hyper-V Manager and
selecting :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
is displayed.
selecting :guilabel:`Connect...`. A new *Virtual Machine Connection*
window is displayed.
#. After |CL| is booted, log in to the console with user *root*. You are
prompted to set a new password immediately.
@@ -57,19 +57,6 @@ Kernel Hyper-V\*
for more information. The optimization patches are found in our
`Linux-HyperV`_ GitHub repo.
Kernel Hyper-V LTS
The *kernel-hyperv-lts* bundle focuses on running Linux on Microsoft
Hyper-V but uses the latest :abbr:`LTS (Long Term Support)` Linux kernel.
It is optimized for fast booting and performs best on Virtual
Machines running on the Intel® architectures described on the
:ref:`supported hardware list<system-requirements>`.
Use this kernel when running |CL| as the guest OS of **Cloud Instances** in
projects such as Microsoft `Azure`_. This kernel can be used in a
standalone |CL| VM, see our :ref:`instructions on using Hyper-V<hyper-v>`
for more information. The optimization patches are found in our
`Linux-HyperV-LTS`_ GitHub repo.
.. _Linux: https://github.com/clearlinux-pkgs/linux
.. _Linux-LTS: https://github.com/clearlinux-pkgs/linux-lts
.. _Linux-KVM: https://github.com/clearlinux-pkgs/linux-kvm
+2 -13
View File
@@ -51,17 +51,6 @@ Table 2 lists the currently available images that are platform specific.
* - aws.img
- Image suitable for use with Amazon\* AWS\*.
* - azure.vhd
- Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform.
* - azure-docker.vhd
- Virtual Hard Disk for use on Microsoft Azure cloud platform with
Docker\* pre-installed.
* - azure-machine-learning.vhd
- Virtual Hard Disk for use on Microsoft Azure cloud platform with the
`machine-learning-basic` bundle installed.
* - cloudguest.img
- Image with generic cloud guest virtual machine (VM) requirements
installed.
@@ -69,8 +58,8 @@ Table 2 lists the currently available images that are platform specific.
* - gce.tar
- Image with the Google Compute Engine (GCE) specific kernel.
* - hyperv.vhdx
- Virtual Hard Disk for use with Microsoft Hyper-V\* hypervisor. Includes
* - azure-hyperv.vhd
- Image for Microsoft* Azure and Hyper-V generation 1 VMs. Includes
:ref:`optimized kernel <vm-kernels>` for Hyper-V.
* - kvm.img