diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-01.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-01.png new file mode 100644 index 00000000..69b6a24e Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-01.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-02.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-02.png new file mode 100644 index 00000000..d24c0612 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-02.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-03.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-03.png new file mode 100644 index 00000000..2fbe4cea Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-03.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-04.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-04.png new file mode 100644 index 00000000..6a01685f Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-04.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-05.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-05.png new file mode 100644 index 00000000..22f40dfc Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-05.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-06.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-06.png new file mode 100644 index 00000000..eeb4b36e Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-06.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-07.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-07.png new file mode 100644 index 00000000..4f46b24e Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-07.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-08.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-08.png new file mode 100644 index 00000000..d86378bb Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-08.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-09.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-09.png new file mode 100644 index 00000000..416fb206 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-09.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-10.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-10.png new file mode 100644 index 00000000..3efc71e4 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-10.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-11.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-11.png new file mode 100644 index 00000000..8cd9d0a9 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-11.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-12.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-12.png new file mode 100644 index 00000000..36f43d3e Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-12.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-13.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-13.png new file mode 100644 index 00000000..30f77a88 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-13.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-14.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-14.png new file mode 100644 index 00000000..e115111e Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-14.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-15.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-15.png new file mode 100644 index 00000000..7d2111fa Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player-preconf/vmw-player-preconf-15.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-01.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-01.png new file mode 100644 index 00000000..69b6a24e Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-01.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-02.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-02.png new file mode 100644 index 00000000..3f1833c7 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-02.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-03.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-03.png new file mode 100644 index 00000000..2fbe4cea Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-03.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-04.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-04.png new file mode 100644 index 00000000..6a01685f Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-04.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-05.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-05.png new file mode 100644 index 00000000..a0bd62a2 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-05.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-06.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-06.png new file mode 100644 index 00000000..eeb4b36e Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-06.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-07.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-07.png new file mode 100644 index 00000000..0a86cdbb Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-07.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-08.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-08.png new file mode 100644 index 00000000..4f46b24e Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-08.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-09.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-09.png new file mode 100644 index 00000000..7d2111fa Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-09.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-10.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-10.png new file mode 100644 index 00000000..7ef566b2 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-10.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-11.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-11.png new file mode 100644 index 00000000..2387eb46 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-11.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-12.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-12.png new file mode 100644 index 00000000..7ea29cc7 Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-12.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-13.png b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-13.png new file mode 100644 index 00000000..7d2111fa Binary files /dev/null and b/source/clear-linux/get-started/virtual-machine-install/figures/vmw-player/vmw-player-13.png differ diff --git a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst index a97fe829..760f8500 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst @@ -32,6 +32,7 @@ appropriate set of step-by-step instructions to proceed. virtualbox vmware-esxi-install-cl vmware-esxi-preconfigured-cl-image - vmware-player + vmw-player + vmw-player-preconf hyper-v diff --git a/source/clear-linux/get-started/virtual-machine-install/vmw-player-preconf.rst b/source/clear-linux/get-started/virtual-machine-install/vmw-player-preconf.rst new file mode 100644 index 00000000..4cde924b --- /dev/null +++ b/source/clear-linux/get-started/virtual-machine-install/vmw-player-preconf.rst @@ -0,0 +1,314 @@ +.. _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. 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 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 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 :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: + + * 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. + + .. code-block:: console + + sudo sh ./VMware-Player-[version number].x86_64.bundle + + * On Windows: + + #. Start the installer. + #. Follow the setup wizard. + +For additional help, see the `VMware Workstation Player guide`_. + +Clear Linux image types +*********************** + +.. include:: ../../guides/maintenance/image-types.rst + :Start-after: image-types-content: + +Download the latest Clear Linux VMware image +******************************************** + +Get the latest |CL| VMware image from the `image`_ repository. +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: + +* :ref:`download-verify-uncompress-linux` +* :ref:`download-verify-uncompress-mac` + +Create and configure a new VM +***************************** + +#. Start the `VMware Workstation Player` app. +#. On the home screen, click :guilabel:`Create a New Virtual Machine`. See + figure 1. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-01.png + :scale: 100% + :alt: 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` screen, select + the :guilabel:`I will install the operating system later` option. + See figure 2. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-02.png + :scale: 100% + :alt: VMware Workstation 14 Player - Select install operating system + + Figure 2: VMware Workstation 14 Player - Select install operating system + later. + +#. Click the :guilabel:`Next` button. + +#. On the :guilabel:`Select a Guest Operating System` screen, set the + :guilabel:`Guest operating system` setting to :guilabel:`Linux`. + See figure 3. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-03.png + :scale: 100% + :alt: 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`. + +#. Click the :guilabel:`Next` button. + +#. On the :guilabel:`Name the Virtual Machine` screen, give your new VM a name. + See figure 4. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-04.png + :scale: 100% + :alt: VMware Workstation 14 Player - Name virtual machine + + Figure 4: VMware Workstation 14 Player - Name virtual machine + +#. Click the :guilabel:`Next` button. + +#. On the :guilabel:`Specify Disk Capacity` screen, click the :guilabel:`Next` + button. Keep the default disk settings unchanged. When we attach the pre-configured |CL| + VMware image, we will remove the default virtual disk and replace it with the + pre-configured one. See figure 5. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-05.png + :scale: 100% + :alt: VMware Workstation 14 Player - Set disk capacity + + Figure 5: VMware Workstation 14 Player - Set disk capacity + +#. On the :guilabel:`Ready to Create Virtual Machine` screen, click the + :guilabel:`Customize Hardware...` button. See figure 6. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-06.png + :scale: 100% + :alt: 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. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-07.png + :scale: 100% + :alt: VMware Workstation 14 Player - Set virtualization engine option + + Figure 7: VMware Workstation 14 Player - Set virtualization engine option + +#. Under the :guilabel:`Virtualization engine` section, + check :guilabel:`Virtualize Intel VT-x/EPT or AMD-V/RVI`. + +#. 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/vmw-player-preconf/vmw-player-preconf-08.png + :scale: 100% + :alt: 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. + +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. + + .. note:: + + 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` + +#. On the :guilabel:`VMware Workstation Player` home screen, select your + newly-created VM. See figure 9. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-09.png + :scale: 100% + :alt: VMware Workstation 14 Player - Edit virtual machine settings + + Figure 9: VMware Workstation 14 Player - Edit virtual machine settings + +#. Click :guilabel:`Edit virtual machine settings`. + +#. To remove the default hard disk, under the :guilabel:`Device` list, select + :guilabel:`Hard Disk (SCSI)`. See figure 10. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-10.png + :scale: 100% + :alt: VMware Workstation 14 Player - Remove hard drive + + Figure 10: VMware Workstation 14 Player - Remove hard drive + +#. Click the :guilabel:`Remove` button. + +#. To add a new hard disk and attach the pre-configured |CL| VMware image, + click the :guilabel:`Add...` button. See Figure 11. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-11.png + :scale: 100% + :alt: 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`. + +#. Click the :guilabel:`Next` button. + +#. Select your preferred :guilabel:`Virtual disk type`. See figure 12. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-12.png + :scale: 100% + :alt: VMware Workstation 14 Player - Select virtual disk type + + Figure 12: VMware Workstation 14 Player - Select virtual disk type + +#. Select the :guilabel:`Use an existing virtual disk` option. See figure 13. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-13.png + :scale: 100% + :alt: VMware Workstation 14 Player - Use existing virtual disk + + 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. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-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 to boot.To enable it, add the +following line to the end of your VM's :file:`.vmx` file: + +.. code-block:: console + + firmware = "efi" + +.. note:: + + 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. + +#. On the :guilabel:`VMware Workstation Player` home screen, select your + VM. See figure 15. + + .. figure:: figures/vmw-player-preconf/vmw-player-preconf-15.png + :scale: 100% + :alt: VMware Workstation 14 Player - Power on virtual machine + + Figure 15: VMware Workstation 14 Player - Power on virtual machine + +#. Click :guilabel:`Play virtual machine`. + +For other guides on using the VMWare Player and ESXi, see: + +* :ref:`vmw-player` +* :ref:`vmware-esxi-install-cl` +* :ref:`vmware-esxi-preconfigured-cl-image` + +.. _VMware ESXi: https://www.vmware.com/products/esxi-and-esx.html +.. _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/ +.. _image: https://download.clearlinux.org/image + + + + diff --git a/source/clear-linux/get-started/virtual-machine-install/vmw-player.rst b/source/clear-linux/get-started/virtual-machine-install/vmw-player.rst new file mode 100644 index 00000000..5bd5afcd --- /dev/null +++ b/source/clear-linux/get-started/virtual-machine-install/vmw-player.rst @@ -0,0 +1,313 @@ +.. _vmw-player: + +Install Clear Linux as a VMware\* Workstation Player guest OS +############################################################# + +`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 how to create a new VM and install |CL| into it with the +VMware Workstation 14 Player hypervisor. Installing |CL| into a new VM +provides you flexibility when configuring the VM. You can configure the VM's +size, number of partitions, installed bundles, etc. + +In this tutorial, we perform the following steps: + +#. Install the VMware Workstation Player hypervisor +#. Download the latest |CL| installer ISO +#. Verify the integrity of the |CL| image +#. Uncompress the |CL| image +#. Create and configure a new VM +#. Attach the |CL| installer ISO to the VM +#. Install |CL| into the new VM +#. Detach the |CL| installer ISO from the VM +#. Power off the VM +#. Enable EFI boot support +#. Power on the VM + +If you prefer to use a pre-configured |CL| VMware image instead, +see our :ref:`vmw-player-preconf` guide. + +VMware offers a type 1 hypervisor called `VMware ESXi`_ designed for the +cloud environment. For information on how to install |CL| as guest OS on +it, see :ref:`vmware-esxi-install-cl`. + +.. note:: + + 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 :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. + +#. Install VMware Workstation 14 Player following the instructions + appropriate for your system's OS: + + * 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. + + .. code-block:: console + + $ sudo sh ./VMware-Player-[version number].x86_64.bundle + + * On Windows: + + #. Start the installer. + #. Follow the setup wizard. + +For additional help, see the `VMware Workstation Player guide`_. + +Clear Linux image types +*********************** + +.. include:: ../../guides/maintenance/image-types.rst + :Start-after: image-types-content: + + +Download the latest Clear Linux installer ISO +********************************************* + +Get the latest |CL| installer ISO image from the `image`_ repository. +Look for :file:`clear-[version number]-installer.iso.xz`. + +.. include:: ../../guides/maintenance/download-verify-uncompress-windows.rst + :Start-after: verify-windows: + +We also provide instructions for other operating systems: + +* :ref:`download-verify-uncompress-linux` +* :ref:`download-verify-uncompress-mac` + +Create and configure a new VM +***************************** + +#. Start the `VMware Workstation Player` app. + +#. On the home screen, click :guilabel:`Create a New Virtual Machine`. See + Figure 1. + + .. figure:: figures/vmw-player/vmw-player-01.png + :scale: 100% + :alt: 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` screen, + select the :guilabel:`Installer disc image file (iso)` option. + See Figure 2. + + .. figure:: figures/vmw-player/vmw-player-02.png + :scale: 100% + :alt: VMware Workstation 14 Player - Select |CL| installer ISO + + Figure 2: VMware Workstation 14 Player - Select |CL| installer ISO + +#. Click the :guilabel:`Browse` button and select the uncompressed |CL| + installer ISO. + +#. Click the :guilabel:`Next` button. + +#. On the :guilabel:`Select a Guest Operating System`, set the + :guilabel:`Guest operating system` setting to :guilabel:`Linux`. See + Figure 3. + + .. figure:: figures/vmw-player/vmw-player-03.png + :scale: 100% + :alt: VMware Workstation 14 Player - Select guest operating system type + + Figure 3: VMware Workstation 14 Player - Select guest operating system + type + +#. Set the :guilabel:`Version` setting to + :guilabel:`Other Linux 3.x or later kernel 64-bit`. + +#. Click the :guilabel:`Next` button. + +#. On the :guilabel:`Name the Virtual Machine` screen, name the new VM. See + Figure 4. + + .. figure:: figures/vmw-player/vmw-player-04.png + :scale: 100% + :alt: VMware Workstation 14 Player - Name virtual machine + + Figure 4: VMware Workstation 14 Player - Name virtual machine + +#. Click the :guilabel:`Next` button. + +#. On the :guilabel:`Specify Disk Capacity` screen, set the VM's maximum disk + size. See Figure 5. + + .. figure:: figures/vmw-player/vmw-player-05.png + :scale: 100% + :alt: VMware Workstation 14 Player - Set disk capacity + + Figure 5: VMware Workstation 14 Player - Set disk capacity + + .. note:: + A minimal |CL| installation can exist on 600MB of drive space. + See :ref:`system-requirements` for more details. + +#. Click the :guilabel:`Next` button. + +#. On the :guilabel:`Ready to Create Virtual Machine` screen, click the + :guilabel:`Customize Hardware...` button. See Figure 6. + + .. figure:: figures/vmw-player/vmw-player-06.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. See Figure 7. + + .. figure:: figures/vmw-player/vmw-player-07.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. + After completing installation, |CL| can run on as little as + 128MB of RAM. Thus, you can reduce the memory size if needed. + See :ref:`system-requirements` for more details. + +#. Under the :guilabel:`Device` list, select :guilabel:`Processors`. See + Figure 8. + + .. figure:: figures/vmw-player/vmw-player-08.png + :scale: 100% + :alt: VMware Workstation 14 Player - Set virtualization engine option + + Figure 8: VMware Workstation 14 Player - Set virtualization engine + option + +#. Under the :guilabel:`Virtualization engine` section, + check :guilabel:`Virtualize Intel VT-x/EPT or AMD-V/RVI`. + +#. Click the :guilabel:`Close` button. + +#. Click the :guilabel:`Finish` button. + +Install Clear Linux into the new VM +*********************************** + +#. Select the newly-created VM and click the :guilabel:`Play virtual machine` + button. See Figure 9. + + .. figure:: figures/vmw-player/vmw-player-09.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 completes, reboot the VM. This reboot restarts the + |CL| installer. + +Detach the |CL| installer ISO from the VM +***************************************** + +#. To enable the mouse pointer so you access VMware Workstation Player's + menus, press :kbd:`` + :kbd:`` on the keyboard. + +#. To disconnect the CD/DVD to stop it from booting the |CL| installer ISO + again, click the :guilabel:`Player` menu. See Figure 10. + + .. figure:: figures/vmw-player/vmw-player-10.png + :scale: 100% + :alt: VMware Workstation 14 Player - Edit CD/DVD settings + + Figure 10: VMware Workstation 14 Player - Edit CD/DVD settings + +#. Go to :menuselection:`Removable Devices-->CD/DVD (IDE)-->Settings`. + +#. On the :guilabel:`Device status` section, uncheck the + :guilabel:`Connected` and the :guilabel:`Connect at power on` settings. + See Figure 11. + + .. figure:: figures/vmw-player/vmw-player-11.png + :scale: 100% + :alt: VMware Workstation 14 Player - Disconnect CD/DVD + + Figure 11: VMware Workstation 14 Player - Disconnect CD/DVD + +#. Click the :guilabel:`OK` button. + +#. To power off the VM, click the :guilabel:`Player` menu. See Figure 12. + + .. figure:: figures/vmw-player/vmw-player-12.png + :scale: 100% + :alt: VMware Workstation 14 Player - Power off virtual machine + + Figure 12: VMware Workstation 14 Player - Power off virtual machine + +#. Go to :guilabel:`Power` and select :guilabel:`Shut Down Guest`. + +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 + + firmware = "efi" + +.. note:: + + 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. + +#. On the :guilabel:`VMware Workstation Player` home screen, select your + VM. See Figure 13. + + .. figure:: figures/vmw-player/vmw-player-13.png + :scale: 100% + :alt: VMware Workstation 14 Player - Power on virtual machine + + Figure 13: VMware Workstation 14 Player - Power on virtual machine + +#. Click :guilabel:`Play virtual machine`. + +For other guides on using the VMWare Player and ESXi, see: + +* :ref:`vmw-player-preconf` +* :ref:`vmware-esxi-install-cl` +* :ref:`vmware-esxi-preconfigured-cl-image` + +.. _VMware ESXi: https://www.vmware.com/products/esxi-and-esx.html + +.. _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/ + +.. _image: https://download.clearlinux.org/image diff --git a/source/clear-linux/get-started/virtual-machine-install/vmware-player.rst b/source/clear-linux/get-started/virtual-machine-install/vmware-player.rst deleted file mode 100644 index b2d36417..00000000 --- a/source/clear-linux/get-started/virtual-machine-install/vmware-player.rst +++ /dev/null @@ -1,116 +0,0 @@ -.. _vmware-player: - -Use VMware\* Player -################### - -This section explains how to run Clear Linux OS for Intel® Architecture -within a `VMware Player`_ environment. - -Please ensure you have enabled `Intel® Virtualization Technology -`_ -(Intel® VT) and `Intel® Virtualization Technology for Directed I/O -`_ -(Intel® VT-d) in your BIOS/UEFI firmware configuration. - -Install VMware Player -===================== - -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`_. - -Player on Linux ---------------- - -For the Linux option, you should have a :file:`VMware-Player-{version}_FILE.bundle` -file. To install it, run: - -:: - - $ sudo bash ./VMware-Player-{version}.x86_64.bundle - -Player on Windows ------------------ - -Follow the instructions from the Setup Assistant. - - -Prepare Image -============= - -#. Download the `latest`_ |CL| **live** version (clear-XXXX-live.img.xz) - -#. Decompress the downloaded image. Uncompressed image size is ~ **5GB**. - - + On Linux :: - - $ xz -d clear-XXXX-live.img.xz - - + On Windows you can use `7zip`_. - - - Right-click the file to *extract in the same directory*. - - .. image:: ./figures/7zipwin.png - :alt: 7zip extract here command - -#. Convert the installer to :abbr:`VMDK (Virtual Machine Disk)` format. - - * On Linux, you can use ``qemu-img convert``:: - - $ qemu-img convert -O vmdk clear-VERSION-live.img clear.vmdk - - * 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 ` as example. - - -Run using VMware Player -======================= - - -Create a new virtual machine by following the next steps. - -#. Launch **VMWare Workstation Player**. - -#. On main window click on “Create a new Virtual Machine”. - - * 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. - -#. 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:: - - firmware = "efi" - -#. Attach the prepared image as SATA disk. And when you have a new virtual - machine, edit its configuration as follows: - - * Click on “Edit virtual machine settings”. - * Remove any default attached hard disk. - * Click on “Add” option below devices list tab and choose Hard disk. - - * Choose **SATA** as the virtual disk type. - * Use the existing Clear Linux OS for Intel Architecture virtual disk - - 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. - -Start the virtual machine -========================= - -After configuring the settings above, start the virtual machine. - - -.. _VMware website: https://www.vmware.com/products/player/playerpro-evaluation.html -.. _VMware Player: http://www.vmware.com/products/player/ -.. _latest: https://download.clearlinux.org/image/ -.. _7zip: http://www.7-zip.org/ -.. _VirtualBox: https://www.virtualbox.org/ -