Edit the pre-configured image installation instructions.

Minimal fixes were also implemented on the general instructions too.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This commit is contained in:
Rodrigo Caballero
2018-02-23 10:57:41 -06:00
parent 6cb51ae261
commit f3a2ecc6d7
2 changed files with 183 additions and 177 deletions
@@ -1,4 +1,4 @@
.. _vmware-player-install-cl:
.. _vmw-player:
Install Clear Linux as a VMware\* Workstation Player guest OS
#############################################################
@@ -64,9 +64,10 @@ Install the VMware Workstation Player hypervisor
$ sudo sh ./VMware-Player-[version number].x86_64.bundle
* On Windows:
* On Windows:
#. Start the installer and follow the Setup Wizard.
#. Start the installer.
#. Follow the setup wizard.
For additional help, see the `VMware Workstation Player guide`_.
@@ -117,7 +118,7 @@ Create and configure a new VM
Figure 2: VMware Workstation 14 Player - Select |CL| installer ISO
#. Click the :guilabel:`Browse` button and select the uncompressed |CL|
installer ISO.
installer ISO.
#. Click the :guilabel:`Next` button.
@@ -266,14 +267,14 @@ Enable UEFI boot support
|CL| needs UEFI support to boot. To enable UEFI, add the
following line to the end of your VM's :file:`.vmx` file:
.. code-block:: bash
.. code-block:: bash
firmware = "efi"
firmware = "efi"
VMware typically saves VM files on the following locations:
* On Linux distros: :file:`/home/username/vmware`
* On Windows: :file:`C:/\Users/\username/\Documents/\Virtual Machines`
* On Windows: :file:`C:\Users\username\Documents\Virtual Machines`
The file type is `VMware virtual machine configuration`.
@@ -1,56 +1,62 @@
.. _vmware-player-preconfigured-cl-image:
.. _vmw-player-preconf:
Run pre-configured Clear Linux image as a VMware\* Workstation Player guest OS
##############################################################################
`VMware Workstation 14 Player`_ is a type 2 hypervisor which runs on top of
another operating system such as Windows or Linux. With VMware ESXi, you can
create, configure, manage, and run |CLOSIA| :abbr:`VMs (Virtual Machine)` on
your local system.
`VMware Workstation 14 Player`_ is a type 2 hypervisor. It runs on top of
another operating system such as Windows\* or Linux\*. With VMware ESXi, you
can create, configure, manage, and run |CLOSIA| :abbr:`VMs (Virtual Machines)`
on your local system.
This section shows you how to deploy a pre-configured |CL| VMware image on
VMware Workstation 14 Player using these steps:
#. Install the VMware Workstation Player hypervisor
#. Download the latest |CL| VMware image
#. Verify the integrity of the |CL| image
#. Uncompress the |CL| image
#. Create and configure a new VM
#. Attach the pre-configured VMware |CL| image
#. Enable EFI boot support
#. Power on the VM
This section shows how to deploy a pre-configured |CL| VMware image on
VMware Workstation 14 Player.
In this tutorial, we perform the following steps:
#. Install the VMware Workstation Player hypervisor
#. Download the latest |CL| pre-configured image
#. VMware image Verify the integrity of the |CL| image
#. Uncompress the |CL| image
#. Create and configure a new VM
#. Attach the pre-configured VMware |CL| image
#. Enable EFI boot support
#. Power on the VM
.. note::
The figures shown throughout this document are from the Windows\* version of
VMware Workstation 14 Player. The menus and prompts in these figures are
similar as those for the Linux version with some minor wording differences.
The screenshots on this document show the Windows\* version of the
VMware Workstation 14 Player. The menus and prompts are similar to those
in the Linux version save some minor wording differences.
Install the VMware Workstation Player hypervisor
************************************************
#. Enable `Intel® Virtualization Technology`_ (Intel® VT) and
`Intel® Virtualization Technology for Directed I/O`_ (Intel® VT-d) in your
system's BIOS.
#. `VMware Workstation 14 Player`_ is available for Windows and Linux. Download
your preferred version.
#. Depending on which OS you're running, install it by following one of these
#. Enable :abbr:`Intel® VT (Intel® Virtualization Technology)` and
:abbr:`Intel® VT-d (Intel® Virtualization Technology for Directed I/O)` in
your system's BIOS.
#. `VMware Workstation 14 Player`_ is available for Windows and Linux.
Download your preferred version.
#. Depending on which OS you're running, install it by following one of these
instructions:
* For Linux distros supported by VMware:
* On supported Linux distros:
#. Enable a GUI desktop.
#. Start a terminal emulator.
#. Start the installer by issuing the command below and follow the
guided steps.
#. Enable a GUI desktop.
.. code-block:: console
#. Start a terminal emulator.
$ sudo sh ./VMware-Player-[version number].x86_64.bundle
#. Start the installer by issuing the command below and follow the guided
steps.
* For Windows:
.. code-block:: console
#. Start the installer and follow the Setup Wizard.
sudo sh ./VMware-Player-[version number].x86_64.bundle
* On Windows:
#. Start the installer and follow the Setup Wizard.
For additional help, see the `VMware Workstation Player guide`_.
@@ -69,7 +75,7 @@ Look for :file:`clear-[version number]-vmware.vmdk.xz`.
.. include:: ../../guides/maintenance/download-verify-uncompress-windows.rst
:Start-after: verify-windows:
We also provide instructions for other operating systems:
We also provide instructions for other operating systems:
* :ref:`download-verify-uncompress-linux`
* :ref:`download-verify-uncompress-mac`
@@ -77,208 +83,208 @@ We also provide instructions for other operating systems:
Create and configure a new VM
*****************************
#. Start the `VMware Workstation Player` app.
#. On the home screen:
#. Start the `VMware Workstation Player` app.
#. On the home screen, click :guilabel:`Create a New Virtual Machine`. See
figure 1.
#. Click :guilabel:`Create a New Virtual Machine`. See Figure 1.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-1.png
:scale: 100%
:alt: VMware Workstation 14 Player - Create a new virtual machine
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-1.png
:scale: 100%
:alt: VMware Workstation 14 Player - Create a new virtual machine
Figure 1: VMware Workstation 14 Player - Create a new virtual machine
Figure 1: VMware Workstation 14 Player - Create a new virtual machine
#. On the :guilabel:`Welcome to the New Virtual Machine Wizard` step:
#. On the :guilabel:`Welcome to the New Virtual Machine Wizard` screen, select
the :guilabel:`I will install the operating system later` option.
See figure 2.
#. Select the :guilabel:`I will install the operating system later` option.
See Figure 2.
#. Click the :guilabel:`Next` button.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-2.png
:scale: 100%
:alt: VMware Workstation 14 Player - Select install operating system
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-2.png
:scale: 100%
:alt: VMware Workstation 14 Player - Select install operating system
Figure 2: VMware Workstation 14 Player - Select install operating system
later.
Figure 2: VMware Workstation 14 Player - Select install operating system
later
#. Click the :guilabel:`Next` button.
#. On the :guilabel:`Select a Guest Operating System` step:
#. On the :guilabel:`Select a Guest Operating System` screen, set the
:guilabel:`Guest operating system` setting to :guilabel:`Linux`.
See figure 3.
#. Set the :guilabel:`Guest operating system` setting to :guilabel:`Linux`.
See Figure 3.
#. Set :guilabel:`Version` setting to :guilabel:`Other Linux 3.x or later kernel 64-bit`.
#. Click the :guilabel:`Next` button.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-3.png
:scale: 100%
:alt: VMware Workstation 14 Player - Select guest operating system type
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-3.png
:scale: 100%
:alt: VMware Workstation 14 Player - Select guest operating system type
Figure 3: VMware Workstation 14 Player - Select guest operating system
type
Figure 3: VMware Workstation 14 Player - Select guest operating system type
#. Set :guilabel:`Version` setting to
:guilabel:`Other Linux 3.x or later kernel 64-bit`.
#. On the :guilabel:`Name the Virtual Machine` step:
#. Click the :guilabel:`Next` button.
#. Give your new VM a name. See Figure 4.
#. Click the :guilabel:`Next` button.
#. On the :guilabel:`Name the Virtual Machine` screen, give your new VM a name.
See figure 4.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-4.png
:scale: 100%
:alt: VMware Workstation 14 Player - Name virtual machine
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-4.png
:scale: 100%
:alt: VMware Workstation 14 Player - Name virtual machine
Figure 4: VMware Workstation 14 Player - Name virtual machine
Figure 4: VMware Workstation 14 Player - Name virtual machine
#. On the :guilabel:`Specify Disk Capacity` step:
#. Click the :guilabel:`Next` button.
#. Click the :guilabel:`Next` button. The disk settings do not
matter because the default virtual disk will be removed when you attach
the pre-configured |CL| VMware image at a later step. See Figure 5.
#. On the :guilabel:`Specify Disk Capacity` screen, click the :guilabel:`Next`
button. When you attach the pre-configured |CL| VMware image, VMWare removes
the default virtual disk making this setting irrelevant. See figure 5.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-5.png
:scale: 100%
:alt: VMware Workstation 14 Player - Set disk capacity
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-5.png
:scale: 100%
:alt: VMware Workstation 14 Player - Set disk capacity
Figure 5: VMware Workstation 14 Player - Set disk capacity
Figure 5: VMware Workstation 14 Player - Set disk capacity
#. On the :guilabel:`Ready to Create Virtual Machine` step:
#. On the :guilabel:`Ready to Create Virtual Machine` screen, click the
:guilabel:`Customize Hardware...` button. See figure 6.
#. Click the :guilabel:`Customize Hardware...` button. See Figure 6.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-6.png
:scale: 100%
:alt: VMware Workstation 14 Player - Customize hardware
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-6.png
:scale: 100%
:alt: VMware Workstation 14 Player - Customize hardware
Figure 6: VMware Workstation 14 Player - Customize hardware
Figure 6: VMware Workstation 14 Player - Customize hardware
#. Under the :guilabel:`Device` list, select :guilabel:`Processors`.
See Figure 7.
Under the :guilabel:`Virtualization engine` section,
check :guilabel:`Virtualize Intel VT-x/EPT or AMD-V/RVI`.
#. Under the :guilabel:`Device` list, select :guilabel:`Processors`. See
figure 7.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-7.png
:scale: 100%
:alt: VMware Workstation 14 Player - Set virtualization engine option
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-7.png
:scale: 100%
:alt: VMware Workstation 14 Player - Set virtualization engine option
Figure 7: VMware Workstation 14 Player - Set virtualization engine option
Figure 7: VMware Workstation 14 Player - Set virtualization engine option
#. Because the virtual CD/DVD (IDE) is not needed, disconnect it:
#. Under the :guilabel:`Virtualization engine` section,
check :guilabel:`Virtualize Intel VT-x/EPT or AMD-V/RVI`.
#. Under the :guilabel:`Device` list, select :guilabel:`New CD/DVD (IDE)`.
See Figure 8.
#. Under the :guilabel:`Device status` section, uncheck
:guilabel:`Connect at power on`.
#. To disconnect the virtual CD/DVD (IDE) since it is not needed, under the
:guilabel:`Device` list, select :guilabel:`New CD/DVD (IDE)`. See figure 8.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-8.png
:scale: 100%
:alt: VMware Workstation 14 Player - Disconnect CD/DVD (IDE)
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-8.png
:scale: 100%
:alt: VMware Workstation 14 Player - Disconnect CD/DVD (IDE)
Figure 8: VMware Workstation 14 Player - Disconnect CD/DVD (IDE)
Figure 8: VMware Workstation 14 Player - Disconnect CD/DVD (IDE)
#. Under the :guilabel:`Device status` section, uncheck
:guilabel:`Connect at power on`.
#. Click the :guilabel:`Close` button.
#. Click the :guilabel:`Finish` button.
#. Click the :guilabel:`Close` button.
#. Click the :guilabel:`Finish` button.
Attach the pre-configured Clear Linux VMware image
**************************************************
#. Move the downloaded and uncompressed pre-configured |CL| VMware image file
:file:`clear-[version number]-basic.vmdk` to the directory where your
newly-created VM resides.
#. Move the downloaded and uncompressed pre-configured |CL| VMware image file
:file:`clear-[version number]-basic.vmdk` to the directory where your
newly-created VM resides.
.. note::
.. note::
VMware VM files are typically located in:
Depending on the OS, you can typically find the VMware VM files under:
* Linux distros: `/home/username/vmware`
* Windows: `C:/\Users/\username/\Documents/\Virtual Machines`
* On Linux distros: :file:`/home/username/vmware`
* On Windows: :file:`C:\Users\username\Documents\Virtual Machines`
#. On the `VMware Workstation Player` home screen:
#. On the :guilabel:`VMware Workstation Player` home screen, select your newly-
created VM. See figure 9.
#. Select your newly-created VM. See Figure 9.
#. Click :guilabel:`Edit virtual machine settings`.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-9.png
:scale: 100%
:alt: VMware Workstation 14 Player - Edit virtual machine settings
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-9.png
:scale: 100%
:alt: VMware Workstation 14 Player - Edit virtual machine settings
Figure 9: VMware Workstation 14 Player - Edit virtual machine settings
Figure 9: VMware Workstation 14 Player - Edit virtual machine settings
#. Click :guilabel:`Edit virtual machine settings`.
#. Remove the default hard disk:
#. To remove the default hard disk, under the :guilabel:`Device` list, select
:guilabel:`Hard Disk (SCSI)`. See figure 10.
#. Under the :guilabel:`Device` list, select :guilabel:`Hard Disk (SCSI)`.
See Figure 10.
#. Click the :guilabel:`Remove` button.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-10.png
:scale: 100%
:alt: VMware Workstation 14 Player - Remove hard drive
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-10.png
:scale: 100%
:alt: VMware Workstation 14 Player - Remove hard drive
Figure 10: VMware Workstation 14 Player - Remove hard drive
Figure 10: VMware Workstation 14 Player - Remove hard drive
#. Click the :guilabel:`Remove` button.
#. Add a new hard disk and attach the pre-configured |CL| VMware image:
#. To add a new hard disk and attach the pre-configured |CL| VMware image,
click the :guilabel:`Add...` button. See Figure 11.
#. Click the :guilabel:`Add...` button. See Figure 11.
#. Under the :guilabel:`Hardware types` section, select :guilabel:`Hard Disk`.
#. Click the :guilabel:`Next` button.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-11.png
:scale: 100%
:alt: VMware Workstation 14 Player - Add new hard drive
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-11.png
:scale: 100%
:alt: VMware Workstation 14 Player - Add new hard drive
Figure 11: VMware Workstation 14 Player - Add new hard drive
Figure 11: VMware Workstation 14 Player - Add new hard drive
#. Under the :guilabel:`Hardware types` section, select :guilabel:`Hard Disk`.
#. Select your preferred :guilabel:`Virtual disk type`. See Figure 12.
#. Click the :guilabel:`Next` button.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-12.png
:scale: 100%
:alt: VMware Workstation 14 Player - Select virtual disk type
#. Select your preferred :guilabel:`Virtual disk type`. See figure 12.
Figure 12: VMware Workstation 14 Player - Select virtual disk type
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-12.png
:scale: 100%
:alt: VMware Workstation 14 Player - Select virtual disk type
#. Select the :guilabel:`Use an existing virtual disk` option. See Figure 13.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-13.png
:scale: 100%
:alt: VMware Workstation 14 Player - Use existing virtual disk
Figure 12: VMware Workstation 14 Player - Select virtual disk type
Figure 13: VMware Workstation 14 Player - Use existing virtual disk
#. Click the :guilabel:`Browse` button and select the pre-configured |CL|
VMware image file. See Figure 14.
#. Select the :guilabel:`Use an existing virtual disk` option. See figure 13.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-14.png
:scale: 100%
:alt: VMware Workstation 14 Player - Select ready-made VMware |CL|
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-13.png
:scale: 100%
:alt: VMware Workstation 14 Player - Use existing virtual disk
Figure 14: VMware Workstation 14 Player - Select ready-made VMware |CL|
image file
Figure 13: VMware Workstation 14 Player - Use existing virtual disk
#. Click the :guilabel:`Finish` button.
#. Click the :guilabel:`Browse` button and select the pre-configured |CL|
VMware image file. See figure 14.
.. note::
When asked to convert the existing virtual disk to newer format,
selecting either option works.
.. figure:: figures/vmware-player/vmware-player-preconfigured-cl-image-14.png
:scale: 100%
:alt: VMware Workstation 14 Player - Select ready-made VMware |CL|
Figure 14: VMware Workstation 14 Player - Select ready-made VMware |CL|
image file
#. Click the :guilabel:`Finish` button.
.. note::
When asked to convert the existing virtual disk to a newer format,
selecting either option works.
Enable UEFI boot support
************************
|CL| needs UEFI support in order to boot. You can enable it by appending the
following to the end of your VM's :file:`.vmx` file:
|CL| needs UEFI support to boot.To enable it, add the
following line to the end of your VM's :file:`.vmx` file:
.. code-block:: console
.. code-block:: console
firmware = "efi"
firmware = "efi"
VMware VM files are typically located in:
.. note::
* Linux distros: `/home/username/vmware`
* Windows: `C:/\Users/\username/\Documents/\Virtual Machines` (The file type
is `VMware virtual machine configuration`.)
Depending on the OS, you can typically find the VMware VM files under:
* On Linux distros: :file:`/home/username/vmware`
* On Windows: :file:`C:\Users\username\Documents\Virtual Machines`
Power on the VM
***************
After configuring the settings above, power on your |CL| virtual machine.
After configuring the settings above, power on your |CL| virtual machine.
Also see:
For other guides on using the VMWare player, see:
* :ref:`vmware-player-install-cl`
* :ref:`vmware-esxi-install-cl`
@@ -289,8 +295,7 @@ Also see:
.. _VMware Workstation Player guide: https://docs.vmware.com/en/VMware-Workstation-Player/index.html
.. _latest: https://download.clearlinux.org/image/
.. _image: https://download.clearlinux.org/image
.. _Intel® Virtualization Technology: https://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