Combine two VMWare guides into one: vmw-player. (#950)

* Combine VMWare guides into one, separate image types with tabs in vmw-player.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Re-arrange all figures into _figures dir and manage file dependencies.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Fix indentation error in tabs preventing successful build.
- Reorganize vmw-player-preconf figures.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Replace Figure 11; move Detach the |CL| installer ISO to Desktop tab.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Reorg figures and order of ops per forked flow, reviewer feedback.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
This commit is contained in:
michael vincerra
2019-12-09 10:16:36 -08:00
committed by GitHub
parent 410768be7e
commit 7a4e6c6d1c
32 changed files with 181 additions and 681 deletions

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Before

Width:  |  Height:  |  Size: 7.9 KiB

After

Width:  |  Height:  |  Size: 7.9 KiB

Before

Width:  |  Height:  |  Size: 7.4 KiB

After

Width:  |  Height:  |  Size: 7.4 KiB

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 KiB

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 85 KiB

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

Before

Width:  |  Height:  |  Size: 81 KiB

After

Width:  |  Height:  |  Size: 81 KiB

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 80 KiB

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 57 KiB

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

@@ -1,308 +0,0 @@
.. _vmw-player-preconf:
|CL-ATTR| on VMware\* Workstation Player (pre-configured image)
###############################################################
This page explains how to deploy a pre-configured |CL| VMware image on
`VMware Workstation 14 Player`_.
.. contents::
:local:
:depth: 1
Overview
********
VMware Workstation 14 Player is a type 2 hypervisor. For example, it runs on
top of Windows\* or Linux\* operating system. With VMware ESXi, you
can create, configure, manage, and run |CL-ATTR|
:abbr:`VMs (Virtual Machines)` on your local system.
.. note::
Screenshots in this document show VMware Workstation 14 Player for
Windows. Menus and prompts in the Linux version have 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 following the
guided steps.
.. code-block:: bash
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 Documentation`_.
Download the latest |CL| VMware image
*************************************
Get the latest |CL| VMware image from the `image repository`_.
Look for :file:`clear-[version number]-vmware.vmdk.xz`. You can also use
this command:
.. code-block:: bash
curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep vmware)
Decompress and verify the image
*******************************
Visit :ref:`download-verify-decompress` and follow the instructions for your
Windows\* or Linux\* environment. Visit :ref:`image-types` for additional
information about all available |CL| images.
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 |CL| VMware image
*******************************************
#. Move the downloaded and decompressed 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`.
Related topics
**************
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`
.. _image repository: https://cdn.download.clearlinux.org/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 Documentation: https://docs.vmware.com/en/VMware-Workstation-Player/index.html
@@ -3,8 +3,7 @@
|CL-ATTR| on VMware\* Workstation Player
########################################
This page explains how to create a new VM and install |CL| on it with the
VMware Workstation Player hypervisor.
This page explains how to create a new VMware Workstation Player hypervisor and use one of two images: the |CL| Desktop installer iso, or the |CL| Pre-configured VMWare image.
.. contents::
:local:
@@ -14,9 +13,9 @@ Overview
********
`VMware Workstation Player`_ is a type 2 hypervisor. It runs on top of
Windows\* or Linux\* operating systems. With VMware Workstation Player, you can
create, configure, manage, and run |CL-ATTR| :abbr:`VMs (Virtual Machines)`
on your local system.
Windows\* or Linux\* operating systems. With VMware Workstation Player,
you can create, configure, manage, and run |CL-ATTR|
:abbr:`VMs (Virtual Machines)` on your local system.
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
@@ -26,10 +25,8 @@ it, see :ref:`vmware-esxi-install-cl`.
The screenshots on this document show the Windows version of the
VMware Workstation 15 Player. The menus and prompts are similar to those
in other versions and for the Linux OS save some minor wording differences.
If you prefer to use a pre-configured |CL| VMware image instead,
see our :ref:`vmw-player-preconf` guide.
in other versions and for the Linux OS save some minor wording
differences.
Install the VMware Workstation Player hypervisor
************************************************
@@ -46,8 +43,8 @@ Install the VMware Workstation Player hypervisor
By default, selecting download means you receive the latest version
of this application. Commands may differ based on the version.
#. Install VMware Workstation Player following the instructions
appropriate for your system's OS:
#. Install VMware Workstation Player by following the instructions
appropriate for your system OS:
* On supported Linux distros:
@@ -67,43 +64,28 @@ Install the VMware Workstation Player hypervisor
For additional help, see the `VMware Workstation Player Documentation`_.
Download the latest |CL| installer
**********************************
Get the latest installer with |CL| OS Desktop from the `downloads`_ page.
Visit :ref:`image-types` for additional information about all available |CL| images.
We also provide instructions for downloading and verifying a Clear Linux ISO.
For more information, refer to :ref:`download-verify-decompress`.
Create and configure a new VM
*****************************
#. Start the `VMware Workstation Player` app.
#. 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
.. figure:: /_figures/vmw-player/vmw-player-01.png
:scale: 100%
:alt: VMware Workstation Player - Create a new virtual machine
Figure 1: VMware Workstation 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.
#. Select :guilabel:`I will install the operating system later`.
.. figure:: figures/vmw-player/vmw-player-02.png
.. figure:: /_figures/vmw-player/vmw-player-02.png
:scale: 100%
:alt: VMware Workstation Player - Select |CL| installer ISO
:alt: I will install the operating system later.
Figure 2: VMware Workstation Player - Select |CL| installer ISO
#. Click the :guilabel:`Browse` button and select the decompressed |CL|
installer ISO.
Figure 2: I will install the operating system later.
#. Click the :guilabel:`Next` button.
@@ -111,7 +93,7 @@ Create and configure a new VM
:guilabel:`Guest operating system` setting to :guilabel:`Linux`. See
Figure 3.
.. figure:: figures/vmw-player/vmw-player-03.png
.. figure:: /_figures/vmw-player/vmw-player-03.png
:scale: 100%
:alt: VMware Workstation Player - Select guest operating system type
@@ -119,14 +101,14 @@ Create and configure a new VM
type
#. Set the :guilabel:`Version` setting to
:guilabel:`Other Linux 4.x or later kernel 64-bit`.
:guilabel:`Other Linux 5.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
.. figure:: /_figures/vmw-player/vmw-player-04.png
:scale: 100%
:alt: VMware Workstation Player - Name virtual machine
@@ -137,7 +119,7 @@ Create and configure a new VM
#. 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
.. figure:: /_figures/vmw-player/vmw-player-05.png
:scale: 100%
:alt: VMware Workstation Player - Set disk capacity
@@ -153,7 +135,7 @@ Create and configure a new VM
#. 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
.. figure:: /_figures/vmw-player/vmw-player-06.png
:scale: 100%
:alt: VMware Workstation Player - Customize hardware
@@ -161,13 +143,14 @@ Create and configure a new VM
#. Select :guilabel:`Memory` and set the size to 2GB. See Figure 7.
.. figure:: figures/vmw-player/vmw-player-07.png
.. figure:: /_figures/vmw-player/vmw-player-07.png
:scale: 100%
:alt: VMware Workstation Player - Set memory size
Figure 7: VMware Workstation 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.
@@ -176,13 +159,16 @@ Create and configure a new VM
#. Under the :guilabel:`Device` list, select :guilabel:`Processors`. See
Figure 8.
.. figure:: figures/vmw-player/vmw-player-08.png
.. figure:: /_figures/vmw-player/vmw-player-08.png
:scale: 100%
:alt: VMware Workstation Player - Set virtualization engine option
Figure 8: VMware Workstation Player - Set virtualization engine
option
#. Under :guilabel:`Processors` and :guilabel:`Number of processor cores`,
enter 4.
#. Under the :guilabel:`Virtualization engine` section,
check :guilabel:`Virtualize Intel VT-x/EPT or AMD-V/RVI`.
@@ -197,7 +183,7 @@ Enable UEFI boot support
#. Power off the VM. click the :guilabel:`Player` menu. See Figure 9.
.. figure:: figures/vmw-player/vmw-player-09.png
.. figure:: /_figures/vmw-player/vmw-player-09.png
:scale: 100%
:alt: VMware Workstation Player - Power off virtual machine
@@ -205,7 +191,7 @@ Enable UEFI boot support
#. Go to :guilabel:`Power` and select :guilabel:`Shut Down Guest`.
#. Add the following line to the end of your VM's :file:`.vmx` file:
#. Add the following line to the end of your VM's :file:`.vmx` file.
.. code-block:: console
@@ -218,43 +204,164 @@ Enable UEFI boot support
* On Linux distros: :file:`/home/username/vmware`
* On Windows: :file:`C:\\Users\\username\\Documents\\Virtual Machines`
Download the latest |CL| image
******************************
Download the appropriate image per the tab below. We also provide
additional information about :ref:`image-types` and instructions on how to
:ref:`download-verify-decompress`.
Attach the appropriate image
============================
.. tabs::
.. tab:: |CL| Desktop
This option provides a live-desktop iso installer.
#. Navigate to the `downloads`_ page and download the |CL| Desktop.
After the download is complete, you will attach this image.
#. On the :guilabel:`VMware Workstation 15 Player`, right-click the
new VM, created in `Create and configure a new VM`_.
#. From the pop-up menu, select :guilabel:`Settings`.
#. From :guilabel:`Virtual Machine settings`,
under :guilabel:`Hardware`, select ``CD/DVD``.
#. Under :guilabel:`Connection` at right, select
:guilabel:`Use ISO image file`.
#. Click :guilabel:`Browse` and select the decompressed
|CL| installer ISO. See Figure 10.
.. figure:: /_figures/vmw-player/vmw-player-10.png
:scale: 100%
:alt: VMware Workstation Player - Select |CL| installer ISO
Figure 10: VMware Workstation Player - Select |CL| installer
ISO
#. Follow the guide :ref:`install-on-target-start` to complete the
installation of |CL|.
#. After the installation completes, reboot the VM. This reboot
restarts the |CL| installer.
#. To enable the mouse pointer so you access VMware Workstation
Player's menus, press :kbd:`<CTRL>` + :kbd:`<ALT>` 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 below.
.. figure:: /_figures/vmw-player/vmw-player-11.png
:scale: 100%
:alt: VMware Workstation Player - Edit CD/DVD settings
Figure 11: VMware Workstation Player - Edit CD/DVD settings
#. Go to :menuselection:`Removable Devices-->CD/DVD
(IDE)-->Disconnect`.
#. Click the :guilabel:`OK` button.
#. Continue below.
.. tab:: |CL| Pre-configured VMWare image
#. Navigate to the `downloads`_ page and select the ``VMware``
image. Look for :file:`clear-[version number]-vmware.vmdk.xz`.
#. Move the downloaded and decompressed 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:
* Linux distros :file:`/home/username/vmware`
* Windows :file:`C:\Users\username\Documents\Virtual Machines`
#. On the :guilabel:`VMware Workstation 15 Player`, right-click the
new VM, created in `Create and configure a new VM`_.
#. From the pop-up menu, select :guilabel:`Settings`.
#. Under :guilabel:`Hardware` and :guilabel:`Device` list, select
:guilabel:`Hard Disk (SCSI)`. See figure 12.
.. figure:: /_figures/vmw-player/vmw-player-preconf-12.png
:scale: 100%
:alt: VMware Workstation Player - Remove hard drive
Figure 12: VMware Workstation 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 13.
.. figure:: /_figures/vmw-player/vmw-player-preconf-13.png
:scale: 100%
:alt: VMware Workstation Player - Add new hard drive
Figure 13: VMware Workstation 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 14.
.. figure:: /_figures/vmw-player/vmw-player-preconf-14.png
:scale: 100%
:alt: VMware Workstation Player - Select virtual disk type
Figure 14: VMware Workstation Player - Select virtual disk type
#. Select the :guilabel:`Use an existing virtual disk` option.
See figure 15.
.. figure:: /_figures/vmw-player/vmw-player-preconf-15.png
:scale: 100%
:alt: VMware Workstation Player - Use existing virtual disk
Figure 15: VMware Workstation Player - Use existing virtual disk
#. Click the :guilabel:`Browse` button and select the
pre-configured |CL| VMware image file. See figure 16.
.. figure:: ../../_figures/vmw-player/vmw-player-preconf-16.png
:scale: 100%
:alt: VMware Workstation Player - Select ready-made VMware |CL|
Figure 16: VMware Workstation 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.
Install |CL| into the new VM
****************************
#. Select the newly-created VM and click the :guilabel:`Play virtual machine`
button. See Figure 10.
button. See Figure below.
.. figure:: figures/vmw-player/vmw-player-10.png
.. figure:: /_figures/vmw-player/vmw-player-17.png
:scale: 100%
:alt: VMware Workstation Player - Power on virtual machine
Figure 10: VMware Workstation Player - Power on virtual machine
#. Follow the :ref:`install-on-target-start` 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:`<CTRL>` + :kbd:`<ALT>` 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 11.
.. figure:: figures/vmw-player/vmw-player-11.png
:scale: 100%
:alt: VMware Workstation Player - Edit CD/DVD settings
Figure 11: VMware Workstation Player - Edit CD/DVD settings
#. Go to :menuselection:`Removable Devices-->CD/DVD (IDE)-->Disconnect`.
#. Click the :guilabel:`OK` button.
Figure 17: VMware Workstation Player - Power on virtual machine
Install open-vm-tools
*********************
@@ -262,8 +369,9 @@ Optional: You may want to install the `open-vm-tools` in your virtual
machine. The Open Virtual Machine Tools (open-vm-tools) are the open source
implementation of VMware Tools for Linux\* guest operating systems.
#. Power on your |CL| virtual machine. On the
:guilabel:`VMware Workstation Player` home screen, select your VM. See Figure 10.
#. Power on your |CL| virtual machine. On the
:guilabel:`VMware Workstation Player` home screen, select your VM.
See Figure 10.
#. Click :guilabel:`Play virtual machine`.
@@ -282,9 +390,7 @@ Related topics
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
@@ -21,13 +21,9 @@ Manually installing |CL| on a new VM gives additional configuration flexibility
during installation. For example: alternate disk sizes, number of partitions,
pre-installed bundles, etc.
If you prefer to use a pre-configured |CL| VMware image instead, refer to
:ref:`vmware-esxi-preconfigured-cl-image`.
.. note::
VMware also offers a type 2 hypervisor designed for the desktop environment,
called `VMware Workstation Player`_. Refer to :ref:`vmw-player-preconf` or
VMware also offers a type 2 hypervisor designed for the desktop environment, called `VMware Workstation Player`_. Refer to
:ref:`vmw-player` for more information.
Visit :ref:`image-types` to learn more about all available images.
@@ -277,12 +273,6 @@ After configuring the settings above, power on the VM.
Figure 16: VMware ESXi - Navigator > Virtual Machines > Power on VM
Related topics
**************
* :ref:`vmware-esxi-preconfigured-cl-image`
.. _VMware ESXi: https://www.vmware.com/products/esxi-and-esx.html
.. _VMware Workstation Player: https://www.vmware.com/products/workstation-player.html
.. _image: https://cdn.download.clearlinux.org/image/
@@ -1,288 +0,0 @@
.. _vmware-esxi-preconfigured-cl-image:
|CL-ATTR| on VMware\* ESXi (pre-configured image)
#################################################
This page explains how to deploy a pre-configured |CL| VMware
:abbr:`VM (Virtual Machine)` image on a VMware ESXi 6.5 host.
.. contents::
:local:
:depth: 1
Overview
********
`VMware ESXi`_ is a type 1 bare-metal hypervisor which runs directly on top
of server hardware. With VMware ESXi, you can create, configure, manage,
and run |CL-ATTR| virtual machines at scale.
We provide a pre-configured |CL| VMware image that can be run on a VMware ESXi
6.5 host.
If manual installation is preferred, refer to :ref:`vmware-esxi-install-cl`.
.. note::
VMware also offers a type 2 hypervisor designed for the desktop environment,
called `VMware Workstation Player`_. Refer to :ref:`vmw-player-preconf` or
:ref:`vmw-player` for more information.
Download the latest |CL| VMware image
*************************************
Get the latest |CL| VMware prebuilt image from the `image`_ repository.
Look for :file:`clear-[version number]-vmware.vmdk.xz`. You can also use
this command:
.. code-block:: bash
curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep vmware)
Visit :ref:`image-types` for additional information about all available |CL| images.
We also provide instructions for downloading and verifying a Clear Linux ISO.
For more information, refer to :ref:`download-verify-decompress`.
Upload the |CL| image to the VMware server
******************************************
Once the |CL| VMware prebuilt image has been downloaded and
decompressed on your local system, it must be uploaded to a datastore
on the VMware ESXi server.
The steps in this section can also be referenced from the VMware documentation
`Using Datastore File Browser in the VMware Host Client`_.
#. Connect to the VMware ESXi server and login to an account with sufficient
permission to create and manage VMs.
#. Under the :guilabel:`Navigator` window on the left side,
select :guilabel:`Storage`.
See Figure 1
#. Under the :guilabel:`Datastores` tab, click
the :guilabel:`Datastore browser` button.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-1.png
:scale: 100 %
:alt: VMware ESXi - Navigator > Storage
Figure 1: VMware ESXi - Navigator > Storage
#. Click the :guilabel:`Create directory` button and name the directory
`Clear Linux VM`. See Figure 2.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-2.png
:scale: 100 %
:alt: VMware ESXi - Datastore > Create directory
Figure 2: VMware ESXi - Datastore > Create directory
#. Select the newly-created directory and click the :guilabel:`Upload`
button. See Figure 3.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-3.png
:scale: 100 %
:alt: VMware ESXi - Datastore > Upload VMware image
Figure 3: VMware ESXi - Datastore > Upload VMware image
#. Select the decompressed |CL| VMware image file
:file:`clear-[version number]-vmware.vmdk` and upload it.
Convert the |CL| image to an ESXi-supported format
**************************************************
Once the |CL| VMware prebuilt image has been uploaded to the VMware ESXi
datastore, it must be converted to a format for use with VMware's ESXi
hypervisor.
The steps in this section can also be referenced from the VMware documentation on `Cloning and converting virtual machine disks with vmkfstools`_
#. SSH into the `vSphere Management Assistant`_ appliance that is managing
the ESXi host or connect to the vSphere hosting using the `vSphere CLI`_.
.. note::
If there is no :abbr:`vMA (vSphere Management Assistant)` appliance or :abbr:`vCLI (vSphere CLI)` configured and available,
you can temporarily enable SSH directly on the ESXi host by following the
steps described in `Enable the Secure Shell (SSH) in the VMware Host Client`_.
As a security best practice, remember to disable SSH access after following the steps in this section.
#. Locate the uploaded image, which is typically found in
:file:`/vmfs/volumes/datastore1`.
#. Use the :command:`vmkfstools` command to perform the conversion, as
shown below:
.. code-block:: console
vmkfstools -i clear-[version number]-vmware.vmdk -d zeroedthick clear-[version number]-esxi.vmdk
Two files should result from this:
* :file:`clear-[version number]-esxi-flat.vmdk`
* :file:`clear-[version number]-esxi.vmdk`
The :file:`clear-[version number]-esxi.vmdk` file will be used in the
next section when you create a new VM.
Create and configure a new VM
*****************************
In this section, you will create a new VM, configure its basic parameters
such as number of CPUs, memory size, and then attach the converted |CL|
VMware image. Also, in order to boot |CL|, you must enable UEFI support.
#. Under the :guilabel:`Navigator` window, select
:guilabel:`Virtual Machines`. See Figure 4.
#. In the right window, click the :guilabel:`Create / Register VM` button.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-4.png
:scale: 100 %
:alt: VMware ESXi - Navigator > Virtual Machines
Figure 4: VMware ESXi - Navigator > Virtual Machines
#. On the :guilabel:`Select creation type` step:
#. Select the :guilabel:`Create a new virtual machine` option. See
Figure 5.
#. Click the :guilabel:`Next` button.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-5.png
:scale: 100 %
:alt: VMware ESXi - Create a new virtual machine
Figure 5: VMware ESXi - Create a new virtual machine
#. On the :guilabel:`Select a name and guest OS` step:
#. Give the new VM a name in the :guilabel:`Name` field. See Figure 6.
#. Set the :guilabel:`Compatibility` option to
:guilabel:`ESXi 6.5 virtual machine`.
#. Set the :guilabel:`Guest OS family` option to :guilabel:`Linux`.
#. Set the :guilabel:`Guest OS version` option to
:guilabel:`Other 3.x or later Linux (64-bit)`.
#. Click the :guilabel:`Next` button.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-6.png
:scale: 100 %
:alt: VMware ESXi - Give a name and select guest OS type
Figure 6: VMware ESXi - Give a name and select guest OS type
#. On the :guilabel:`Select storage` step:
#. Accept the default option.
#. Click the :guilabel:`Next` button.
#. On the :guilabel:`Customize settings` step:
#. Click the :guilabel:`Virtual Hardware` button. See Figure 7.
#. Expand the :guilabel:`CPU` setting and enable
:guilabel:`Hardware virtualization` by checking
:guilabel:`Expose hardware assisted virtualization to the guest OS`.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-7.png
:scale: 100 %
:alt: VMware ESXi - Enable hardware virtualization
Figure 7: VMware ESXi - Enable hardware virtualization
#. Remove the default :guilabel:`Hard drive 1` setting by clicking
the `X` icon on the right side. See Figure 8.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-8.png
:scale: 100 %
:alt: VMware ESXi - Remove hard drive
Figure 8: VMware ESXi - Remove hard drive
#. Since a pre-configured image will be used,
the :guilabel:`CD/DVD Drive 1` setting will not be needed. Disable it
by unchecking the :guilabel:`Connect` checkbox. See Figure 9.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-9.png
:scale: 100 %
:alt: VMware ESXi - Disconnect the CD/DVD drive
Figure 9: VMware ESXi - Disconnect the CD/DVD drive
#. Attach the :file:`clear-[version number]-esxi.vmdk` file that was
converted from the pre-configured |CL| VMware image.
#. Click the :guilabel:`Add hard disk` button and select the
:guilabel:`Existing hard drive` option. See Figure 10.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-10.png
:scale: 100 %
:alt: VMware ESXi - Add an existing hard drive
Figure 10: VMware ESXi - Add an existing hard drive
#. Select the converted :file:`clear-[version number]-esxi.vmdk`
file. Do not use the original unconverted
:file:`clear-[version number]-vmware.vmdk` file. See Figure 11.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-11.png
:scale: 100 %
:alt: VMware ESXi - Select the converted `vmdk` file
Figure 11: VMware ESXi - Select the converted
:file:`clear-[version number]-esxi.vmdk` file
#. |CL| needs UEFI support in order to boot. Enable UEFI boot support.
#. Click the :guilabel:`VM Options` button. See Figure 12.
#. Expand the :guilabel:`Boot Options` setting.
#. For the :guilabel:`Firmware` setting, click the drop-down list to
the right of it and select the :guilabel:`EFI` option.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-12.png
:scale: 100 %
:alt: VMware ESXi - Set boot firmware to EFI
Figure 12: VMware ESXi - Set boot firmware to EFI
#. Click the :guilabel:`Save` button.
#. Click the :guilabel:`Next` button.
#. Click the :guilabel:`Finish` button.
Power on the VM and boot |CL|
*****************************
After configuring the settings above, power on the VM.
#. Under the :guilabel:`Navigator` window, select
:guilabel:`Virtual Machines`. See Figure 13.
#. In the right window, select the newly-created VM.
#. Click the :guilabel:`Power on` button.
#. Click on the icon representing the VM to bring it into view and maximize
its window.
.. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-13.png
:scale: 100 %
:alt: VMware ESXi - Navigator > Virtual Machines > Power on VM
Figure 13: VMware ESXi - Navigator > Virtual Machines > Power on VM
Related topics
**************
* :ref:`vmware-esxi-install-cl`
.. _VMware ESXi: https://www.vmware.com/products/esxi-and-esx.html
.. _Using Datastore File Browser in the VMware Host Client: https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.html.hostclient.doc/GUID-7533A767-8396-4844-A3F2-206047D254EA.html
.. _vSphere Management Assistant: https://www.vmware.com/support/developer/vima/
.. _vSphere CLI: https://www.vmware.com/support/developer/vcli/
.. _Cloning and converting virtual machine disks with vmkfstools: https://kb.vmware.com/kb/1028042
.. _Enable the Secure Shell (SSH) in the VMware Host Client: https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.html.hostclient.doc/GUID-B649CB74-832F-467B-B6A4-8BA67AD5C1F0.html
.. _VMware Workstation Player: https://www.vmware.com/products/workstation-player.html
.. _image: https://cdn.download.clearlinux.org/image/