Merged with the latest main branch

Signed-off-by: Bun K Tan <bktan1@bktan1-mac08.jf.intel.com> This latest version of the VMware player improved document was merged with the latest main branch and will be in a different branch than the last pull request, which I will remove. Updated with feedbacks from Ianeta. Signed-off-by: Bun K Tan <bun.k.tan@intel.com> Update Signed-off-by: Bun K Tan <bun.k.tan@intel.com> Updates... Signed-off-by: Bun K Tan <bun.k.tan@intel.com> 1) Changed the title to "Run Clear Linux as a VMware Workstation Player guest OS". I think "Use VMware Player" is too generic. These are changes based on Tom's feedback: 2) Added minimum disk size info. 3) Added minimum memory info and a screenshot. 4) Added file type info for .vmx file in Windows. 5) Added blurb on how to verify checksum for Windows. ----- Signed-off-by: Bun K Tan <bun.k.tan@intel.com> Corrected screenshot for figure #19. Signed-off-by: Bun K Tan <bun.k.tan@intel.com> >>> 2017-11-17 - Converted figures substitution to inline. >>> 2017-11-21 1) Added brief intro to what VMware Workstation player is. -----
2026-08-24 16:57:45 +00:00 · 2017-11-13 13:39:25 -08:00
parent 09ce2d4647
commit 8f09184172
41 changed files with 482 additions and 70 deletions
@@ -1,116 +1,528 @@
 .. _vmware-player:

-Use VMware\* Player
-###################
+Run Clear Linux as a VMware\* Workstation Player guest OS
+#########################################################

-This section explains how to run Clear Linux OS for Intel® Architecture
-within a `VMware Player`_ environment.
+`VMware Workstation 14 Player`_ is a type 2 hypervisor which runs on top of another
+operating system such as Windows or Linux.  Creation, configuration, management, and execution of virtual
+machines are done on the local system.  For the cloud version of VMware, see 
+:ref:`vmware-esxi`.

-Please ensure you have enabled `Intel® Virtualization Technology
-<http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html>`_
-(Intel® VT) and `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>`_
-(Intel® VT-d) in your BIOS/UEFI firmware configuration.
+This section explains how to run |CLOSIA| as a virtual machine using the 
+VMware Workstation 14 Player hypervisor.

-Install VMware Player
-=====================
+There are 2 ways to create a |CL| :abbr:`VM (Virtual Machine)` to run in VMware:

-VMware Workstation Player, formerly VMware Player, is a virtualization
-software package for x64 computers running Microsoft Windows or Linux.
-Download VMware player from the `VMware website`_.
+* `Method #1`: Install |CL| into a new VM.  This provides flexibility 
+  in configuring the VM size, partitions, initial |CL| bundles selection, etc.
+* `Method #2`: Use a ready-made VMware |CL| image.  

-Player on Linux
---------------
+Both are discussed below.  

-For the Linux option, you should have a :file:`VMware-Player-{version}_FILE.bundle`
-file. To install it, run:
+.. 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.

-  $ sudo bash ./VMware-Player-{version}.x86_64.bundle
+Install the VMware Workstation Player hypervisor
+================================================

-Player on Windows
-----------------
+#. Enable the `Intel® Virtualization Technology`_ (Intel® VT) and the
+   `Intel® Virtualization Technology for Directed I/O`_ (Intel® VT-d) in the
+   host machine’s BIOS.
+#.  `VMware Workstation 14 Player`_ is available for Windows and Linux.  Download 
+    the preferred version of choice.
+#.  Install it.

-Follow the instructions from the Setup Assistant.
+    * For Linux distros supported by VMware: 

+      #.  Enable a GUI desktop.  
+      #.  Start a terminal emulator.
+      #.  Start the installer and follow the guided steps.

-Prepare Image
-=============
+        .. code-block:: console

-#. Download the `latest`_ |CL| **live** version (clear-XXXX-live.img.xz)
+          $ sudo sh ./VMware-Player-<version>.x86_64.bundle

-#. Decompress the downloaded image. Uncompressed image size is ~ **5GB**.
+    * For Windows:

-   + On Linux ::
+      #.  Start the installer and follow the Setup Wizard.

-       $ xz -d clear-XXXX-live.img.xz
+For additional help, see the `VMware Workstation Player guide`_.

-   + On Windows you can use `7zip`_.
+Download the latest Clear Linux image
+=====================================

