diff --git a/source/gs-clear-containers-getting-started.rst b/source/gs-clear-containers-getting-started.rst index 071d7873..cf1cb515 100644 --- a/source/gs-clear-containers-getting-started.rst +++ b/source/gs-clear-containers-getting-started.rst @@ -3,87 +3,46 @@ Clear Containers getting started guide ###################################### -Intel® Clear Containers for Docker* Engine is now available -for multiple operating systems. This enables executing existing -Docker applications in the secure and fast Intel Clear Containers -environment. See also the `Architecture Overview`_. +Introduction +============ -Binary packages -=============== - -The primary host platform is Clear Linux* Project for Intel® -Architecture, version 4000 or better. However, binaries for a -range of operating systems are available from: - -- https://software.opensuse.org/package/clear-containers-docker - -Currently experimental builds are available for: - -- CentOS*, Scientific Linux* 7 -- Fedora* 21, 22, 23 -- openSUSE* 13.1, 13.2, Tumbleweed -- SUSE* Linux Enterprise 12 -- Debian* 8.0 -- Ubuntu* 15.04 - -If you have any feedback, please mail it to the -dev@lists.clearlinux.org mailing list. Subscription to this -list is available at: https://lists.clearlinux.org/mailman/listinfo/dev. +Intel® Clear Containers v2.0 beta release is now available for evaluation. +This enables executing existing Docker applications in the secure +and fast Intel Clear Containers environment under Docker* 1.12 and beyond +via an :abbr:`Open Container Initiative (OCI)` compatible `runtime`. Installation instructions ========================= -Using hosts other than Clear Linux OS for Intel Architecture ------------------------------------------------------------- +The primary host platform is Clear Linux* Project for Intel® +Architecture. For instructions on installing Docker and Clear Containers under +Clear Linux please refer to the below instructions from the runtime source tree: -If you are *not* using Clear Linux OS for Intel Architecture, follow the instructions below: +- https://github.com/01org/cc-oci-runtime/blob/master/INSTALL_DOCKER.rst -#. Visit the link below and select your operating system by clicking the appropriate icon: - https://software.opensuse.org/download.html?project=home%3Aclearlinux%3Apreview&package=clear-containers-docker +Packages and instructions for other Linux* distributions will be released +and updated on that site as they become available. -#. Follow the brief instructions shown. +If you have any feedback, questions, or would like to participate and +contribute, then please consult the contact details (mailing list, IRC etc.) +in the document at: -#. If your host is behind a proxy, you will need to add the proxies to the docker service. Create ``/etc/systemd/system/docker.service.d/proxy.conf`` and add the next lines to the file:: - - [Service] - Environment=HTTP_PROXY=http://proxy.example.com:80/ - Environment=NO_PROXY=localhost,127.0.0.1 - -#. Reload your systemd configuration:: - - $ sudo systemctl daemon-reload - -#. Start the Docker service:: - - $ systemctl restart docker - -Using Clear Linux OS for Intel Architecture as Host ---------------------------------------------------- - -If you are running Clear Linux OS for Intel Architecture on your -host system, follow the instructions below: - -#. Enable the repository by running the following as the ``root`` user:: - - # swupd bundle-add containers-basic - -#. Reload your systemd configuration:: - - $ sudo systemctl daemon-reload - -#. Start the Docker service:: - - $ systemctl restart docker +- https://github.com/01org/cc-oci-runtime/blob/master/CONTRIBUTING.md Source Code =========== -The experimental source code is based on the Docker version 1.9.0 -upstream release and is available at: +The source code for the Clear Containers 2.0 runtime and corresponding +qemu-lite are publicly hosted on github: -- https://github.com/clearlinux/docker +- https://github.com/01org/cc-oci-runtime +- https://github.com/01org/qemu-lite +Architecture Overview +===================== +For an overview of the Clear Containers architecture please see: + +- https://clearlinux.org/documentation/clear_containers.html -.. _Architecture Overview: https://clearlinux.org/documentation/clear-containers.html#architecture-overview \ No newline at end of file diff --git a/source/gs_getting_started.rst b/source/gs_getting_started.rst index c8c12e2d..d600a646 100644 --- a/source/gs_getting_started.rst +++ b/source/gs_getting_started.rst @@ -3,15 +3,17 @@ Getting started ############### -There are a number of options available for downloading and running Clear Linux* -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. +There are a number of options available for downloading and running Clear +Linux* 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. -Virtual machine installer images -================================ +Virtualized images +================== + +Images are also available to run under Virtual Machines or containers. 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:: @@ -23,11 +25,15 @@ 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** -- 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. +* **Docker Image** -- A Clear Linux* Docker* image can be downloaded + directly from the Docker hub and executed within the Docker environment. + Details were posted in the blog post `Clear Linux Highlights 3`_, and + on a Docker* enabled system you can execute:: + + docker pull clearlinux + docker run -it clearlinux + + and then follow the normal Clear Linux* instuctions to add bundles etc. Bare metal installer images @@ -47,7 +53,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 re-partitions ``/dev/sda`` and installs the OS to the new + *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``. @@ -71,6 +77,7 @@ 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 +.. _Clear Linux Highlights 3: https://clearlinux.org/blogs/clear-linux-highlights-3 .. _telemetry: https://clearlinux.org/features/telemetry .. _supported processors: http://clearlinux.org/documentation/gs_supported_hardware.html -.. _releases: https://download.clearlinux.org/releases \ No newline at end of file +.. _releases: https://download.clearlinux.org/releases