clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-08-26 18:36:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'virtualization' into 'staging'

Browse Source 
Virtualization Documentation

This patch serie is regarding virtualization software where Clear Linux can be run into.

This brach is based on master due to staging is 6 commits behind master.

This series adds 3 new files, virtualbox, vmware-player and vmware-esxi, and as them are from virtualization and there is already a page talking about virtualization a new section was created, where "running in a virtual environment" document was moved to a new section. All references where updated to create this new section.

See merge request !35
This commit is contained in:
Leona
2016-02-19 14:32:59 -08:00
parent ea599e09e3 0fa30a6c7f
commit c629da082f
16 changed files with 339 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/bundles_in_clr.rst
+2 -2
View File
@@ -511,7 +511,7 @@ Current list of bundles available for Clear Linux* OS for Intel® Architecture:
</ul>
<p></p>
<ul>
<li>Includes (openstack-telemetry-controller) bundle.</li>
<li>Includes (openstack-telemetry) bundle.</li>
</ul>
<p></p>
</td><!-- <td align=left><p></p></td> -->
@@ -671,7 +671,7 @@ Current list of bundles available for Clear Linux* OS for Intel® Architecture:
<!-- <td align=left><p></p></td> -->
</tr>
<tr>
<td align="left">openstack-telemetry-controller</td>
<td align="left">openstack-telemetry</td>
<td align="center">WIP</td>
<td align="left">
<p>Provides an OpenStack Telemetry server</p>
source/bundles_overview.rst
+2 -2
View File
@@ -431,7 +431,7 @@ Current list of available bundles:
<li>Includes (openstack-orchestration) bundle.</p>
<li>Includes (openstack-python-clients) bundle.</p>
<li>Includes (openstack-vpnaas) bundle.</p>
<li>Includes (openstack-telemetry-controller) bundle.</p>
<li>Includes (openstack-telemetry) bundle.</p>
</td>
<!-- <td><p></p></td> -->
<!-- <td><p></p></td> -->
@@ -589,7 +589,7 @@ Current list of available bundles:
<!-- <td><p></p></td> -->
</tr>
<tr>
<td class="bundlename"> openstack-telemetry-controller</td>
<td class="bundlename"> openstack-telemetry</td>
<td class="bundlestatus"> WIP</td>
<td class="bundledesc">
<p> Provides an OpenStack Telemetry server</p>
source/gs_creating_bootable_usb.rst
+2 -2
View File
@@ -5,7 +5,7 @@ Creating a bootable USB to install the OS
Here's how to create a USB drive that initiates the process for
:ref:`gs_installing_clr_as_host`. Alternatively, you can test the
OS by :ref:`gs_running_clr_virtual`.
OS by :ref:`vm-kvm`.
What you need
@@ -66,4 +66,4 @@ mounted on ``/sdc``.
:alt: confirmation
Success! Your USB stick is now ready to boot and initiate the process for
:ref:`gs_installing_clr_as_host`.
:ref:`gs_installing_clr_as_host`.
source/gs_getting_started.rst
+3 -2
View File
@@ -6,14 +6,15 @@ Getting started with Clear Linux* OS for Intel® Architecture
**Note:** To improve quality, the Telemetry service is enabled by default. See the `Telemetry feature page <https://clearlinux.org/features/telemetry>`_ for more details. Use the ``telemctl`` command to manage this service.
There are a number of ways to download and run Clear Linux OS for Intel Architecture.
All of the images are in our `image directory <http://download.clearlinux.org/image/>`_.
The most `current <http://download.clearlinux.org/current/>`_ image options can
be found in our image directory. For older ones, see our `releases <https://download.clearlinux.org/releases>`_ page.
KVM Image
=========
Download a recent KVM image along with the UEFI firmware
helper ``OVMF.fd`` and the KVM start helper script ``start_qemu.sh.``
See :ref:`gs_running_clr_virtual` for details.
See :ref:`vm-kvm` for details.
Live Image
==========
source/gs_installing_clr_as_host.rst
+1 -1
View File
@@ -27,5 +27,5 @@ The entire installation should take no more than a few minutes.
For feedback on installation or other topics, please feel free to write in to our
`mailing list <https://lists.clearlinux.org/mailman/listinfo/dev>`_.
Note: You can also try :ref:`gs_running_clr_virtual`.
Note: You can also try :ref:`vm-kvm`.
source/index.rst
+9
View File
@@ -16,6 +16,15 @@ Getting started
index_gs.rst
Running in a virtualized environment
====================================
.. toctree::
:maxdepth: 2
index_vm.rst
Software update
===============
source/index_gs.rst
+1 -2
View File
@@ -8,5 +8,4 @@ Getting started
gs_supported_hardware
gs_creating_bootable_usb
gs_installing_clr_as_host
gs_running_clr_virtual
gs-clear-containers-gettting-started
gs-clear-containers-gettting-started
source/index_vm.rst
+11
View File
@@ -0,0 +1,11 @@
Running in a virtualized environment
####################################
.. toctree::
:maxdepth: 2
vm-kvm
vm-virtualbox
vm-vmware-esxi
vm-vmware-player
source/openstack_bundle_and_service_summary.rst
+1 -1
View File
@@ -31,7 +31,7 @@ services:
replication and scale-out architecture."
"openstack-block-storage/openstack-block-storage-controller", "Cinder", "Provides
persistent block storage to running instances."
"openstack-telemetry-controller", "Ceilometer", "Monitors and meters the
"openstack-telemetry", "Ceilometer", "Monitors and meters the
OpenStack cloud for billing, benchmarking, scalability, and statistical
purposes."
"openstack-orchestration", "Heat", "Orchestrates multiple composite cloud
source/openstack_telemetry.rst
+1 -1
View File
@@ -160,7 +160,7 @@ Install and configure components
#. Install the OpenStack Telemetry Controller bundle::
# swupd bundle-add openstack-telemetry-controller
# swupd bundle-add openstack-telemetry
#. Custom configurations will be located at ``/etc/ceilometer``.
source/swupdate_about_sw_update.rst
+5 -5
View File
@@ -4,8 +4,8 @@ About software update
The traditional way
===================
Traditional Linux-based operating systems are often an amalgation of
several hundred, if not thousands, of open source projects. To make them
Traditional Linux-based operating systems are often a mix of several
hundred, if not thousands, of open source projects. To make them
manageable, most distributions use the concept of "packages" to configure
and compile source code into binaries for installation.
@@ -19,9 +19,9 @@ each package individually or as a set, using tools such as ``yum`` and
The Clear way
=============
Clear Linux OS for Intel® Architecture has a few notable features that
distinguish it from standard OSes: bundles, versioning, updating, and update
speed.
Clear Linux OS for Intel® Architecture does things a little differently.
Following here are a few notable features that distinguish it from
standard OSes: bundles, versioning, updating, and update speed.
Bundles
-------
source/swupdate_how_to_run_the_updater.rst
+2 -2
View File
@@ -1,5 +1,5 @@
How to run the updater
############################################################
######################
This section describes how to manually trigger the software update code in Clear Linux* OS for Intel® Architecture.
@@ -7,7 +7,7 @@ Prerequisites
~~~~~~~~~~~~~
- System is up and running a Clear Linux OS for Intel
Architecture official build 300 or later.
Architecture official build, 300 or later.
- Device is on a well-connected network.
source/gs_running_clr_virtual.rst → source/vm-kvm.rst
+4 -4
View File
@@ -1,7 +1,7 @@
.. _gs_running_clr_virtual:
.. _vm-kvm:
Running in a virtualized environment
####################################
Using KVM
#########
The easiest way to get started running Clear Linux* OS for Intel®
Architecture in a virtualized environment is to download a recent KVM image
@@ -69,4 +69,4 @@ Alternatively, there are a few other ways to approach this.
- And to run it as a background process::
$ ./start_qemu.sh clr_image &
$ ./start_qemu.sh clr_image &
source/vm-virtualbox.rst
+81
View File
@@ -0,0 +1,81 @@
.. _vm-virtualbox:
================
Using VirtualBox
================
This section explains how to run Clear Linux inside
VirtualBox_ environment.
Download VirtualBox
-------------------
Virtualbox is a hypervisor supported by *Oracle**, you can
download it from its official site
https://www.virtualbox.org/wiki/Downloads
and select the operating system you are using,
furthermore you can download its source code. At this point is very
important to download **version 5.0 or grather**, this is in order to
get support for :abbr:`AVX (Advanced Vector Extensions)` feature
that is used in Clear Linux.
Create a virtual machine in VirtualBox
--------------------------------------
1. Download the latest_ Clear linux live version (clear-XXXX-live.img.xz)
from https://download.clearlinux.org/image/.
2. Decompress clear linux image
- On Linux ::
$ xz -d clear-XXXX-live.img.xz
- On Windows
You can use 7zip_.
3. To convert Clear Linux raw image to :abbr:`VDI (VirtualBox Disk Image)`
format, you can use one of the following commands::
$ VBoxManage convertfromraw clear-XXXX-live.img clear-XXXX-live.vdi --format VDI
or::
$ vbox-img convert --srcfilename clear-XXXX-live.img --dstfilename clear-XXXX-live.vdi --srcformat raw --dstformat vdi
Note: Be sure you have Virtual box directory in your PATH (i.e.: on Windows
:file:`C:\\Program Files\\Oracle\\VirtualBox`)
4. Create virtual machine using the VirtualBox assistant:
* Type: **Linux**
* Version: **Linux 2.6 / 3.x / 4.x (64-bit)**
* Attach the virtual disk created in the step number 3 as virtual hard disk file
5. Once it is created, go to settings to enable **EFI support**
* System -> Enable EFI (special OSes only)
Run your new VM
---------------
Clear Linux comes with VirtualBox kernel modules in a bundle. You can install
these modules using
.. code:: bash
# swupd bundle-add virtualbox-guest
In order to use the VirtualBox additions it's necessary to load vboxsf module
.. code:: bash
# modprobe vboxsf
.. _VirtualBox: https://www.virtualbox.org/
.. _latest: https://download.clearlinux.org/latest
.. _7zip: http://www.7-zip.org/
source/vm-vmware-esxi.rst
+88
View File
@@ -0,0 +1,88 @@
.. _vm-vmware-esxi:
Using VMware* ESXi guest
========================
This documentation explains how to use Clear Linux as ESXi Guest.
This docuemnt is based on VMware vSphere 6.
****************
Run Clear Linux*
****************
1. In order to boot Clear Linux* download the latest_ live disk image from
https://download.clearlinux.org/image/
2. Create and configure a virtual machine with the following configuration:
- Guest Operating system: **Linux, Distribution Other 3.x Linux (64-bits)**
- **UEFI support**: Clear Linux uses as default bootloader systemd-boot a
UEFI boot manager for EFI images
.. tip::
In VMware vShere GUI go to the configuration settings of the
virtual machine->General Tab-> And select **EFI boot firmware**
- **IDE disk**: Convert to vmdk and attach the Clear Linux image downloaded
above. To convert Clear Linux image to VMWare* disk (vmdk) you can use
qemu-img command::
$qemu-img convert -f raw -O vmdk -p clear-vmware.img clear-vmware.vmdk
3. Start the Clear Linux* virtual machine
*********************************
Using optimized kernel for VMware
*********************************
Clear Linux provides a bundle called *kernel-vmware* that contains a specialized
kernel that uses an specific configuration for *VMware hypervisor* such as:
- **vmw_balloon**: Use a technique for memory reclamation that works a "balloon".
The guest can be inflated to reclaim physical memory. The balloon can also be
deflated to allow the guest free memory pages
- **vmw_pvscsi**: A driver that allows to use a paravirtualized SCSI provided by
VMware* hypervisors
- **vmxnet3**: Allows to use VMware virtual ethernet NIC
- **vmwgfx**: Allows to use DRM driver for the VMware virtual hardware
In order to use this features install the kernel-vmware bundle in you Clear
Linux using a virtual machine configured in the previos version::
# swupd bundle-add kernel-vmware
Turn off virtual machine and change the virtual machine configuration as follow:
- Guest Operating system: Linux, Distribution Other 3.x Linux (64-bits)
- UEFI support: Clear Linux use as default bootloader systemd-boot a UEFI boot
manager for EFI images. To add UEFI support go to:
.. tip::
Go to "Configuration settings of the virtual machine" -> "General Tab" ->
"And select EFI boot firmware"
- SCSI Paravirtualized disk: Convert the Clear Linux image to a SCSI VMWare*
disk imagek and attach it again
To do this you can follow this steps:
1. Extract the image from the EXSi server to one Linux machine and use
qemu-img command::
$ qemu-img convert -f raw -O vmdk -o adapter_type=lsilogic -o compat6 -p
clear-vmware.img clear-vmware.vmdk
2. Transfer the Clear Linux* image to the VMware* ESXi server and use
:command:`vmkfstools` command (you need to access to ESXi command line )::
$ vmkfstools -i clear-vmware.vmdk -d zeroedthick clear-vmware-fix.vmdk
3. Add the converted image to the guest by using VMware* vSphere virtual
machine settings
- Start the modificated virtual machine
.. _latest: https://download.clearlinux.org/latest
source/vm-vmware-player.rst
+126
View File
@@ -0,0 +1,126 @@
.. _vm-vmware-player:
====================
Using VMware* Player
====================
This section explains how to run Clear Linux inside
`VMWare Player`_ environment.
Install VMware player
---------------------
*VMware Workstation Player*, formerly VMware Player, is a virtualization
software package for x64 computers running Microsoft Windows or Linux. To
download VMware player, you can click on the following link:
https://www.vmware.com/products/player/playerpro-evaluation.html
Player on Linux
^^^^^^^^^^^^^^^
If you have chosen Linux option, you got a :file:`VMWARE_FILE.bundle` file. To
install VMWare Player, run:
::
$ sudo bash ./VMware-Player-12.0.0-2985596.x86_64.bundle
Player on windows
^^^^^^^^^^^^^^^^^
Please follow the instructions from the Setup Assistant
Prepare Clear Linux Image
-------------------------
Download the latest_ Clear Linux live disk image from
https://download.clearlinux.org/image/. In Clear Linux website you can find
different image flavors (kvm, clear-containers, cloud and live), please
download the live image (clear-XXXX-live.img.xz).
1. Decompress the image:
- On Linux ::
$ unxz clear-VERSION-live.img.xz
- On Windows
You can use 7zip_.
2. Convert installer to :abbr:`VMDK (Virtual Machine Disk)` format.
- On linux
Convert Clear Linux raw installer image in vmdk virtual disk, for doing
this there are a lot of tools, this is an option:
::
$ qemu-img convert -O vmdk clear-VERSION-live.img clear.vmdk
- On Windows
To convert live image to vmdk format ( from raw format to vmdk) you can
use different tools for this purpose (e.g., VBoxManage from VirtualBox_).
Run Clear Linux* using VMware* Player
-------------------------------------
Create a new Virtual Machine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Click on “Create a new Virtual Machine”
1. Select “**I will install the operating system later**”, and click on “Next”.
2. Select “**Linux**” as “Guest operating system” and version “**Other Linux 3.x
kernel 64-bit**”.
3. Type a name for the new virtual machine.
4. Perform the *remaining steps* using the default options.
Change boot type to EFI
^^^^^^^^^^^^^^^^^^^^^^^
You must change VMware virtual machine *configuration* to
**support efi firmware**, by editing a configuration .vmx file,
that is located in the virtual machine folder, and add the next line:
::
firmware = "efi"
Attach Clear Linux image as SATA disk
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When you have created a new virtual machine, you can edit its configuration:
1. Click on “Edit virtual machine settings”
2. Remove any default attached hard disk
3. Click on “Add” option below devices list tab and choose Hard disk.
i. Choose “SATA” as virtual disk type.
- Use the existing Clear Linux* virtual disk
The Clear Linux live disk must set as “SATA 0:1 Hard Disk (SATA)” you can
verify it in “Advanced button” in the disk settings
Start the virtual machine
-------------------------
After the above configuration start the virtual machine.
.. _VMWare Player: http://www.vmware.com/products/player/
.. _latest: https://download.clearlinux.org/latest
.. _7zip: http://www.7-zip.org/
.. _VirtualBox: https://www.virtualbox.org/