mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-08-29 06:15:50 +00:00
puneetse
241 lines
7.2 KiB
ReStructuredText
241 lines
7.2 KiB
ReStructuredText
.. _docker:
|
|
|
|
Docker* on |CL|
|
|
######################################################
|
|
|
|
|CLOSIA| supports multiple containerization platforms, including Docker*.
|
|
|CL| has many `unique features`_ including a minimal default installation
|
|
which makes it compelling to use as a host for container workloads, management, and orchestration.
|
|
|
|
|
|
This tutorial will go over:
|
|
|
|
#. Installing the required bundle for Docker
|
|
#. Integration with Kata Containers (optional)
|
|
#. Additional Docker* configuration on |CL|
|
|
#. Pulling and Running an image from Docker* Hub
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
This tutorial focuses on the installaton of the Docker* ecosystem.
|
|
If you want to use |CL| as a Docker* container image,
|
|
refer to the official `|CL| image on Docker* Hub`_ and `building a custom Clear Linux docker image`_ .
|
|
|
|
|
|
Prerequisites
|
|
=============
|
|
|
|
* You have a basic understanding of Linux and Docker.
|
|
|
|
* You have successfully installed
|
|
:ref:`Clear Linux on bare metal<bare-metal-install>`
|
|
|
|
* Your |CL| installation has transparent network access to the Internet.
|
|
If you are behind a HTTP proxy server, in a corporate setting for example,
|
|
please refer to the `Docker* proxy instructions`_ .
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Installing the required bundle
|
|
===============================
|
|
|
|
Software in Clear Linux is offered in the form
|
|
of `bundles`_ to provide a complete function.
|
|
The *containers-basic* provides all the required software packages to run Docker images as containers.
|
|
|
|
#. First, install the *containers-basic* bundle by running this :command:`swupd` command:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo swupd bundle-add containers-basic
|
|
|
|
|
|
#. Start the Docker* daemon through systemd manager by running this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo systemctl start docker
|
|
|
|
|
|
If you want Docker* to start automatically on boot, also enable the systemd service by running this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo systemctl enable docker
|
|
|
|
|
|
#. Finally, verify :command:`docker` has been installed by running this
|
|
command and checking the version output for both *client* and *server*:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo docker version
|
|
|
|
|
|
Congratulations! At this point, you have a working installation of Docker* on |CL| and are ready to start using container images on your system.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Integration with Kata Containers (optional)
|
|
===========================================
|
|
|
|
`Kata Containers`_,
|
|
formerly known as Intel Clear Containers, is an open source
|
|
project aiming to increase security of containers by using lightweight virtual machine technology.
|
|
|
|
The Docker* package from |CL| will automatically use the runtime required for Kata Containers if it is available on your Clear Linux system.
|
|
|
|
#. You can take advantage of Kata Containers in |CL| by simply installing the *containers-virt* bundle by running the command below:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo swupd bundle-add containers-virt
|
|
|
|
#. Restart the Docker* daemon through systemd manager by running this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo systemctl restart docker
|
|
|
|
#. After restarting, the Docker* daemon
|
|
will seamlessly use katacontainers to launch containers.
|
|
The default runtime for Docker containers is *runc*.
|
|
You can see the runtime has changed to :command:`cc-runtime`
|
|
by running this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo docker info | grep Runtime
|
|
|
|
#. You should see the following output
|
|
indicating the *cc-runtime* is the Default Runtime:
|
|
|
|
.. code-block:: bash
|
|
|
|
Runtimes: cc-runtime runc
|
|
Default Runtime: cc-runtime
|
|
|
|
Congratulations! At this point, you have successfully replaced the default container runtime with Kata.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
The proceeding sections of this tutorial are standard to Docker* setup and configuration.
|
|
If you are familiar with Docker basics, you do not need to continue reading. The following sections are provided here for sake of completeness.
|
|
|
|
|
|
|
|
Additional Docker configuration
|
|
===============================
|
|
|
|
Additional Docker* daemon configuration done can be via a
|
|
configuration file typically located at :file:`/etc/docker/daemon.json` .
|
|
|CL| features a `stateless system`_ so the configuration file :file:`daemon.json` will *NOT* exist by default.
|
|
|
|
|
|
#. Create the :file:`daemon.json` by running this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
touch /etc/docker/daemon.json
|
|
|
|
Refer to the `Docker* documentation on daemon configuration `_ for the
|
|
full list of available configuration options and examples.
|
|
|
|
#. Once you've made any required changes, be sure to restart the
|
|
Docker* daemon through systemd manager by running this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo systemctl restart docker
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Pulling and Running an image from Docker* Hub
|
|
=============================================
|
|
|
|
#. First, Pull a container image from Docker* Hub using the :command:`docker pull` command. Download the latest nginx Docker container image by running this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo docker pull nginx
|
|
|
|
|
|
#. Create and launch a new container using the :command:`docker run` command.
|
|
Launch a nginx container by running this command:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo docker run --name test-nginx -d -p 8080:80 nginx
|
|
|
|
.. note::
|
|
|
|
Below is an explaination of switches used in the command above. For detailed :command:`docker run` switches and syntax, refer to the `Docker* Documentation`_ .
|
|
|
|
* The :option:`--name` switch lets you provide a friendly name to target the container for future operations
|
|
|
|
* The :option:`-d` switch launches the container in the background
|
|
|
|
* The :option:`-p` switch allows the container's HTTP port (80) to be accessible from the Clear Linux host on port 8080
|
|
|
|
|
|
#. You can access the Welcome to Nginx! splash page running in the container by browsing to http://127.0.0.1:8080 or by running this :command:`curl` command from your Clear Linux machine:
|
|
|
|
.. code-block:: bash
|
|
|
|
curl 127.0.0.1:8080
|
|
|
|
|
|
#. Finally, stop and delete the nginx container by running the
|
|
:command:`docker stop` and :command:`docker rm` commands.
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo docker stop test-nginx
|
|
sudo docker rm test-nginx
|
|
|
|
|
|
Congratulations! At this point, you have successfully pulled a nginx container image from `Docker* Hub`_ and ran an example container.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Also see:
|
|
=========
|
|
* `Docker* Home`_
|
|
* `Docker* Documentation`_
|
|
* `Docker* Hub`_
|
|
* `Kata Containers`_
|
|
|
|
|
|
|
|
|
|
.. _`unique features`: https://clearlinux.org/features
|
|
.. _`|CL| image on Docker* Hub`: https://hub.docker.com/_/clearlinux/
|
|
.. _`building a custom Clear Linux docker image`: https://clearlinux.org/documentation/clear-linux/guides/network/custom-clear-container
|
|
.. _`Docker* proxy instructions`: https://docs.docker.com/config/daemon/systemd/#httphttps-proxy
|
|
.. _`bundles`: https://clearlinux.org/documentation/clear-linux/concepts/bundles-about#related-concepts
|
|
.. _`stateless system`: https://clearlinux.org/features/stateless
|
|
.. _`Docker* documentation on daemon configuration`: https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file
|
|
.. _`Kata Containers`: https://katacontainers.io/
|
|
.. _`Docker* Home`: https://www.docker.com/
|
|
.. _`Docker* Documentation`: https://docs.docker.com/
|
|
.. _`Docker* Hub`: https://hub.docker.com/ |