clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-08-23 16:05:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

restructure gs_getting_started to minimize vm vs bare metal install confusion reported on mailing list

Browse Source 
Signed-off-by: Leona <leonax.cook@intel.com>
This commit is contained in:
Leona
2016-05-02 07:08:23 -07:00
parent ab25d7c5ef
commit 0b375c2471
1 changed files with 52 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/gs_getting_started.rst
+52 -42
View File
@@ -4,63 +4,73 @@ Getting started
###############
There are a number of options available for downloading and running Clear Linux*
OS for Intel® Architecture. Be sure to check your system hardware capabilities
against our list of `supported processors`_; alternatively, you can download and
run the `clear-linux-check-config`_ script to check the hardware compatibility of
your system from the command line.
Once you're ready to download an image, you can choose from these options:
OS for Intel® Architecture. You can check your system hardware capabilities against
the list of `supported processors`_; alternatively, download and run the
`clear-linux-check-config`_ script to check the hardware compatibility of your
system from the command line.
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:`vm-kvm` for details. Find
the ``clear-[version_number]-kvm.img.xz`` image in our `current`_ directory.
Virtual machine installer images
================================
To test whether your host contains the necessary components to run the OS in
a container, download the `clear-linux-check-config`_ script and run::
$ ./clear-linux-check-config.sh container
* **KVM Image** -- Download a recent KVM image, along with the UEFI firmware helper,
``OVMF.fd`` and the KVM start helper script ``start_qemu.sh.`` Find the
``clear-[version_number]-kvm.img.xz`` image in the `current`_ directory and see
:ref:`vm-kvm` for further detail.
* **Container Evaluation** -- Clear Containers for Docker* Engine is available for
numerous operating systems. It enables executing existing Docker applications in
the secure and fast Clear Containers environment. Find the
``clear-[version_number]-containers.img.xz`` in the `current`_ directory and see
:ref:`gs-clear-containers-gettting-started` for more information.
Installer Image
===============
The installer image allows you to manipulate and target partitions, and to set other
OS configuration features (hostname, administrative user) commonly found in Linux
installers. Find the ``clear-[version_number]-installer.img.xz`` in our `current`_
directory and see :ref:`gs_installing_clr_as_host` for more information.
Bare metal installer images
===========================
To test whether your system contains the necessary components to run the OS natively,
download the `clear-linux-check-config`_ script and run::
$ ./clear-linux-check-config.sh host
Live Image
==========
With the live image you can boot right into Clear in a VM, or you can lay the image
down on a USB drive with a tool like ``dd`` and boot from USB. This is a great way
to kick the tires with a minimal amount of effort. Find the ``clear-[version_number]
-live.img.xz`` image in our `current`_ directory. **Warning** -- if you do not manually
configure the install and instead use the auto-install, it will repartition ``/dev/sda``.
* **Installer Image** -- The installer image allows you to manipulate and target
partitions, and to set other OS configuration features (hostname, administrative user)
commonly found in Linux installers. Find the ``clear-[version_number]-installer.img.xz``
in our `current`_ directory and see :ref:`gs_installing_clr_as_host`. This `blog post`_
contains more detail about the evolution of our installer.
.. tip::
To improve quality, the telemetry service is enabled by default. See the `Telemetry`
feature page for more details. Use the ``telemctl`` command to manage this service.
* **Provisioning Image** -- This image is intended to be used in a provioning environment.
Find the ``clear-[version_number]-provision.img.xz`` image in our `current`_ directory.
*Warning*: This installer repartitions ``/dev/sda`` and installs the OS to the new
partition. Don't use this image on a system where you care about existing data on
``/dev/sda``.
Provisioning Image
==================
This image is intended to be used in a provioning environment. Find the
``clear-[version_number]-provision.img.xz`` image in our `current`_ directory.
Other installation options
==========================
.. warning::
This installer repartitions ``/dev/sda`` and installs Clear Linux OS for Intel
Architecture into the new partition. Don't use this image on a system where you
care about existing data on ``/dev/sda``.
* **Live Image** -- The live image can be used to boot the OS in a VM, or you can lay
the image down on a USB drive with a tool like ``dd`` and boot from USB.
This option is a great way to kick the tires with a minimal amount of effort. Be
aware, however, that if you do **not** manually configure the install and instead use
the auto-install, it will repartition ``/dev/sda``. This image also enables telemetry
by default; see the `telemetry`_ feature page for more details.
Container Evaluation
====================
Clear Containers for Docker* Engine is now available on multiple operating
systems. This enables executing existing Docker applications in the secure and
fast Clear Containers environment. Find the ``clear-[version_number]-containers.img.xz``
and see :ref:`gs-clear-containers-gettting-started` for further detail.
To select this option, download the ``clear-[version_number]-live.img.xz`` image in
the `current`_ version's download directory.
For older versions, see our `releases <https://download.clearlinux.org/releases>`_ page.
For older versions, see our `releases`_ page.
.. _clear-linux-check-config: http://download.clearlinux.org/current/clear-linux-check-config.sh
.. _current: http://download.clearlinux.org/current
.. _blog post: https://clearlinux.org/blogs/clear-linux-installer-v20
.. _telemetry: https://clearlinux.org/features/telemetry
.. _supported processors: http://clearlinux.org/documentation/gs_supported_hardware.html
.. _releases: https://download.clearlinux.org/releases