-     - Right-click the file to *extract in the same directory*.
+Go to the |CL| `image`_ repository and download the desired type:

-       .. image:: ./figures/7zipwin.png
-          :alt: 7zip extract here command
+* ISO installer image: `clear-<version>-installer.iso.xz` (for Method 1)
+* VMware image: `clear-<version>-basic.vmdk.xz` (for Method 2)

-#. Convert the installer to :abbr:`VMDK (Virtual Machine Disk)` format.
+For older versions, see the `releases`_ page.

-   * On Linux, you can use ``qemu-img convert``::
+Although not required, it is recommended to download the corresponding 
+checksum file (designated with `-SHA512SUMS` at the end of the filename) 
+for the image in order to verify its integrity.

-      $ qemu-img convert -O vmdk clear-VERSION-live.img clear.vmdk
+Verify the integrity of the download (recommended)
+==================================================

-   * On Windows, you can convert the live image to VMDK format
-     (from RAW format to VMDK) with a tool like *VBoxManage* from
-     `VirtualBox`_. You can refer on
-     :ref:`how to create a VM on VirtualBox <create_vm_vbox>` as example.
+* For Linux distros:

+  #.  Start a terminal emulator.
+  #.  Go to the directory with the downloaded files.
+  #.  To verify the integrity of the image, enter (an installer ISO
+      image is used as an example):

-Run using VMware Player
-=======================
+      .. code-block:: console

+        $ sha512sum ./clear-<version>-installer.iso.xz | diff ./clear-<version>-installer.iso.xz-SHA512SUMS -

-Create a new virtual machine by following the next steps.
+      If the checksum of the downloaded image is different than the original
+      checksum, the differences will displayed. An empty output indicates a match.

-#. Launch **VMWare Workstation Player**.
+* For Windows:

-#. On main window click on “Create a new Virtual Machine”.
+  #.  Start Command-Prompt.
+  #.  Go to the directory with the downloaded files.
+  #.  To verify the integrity of the image, enter:

-   * Select “**I will install the operating system later**”, and click on
-     “Next”.
-   * Select “**Linux**” as “Guest operating system” and version **Other Linux
-     3.x kernel 64-bit**.
-   * Type a name for the new virtual machine.
-   * Perform the *remaining steps* using the default options.
+      .. code-block:: console

-#. Change boot type to EFI.  You must change the VMware virtual machine
-   *configuration* to **Support EFI firmware**; you can do this by editing
-   the configuration ``.vmx`` file located in the virtual machine folder and
-   adding the following line::
+        C:\> CertUtil -hashfile ./clear-<version>-installer.iso.xz sha512

-     firmware = "efi"
+      Manually compare the output with the original checksum value shown in 
+      the downloaded checksum file (i.e. `clear-<version>-installer.iso.xz-SHA512SUMS`) 
+      to make sure they match.

-#. Attach the prepared image as SATA disk.  And when you have a new virtual
-   machine, edit its configuration as follows:
+Uncompress the image
+====================

-   * Click on “Edit virtual machine settings”.
-   * Remove any default attached hard disk.
-   * Click on “Add” option below devices list tab and choose Hard disk.
+* For Linux distros (an installer ISO image is used as an example):

-     * Choose **SATA** as the virtual disk type.
-     * Use the existing Clear Linux OS for Intel Architecture virtual disk
+  .. code-block:: console

-     The live disk must be set as ``SATA 0:1 Hard Disk (SATA)``; you can
-     verify this under the “Advanced" section of the disk settings.
+    $ unxz clear-<version>-installer.iso.xz

-Start the virtual machine
-=========================
+* For Windows:

-After configuring the settings above, start the virtual machine.
+  Use `7zip`_ to uncompress it.

+Method 1: Install Clear Linux into a new VM 
+===========================================

