diff --git a/source/ac-dpdk.rst b/source/ac-dpdk.rst index 72740a30..9554dddb 100644 --- a/source/ac-dpdk.rst +++ b/source/ac-dpdk.rst @@ -168,7 +168,8 @@ DPDK modules to run DPDK applications. Setting hugepages (platforms A and B) ===================================== -Clear Linux OS for Intel Architecture supports ``hugepages`` for the large memory pool allocation used for packet buffers. +Clear Linux OS for Intel Architecture supports ``hugepages`` for the large memory pool +allocation used for packet buffers. #. Set number of hugepages. diff --git a/source/ac-ovs-dpdk.rst b/source/ac-ovs-dpdk.rst index 824c6f32..af5409cd 100644 --- a/source/ac-ovs-dpdk.rst +++ b/source/ac-ovs-dpdk.rst @@ -24,8 +24,8 @@ cover a simple use case with :ref:`f1ovs`, where one virtual machine sends To follow along with this example, you will need: -* At least one platform using Clear Linux (recommended release >= ``7160``) - as Host, +* At least one platform using Clear Linux* OS for Intel® Architecture + (recommended release >= ``7160``) as Host, * The ``kernel-native`` bundle enabled on that particular Host, * And the ``network-advanced``, and ``os-clr-on-clr`` bundles installed. @@ -33,7 +33,7 @@ To follow along with this example, you will need: # swupd bundle-add network-advanced os-clr-on-clr -You'll also need two `Clear Linux kvm`_ images (recommended release >= ``7160``). +You'll also need two `kvm`_ images (recommended release >= ``7160``). These images will create the guest virtual machines A and B. These virtual machines must also have ``network-basic`` and ``lamp-basic`` bundles installed. @@ -169,7 +169,8 @@ Using OpenvSwitch # chmod a+x ovs-ifup #. Run guest virtual machine A using the next configuration as reference, where - **$IMAGE** var is the Clear Linux image name. Notice the network configuration uses the up-down scripts. + **$IMAGE** var is the name of the Clear Linux* OS for Intel Architecture image. + Notice the network configuration uses the up-down scripts. .. code-block:: bash @@ -263,7 +264,7 @@ Using Linux OpenvSwitch-DPDK # ovs-vsctl add-port br0 vhost-user2 -- set Interface vhost-user2 type=dpdkvhostuser #. Run guest virtual machine A using the next configuration as reference, where - **$IMAGE** var is the Clear Linux image name. + **$IMAGE** var is the name of the Clear Linux* OS for Intel Architecture image. .. code-block:: bash @@ -281,7 +282,8 @@ Using Linux OpenvSwitch-DPDK -debugcon file:debug.log -global isa-debugcon.iobase=0x402 #. Run guest virtual machine B, use the configuration from the previous step; - simply change the MAC address and the port socket. You can use 00:00:00:00:00:02 as a MAC address and vhost-user2 as a socket. + simply change the MAC address and the port socket. You can use 00:00:00:00:00:02 as a + MAC address and vhost-user2 as a socket. #. Follow the instructions from the `Setting IP address`_ section. @@ -322,4 +324,4 @@ Setting IP address .. _DPDK: http://dpdk.org/ -.. _Clear Linux kvm: https://download.clearlinux.org/releases/ +.. _kvm: https://download.clearlinux.org/releases/ diff --git a/source/gs_getting_started.rst b/source/gs_getting_started.rst index fb31254a..c8c12e2d 100644 --- a/source/gs_getting_started.rst +++ b/source/gs_getting_started.rst @@ -23,9 +23,9 @@ a container, download the `clear-linux-check-config`_ script and run:: ``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 +* **Container Evaluation** -- Intel® Clear Containers for Docker* Engine is available for + numerous operating systems. This allows you to execute existing Docker applications in + the secure and fast Intel 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. @@ -47,7 +47,7 @@ download the `clear-linux-check-config`_ script and run:: * **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 + *Warning*: This installer re-partitions ``/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``. diff --git a/source/gs_installing_clr_as_host.rst b/source/gs_installing_clr_as_host.rst index 9cf6a720..ffbb1506 100644 --- a/source/gs_installing_clr_as_host.rst +++ b/source/gs_installing_clr_as_host.rst @@ -6,26 +6,27 @@ Installing the OS as host Running Clear Linux* OS for Intel® Architecture natively on a system is easy using the installer image. To get started you'll need the following: -* A USB stick flashed with the `installer image `_. - For instructions on how to do this, see :ref:`gs_creating_bootable_usb`. +* A USB stick flashed with the `installer image`_. For instructions on how to + do this, see :ref:`gs_creating_bootable_usb`. * Host machine running :ref:`gs_supported_hardware`. * Network access via DHCP. Installing Clear Linux OS for Intel Architecture to a target system =================================================================== -1. Configure the BIOS; this may involve changing the boot device order +#. Configure the BIOS; this may involve changing the boot device order to boot first from the USB device. -2. Insert the USB device that is flashed with the - `installer image `_ into the - target system, then reboot. -3. The Installer user interface will appear. Once all appropriate configuration - options have been chosen the installer will install the OS. +#. Insert the USB device that is flashed with the + `installer image`_ into the target system, then reboot. +#. The Installer user interface will appear. Once all appropriate configuration + options have been chosen, the installer will install the OS. 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 `_. +`mailing list_. Note: You can also try :ref:`vm-kvm`. +.. _installer image: http://download.clearlinux.org/image +.. _mailing list: https://lists.clearlinux.org/mailman/listinfo/dev diff --git a/source/gs_supported_hardware.rst b/source/gs_supported_hardware.rst index e167c8ad..3be84838 100644 --- a/source/gs_supported_hardware.rst +++ b/source/gs_supported_hardware.rst @@ -8,7 +8,7 @@ capable of running the Clear Linux* OS for Intel® Architecture by downloading and running the simple `clear-linux-check-config.sh`_ script locally. This script is available in the `current`_ download directory; it checks the hardware capabilities of your system to determine whether it will work with the -latest current release of Clear Linux. +latest current release. For developers who are already familiar with the hardware capabilities of their system(s), the following processors have been tested to be successful