-.. _VMware website: https://www.vmware.com/products/player/playerpro-evaluation.html
-.. _VMware Player: http://www.vmware.com/products/player/
+The general process for performing a fresh installation of |CL| into a new VM 
+is as follows (with expanded details below):
+
+* Create a new VM and configure its settings
+* Attach the installer ISO to it
+* Install |CL|
+* Detach the installer ISO
+* Power off the VM
+* Enable EFI boot support
+* Power on the VM
+
+Create and configure a new VM 
+*****************************
+
+#.  Start the `VMware Workstation Player` app.
+#.  On the home screen:
+
+    * Click :guilabel:`Create a New Virtual Machine`.
+
+      .. figure:: figures/vmware-player/vmware-player-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
+   
+#.  :guilabel:`Welcome to the New Virtual Machine Wizard`:
+
+    * Select :guilabel:`Installer disc image file (iso)`.
+    * Click :guilabel:`Browse` and select the uncompressed |CL| installer ISO. 
+    * Click :guilabel:`Next`.
+
+      .. figure:: figures/vmware-player/vmware-player-2.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Select |CL| installer ISO 
+
+      Figure 2: VMware Workstation 14 Player - Select |CL| installer ISO   
+
+#.  :guilabel:`Select a Guest Operating System`:
+
+    * Set :guilabel:`Guest operating system` to :guilabel:`Linux`.
+    * Set :guilabel:`Version` to :guilabel:`Other Linux 3.x or later kernel 64-bit`.
+    * Click :guilabel:`Next`.
+
+      .. figure:: figures/vmware-player/vmware-player-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
+
+#.  :guilabel:`Name the Virtual Machine`:
+
+    * Give it a name.
+    * Click :guilabel:`Next`.
+
+      .. figure:: figures/vmware-player/vmware-player-4.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Name virtual machine
+
+      Figure 4: VMware Workstation 14 Player - Name virtual machine
+
+#.  :guilabel:`Specify Disk Capacity`:
+
+    * Set the desired maximum disk size.  
+
+    * Click :guilabel:`Next`.
+
+      .. figure:: figures/vmware-player/vmware-player-5.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Set disk capacity
+
+      Figure 5: VMware Workstation 14 Player - Set disk capacity
+
+      .. note::
+
+        A minimum |CL| installation can exist on 600MB of drive space.  
+        See :ref:`system-requirements` for more details.   
+
+#.  :guilabel:`Ready to Create Virtual Machine`:
+
+    * Click :guilabel:`Customize Hardware...`
+    
+      .. figure:: figures/vmware-player/vmware-player-6.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Customize hardware
+
+      Figure 6: VMware Workstation 14 Player - Customize hardware
+
+    * Select :guilabel:`Memory` and set the size to 2GB.  
+
+      .. figure:: figures/vmware-player/vmware-player-7.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Set memory size
+
+      Figure 7: VMware Workstation 14 Player - Set memory size
+
+      .. note:: 
+
+        The |CL| installer ISO needs a minimum of 2GB of RAM to work properly.
+        After the installation is complete, the memory size can be reduced, if 
+        desired.  A minimum |CL| installation can function on as little as 
+        128MB of RAM. See :ref:`system-requirements` for more details.  
+
+    * Select :guilabel:`Processors` > :guilabel:`Virtualization engine`, and 
+      check :guilabel:`Virtualize Intel VT-x/EPT or AMD-V/RVI`.
+
+      .. figure:: figures/vmware-player/vmware-player-8.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Set virtualization engine option
+
+      Figure 8: VMware Workstation 14 Player - Set virtualization engine option
+
+    * Click :guilabel:`Close`.
+
+    * Click :guilabel:`Finish`.
+
+Install Clear Linux into the new VM
+***********************************
+
+#.  Select the newly created VM and click :guilabel:`Play virtual machine`.  
+
+    .. figure:: figures/vmware-player/vmware-player-9.png
+      :scale: 100%
+      :alt: VMware Workstation 14 Player - Power on virtual machine
+
+    Figure 9: VMware Workstation 14 Player - Power on virtual machine
+
+#.  Follow the :ref:`install-on-target` guide to complete the installation of 
+    |CL|.
+
+#.  After the installation is complete, follow the |CL| instruction to reboot the VM.  
+    This will restart the installer again.    
+
+Reconfigure the VM settings to boot the newly installed Clear Linux
+*******************************************************************
+
+#.  Enable the mouse pointer.
+
+    * Press :kbd:`<CTRL>` + :kbd:`<ALT>`.
+
+#.  Disconnect the CD/DVD to stop it from booting the installer ISO again.
+    
+    * Click :guilabel:`Player`.
+    * Go to :guilabel:`Removable Devices` > :guilabel:`CD/DVD (IDE)` > 
+      :guilabel:`Settings`.
+
+      .. figure:: figures/vmware-player/vmware-player-10.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Edit CD/DVD settings
+
+      Figure 10: VMware Workstation 14 Player - Edit CD/DVD settings
+
+    * Under :guilabel:`Device status`, uncheck :guilabel:`Connected` and 
+      :guilabel:`Connect at power on`.
+    * Click `OK`.
+
+      .. figure:: figures/vmware-player/vmware-player-11.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Disconnect CD/DVD
+
+      Figure 11: VMware Workstation 14 Player - Disconnect CD/DVD
+
+#.  Power off the VM.
+
+    * Click :guilabel:`Player`.
+    * Go to :guilabel:`Power` and select :guilabel:`Shut Down Guest`.
+
+      .. figure:: figures/vmware-player/vmware-player-12.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Power off virtual machine
+
+      Figure 12: VMware Workstation 14 Player - Power off virtual machine
+
+Enable UEFI boot support
+************************
+
+|CL| needs UEFI support in order to boot.  Enable it by appending to the end 
+of the VM's :file:`.vmx` file:
+
+  .. code-block:: console
+
+    firmware = "efi"
+
+.. note::
+
+  VMware VM files are typically located in:
+
+  * Linux distros: `/home/username/vmware`
+  * Windows: `C:/\Users/\username/\Documents/\Virtual Machines` (The file type 
+    is `VMware virtual machine configuration`.)
+
+Power on the virtual machine
+****************************
+
+After configuring the settings above, power on the virtual machine.  
+
+Method 2: Use a ready-made VMware Clear Linux image
+===================================================
+
+The general process for booting a ready-made VMware |CL| image is as follows 
+(with expanded details below):
+
+* Create a new VM and configure its base settings
+* Attach the ready-made VMware |CL| image
+* Enable EFI boot support
+* Power on the VM
+
+Create a new VM and configure its base settings
+***********************************************
+
+#.  Start the `VMware Workstation Player` app.
+#.  On the home screen:
+
+    * Click :guilabel:`Create a New Virtual Machine`.
+
+      .. figure:: figures/vmware-player/vmware-player-1.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Create a new virtual machine
+
+      Figure 13: VMware Workstation 14 Player - Create a new virtual machine
+   
+#.  :guilabel:`Welcome to the New Virtual Machine Wizard`:
+
+    * Select :guilabel:`I will install the operating system later`.
+    * Click :guilabel:`Next`.
+
+      .. figure:: figures/vmware-player/vmware-player-14.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Select install operating system 
+
+      Figure 14: VMware Workstation 14 Player - Select install operating system 
+      later  
+
+#.  :guilabel:`Select a Guest Operating System`:
+
+    * Set :guilabel:`Guest operating system` to :guilabel:`Linux`.
+    * Set :guilabel:`Version` to :guilabel:`Other Linux 3.x or later kernel 64-bit`.
+    * Click :guilabel:`Next`.
+
+      .. figure:: figures/vmware-player/vmware-player-3.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Select guest operating system type
+
+      Figure 15: VMware Workstation 14 Player - Select guest operating system type
+
+#.  :guilabel:`Name the Virtual Machine`:
+
+    * Give it a name.
+    * Click :guilabel:`Next`.
+
+      .. figure:: figures/vmware-player/vmware-player-4.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Name virtual machine
+
+      Figure 16: VMware Workstation 14 Player - Name virtual machine
+
+#.  :guilabel:`Specify Disk Capacity`:
+
+    * Click :guilabel:`Next`.  The default disk size does not matter because it 
+      will be removed when the ready-made VMware |CL| image is attached later.
+
+      .. figure:: figures/vmware-player/vmware-player-17.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Set disk capacity
+
+      Figure 17: VMware Workstation 14 Player - Set disk capacity
+
+#.  :guilabel:`Ready to Create Virtual Machine`:
+
+    * Click :guilabel:`Customize Hardware...`
+    
+      .. figure:: figures/vmware-player/vmware-player-6.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Customize hardware
+
+      Figure 18: VMware Workstation 14 Player - Customize hardware
+
+    * Select :guilabel:`Processors` > :guilabel:`Virtualization engine`, and 
+      check :guilabel:`Virtualize Intel VT-x/EPT or AMD-V/RVI`.
+
+      .. figure:: figures/vmware-player/vmware-player-8.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Set virtualization engine option
+
+      Figure 19: VMware Workstation 14 Player - Set virtualization engine option
+
+    * Click :guilabel:`Close`.
+    * Click :guilabel:`Finish`.
+    
+Attach the ready-made VMware Clear Linux image
+**********************************************
+
+#.  Move or copy the ready-made VMware |CL| image file (i.e. `clear-<version>-basic.vmdk`)
+    to the directory where the newly created VM resides.
+
+    .. note::
+
+      VMware VM files are typically located in:
+
+      * Linux distros: `/home/username/vmware`
+      * Windows: `C:/\Users/\username/\Documents/\Virtual Machines`
+
+#.  On the `VMware Workstation Player` home screen:
+
+    * Select the newly created VM.
+    * Click :guilabel:`Edit virtual machine settings`.  
+
+      .. figure:: figures/vmware-player/vmware-player-20.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Edit virtual machine settings
+
+      Figure 20: VMware Workstation 14 Player - Edit virtual machine settings
+
+#.  Disconnect the CD/DVD (IDE):
+
+    * Select :guilabel:`CD/DVD (IDE)` and under :guilabel:`Device status`, uncheck :guilabel:`Connect at 
+      power on`. 
+
+      .. figure:: figures/vmware-player/vmware-player-21.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Disconnect CD/DVD (IDE)
+
+      Figure 21: VMware Workstation 14 Player - Disconnect CD/DVD (IDE)
+
+#.  Remove the default hard disk:
+
+    * Under the :guilabel:`Hardware` tab, select :guilabel:`Hard Disk (SCSI)`.
+    * Click :guilabel:`Remove`.
+
+      .. figure:: figures/vmware-player/vmware-player-22.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Remove hard drive
+
+      Figure 22: VMware Workstation 14 Player - Remove hard drive
+
+#.  Add a new hard disk and attach the ready-made VMware |CL| image:
+
+    * Click :guilabel:`Add`.
+    * Under :guilabel:`Hardware types`, select :guilabel:`Hard Disk`.
+    * Click :guilabel:`Next`.
+
+      .. figure:: figures/vmware-player/vmware-player-23.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Add new hard drive
+
+      Figure 23: VMware Workstation 14 Player - Add new hard drive
+
+    * Select the preferred :guilabel:`Virtual disk type`.
+
+      .. figure:: figures/vmware-player/vmware-player-24.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Select virtual disk type
+
+      Figure 24: VMware Workstation 14 Player - Select virtual disk type
+
+    * Select :guilabel:`Use an existing virtual disk`.
+ 
+      .. figure:: figures/vmware-player/vmware-player-25.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Use existing virtual disk
+
+      Figure 25: VMware Workstation 14 Player - Use existing virtual disk
+   
+    * Click :guilabel:`Browse` and select the ready-made VMware |CL| image file.
+
+      .. figure:: figures/vmware-player/vmware-player-26.png
+        :scale: 100%
+        :alt: VMware Workstation 14 Player - Select ready-made VMware |CL| 
+
+      Figure 26: VMware Workstation 14 Player - Select ready-made VMware |CL| 
+      image file
+
+    * Click :guilabel:`Finish`.
+
+      .. note::
+          When asked to convert the disk image, either option works. 
+
+Enable UEFI boot support
+************************
+
+|CL| needs UEFI support in order to boot.  Enable it by appending to the end  
+of the VM's :file:`.vmx` file:
+
+  .. code-block:: console
+
+    firmware = "efi"
+
+.. note::
+
+  VMware VM files are typically located in:
+
+  * Linux distros: `/home/username/vmware`
+  * Windows: `C:/\Users/\username/\Documents/\Virtual Machines` (The file type 
+    is `VMware virtual machine configuration`.)
+
+Power on the virtual machine
+****************************
+
+After configuring the settings above, power on the virtual machine.  
+
+Also see:
+
+   * :ref:`vmware-esxi`
+
+.. _VMware Workstation 14 Player: https://www.vmware.com/products/workstation-player.html
+.. _VMware Workstation Player guide: https://docs.vmware.com/en/VMware-Workstation-Player/index.html
 .. _latest: https://download.clearlinux.org/image/
 .. _7zip: http://www.7-zip.org/
 .. _VirtualBox: https://www.virtualbox.org/
+.. _image: https://download.clearlinux.org/image
+.. _releases: https://download.clearlinux.org/releases
+.. _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
+