clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-07-11 15:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #47 from 01org/custom-container-image

Browse Source 
Adds a new network guide to create a custom container image.
This commit is contained in:
Rodrigo Caballero
2017-10-02 16:52:31 -05:00
committed by GitHub
parent aee95cd862 f59a698781
commit 230d4d187a
2 changed files with 382 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/clear-linux/guides/network/custom-clear-container.rst
+381
View File
@@ -0,0 +1,381 @@
.. _custom-clear-container:
Build a custom Clear Linux based Docker container image
#######################################################
The official base |CLOSIA| container image is published on Docker\* Hub and
is updated on a regular basis. This section contains the steps to build a
custom image.
Prerequisites
*************
* These steps must be performed on a |CL| system because the `swupd` command
is needed to manage bundles in the container.
* The `containers-basic` bundle must be installed on the |CL| system for
Docker to work.
* Basic knowledge of Docker is required.
Build the base Clear Linux container image
******************************************
#. Log in and get root privileges.
.. code-block:: console
$ sudo -s
#. Verify Docker is installed and running.
.. code-block:: console
# docker info
If Docker is installed and running, the expected output will be similar to
this:
.. code-block:: console
# docker info
Containers: 0
Running: 0
Paused: 0
Stopped: 0
Images: 4
Server Version: 17.05.0-ce
Storage Driver: overlay
Backing Filesystem: extfs
Supports d_type: true
Logging Driver: json-file
Cgroup Driver: cgroupfs
Plugins:
Volume: local
Network: bridge host macvlan null overlay
Swarm: inactive
Runtimes: runc
Default Runtime: runc
Init Binary: docker-init
containerd version: (expected: 9048e5e50717ea4497b757314bad98ea3763c145)
runc version: N/A (expected: 9c2d8d184e5da67c95d601382adf14862e4f2228)
init version: N/A (expected: )
Kernel Version: 4.12.7-377.native
Operating System: Clear Linux OS for Intel Architecture
OSType: linux
Architecture: x86_64
CPUs: 4
Total Memory: 15.62GiB
Name: clr-os
ID: XQHJ:DYEM:3Q4D:DKLM:JOA4:RUSF:GAFR:DLPA:HOJP:W5FF:ULEE:7HZ3
Docker Root Dir: /var/lib/docker
Debug Mode (client): false
Debug Mode (server): false
Registry: https://index.docker.io/v1/
Experimental: false
Insecure Registries:
127.0.0.0/8
Live Restore Enabled: false
If Docker is not installed, perform these steps:
.. code-block:: console
# swupd bundle-add containers-basic
# systemctl start docker
#. Create the directory structure needed for building the |CL| container.
.. code-block:: console
# mkdir -p ./custom-clear-linux-container/base/usr/share/clear/bundles
# cd custom-clear-linux-container
.. note::
* The directories `customer-clear-linux-container` and `base` are for
the purpose of staging and can be named something else, if preferred.
* The remaining directories (`/usr/share/clear/bundles`) are mandatory.
#. Create the reference files of the minimum required |CL| bundles (`os-core` and
`os-core-update`). `swupd` determines which bundles to download and install
by using the reference filenames.
.. code-block:: console
# touch ./base/usr/share/clear/bundles/os-core
# touch ./base/usr/share/clear/bundles/os-core-update
.. note::
* `os-core` provides the minimal Linux namespace.
* `os-core-update` provides basic suite for running the |CL|
for iA Updater
#. Optionally, additional bundles can be included with the base image.
#. Identify the desired bundles by going to the |CL| website's
:ref:`available-bundles` page or by executing the
`swupd bundle-list -a` command
#. Create the reference files for the identified bundles. For example,
to include the `editors` and `network-basic` bundles:
.. code-block:: console
# touch ./base/usr/share/clear/bundles/editors
# touch ./base/usr/share/clear/bundles/network-basic
#. Use `swupd` to download and install the bundles into the directory
structure created.
.. code-block:: console
# swupd verify --install --path="base" --manifest 17870 \
--url https://cdn.download.clearlinux.org/update \
--statedir "$PWD/swupd-state" --no-boot-update
.. note::
* `verify –-install` tells `swupd` to download and install
* `–-path` specifies the root path of where the bundles are to be
installed
* `--manifest` specifies the version of the |CL| bundles to use
* `--url` specifies the URL of the bundles repository
* `--statedir` specifies the state directory where downloaded bundles
and any
state information are stored
* `--no-boot-update` tells `swupd` to skip updating boot files since
it's not needed for a container
For more information on the `swupd` flags, enter the `swupd verify -h`
command.
Example output:
.. code-block:: console
# swupd verify --install --path="base" --manifest 17870 \
--url https://cdn.download.clearlinux.org/update \
--statedir "$PWD/swupd-state" --no-boot-update
swupd-client software verify 3.12.2
Copyright (C) 2012-2017 Intel Corporation
Verifying version 17870
Attempting to download version string to memory
Downloading packs...
Extracting python-basic pack for version 17820
...14%
Extracting perl-basic pack for version 17790
...28%
Extracting openssh-server pack for version 17660
...42%
Extracting editors pack for version 17850
...57%
Extracting network-basic pack for version 17650
...71%
Extracting os-core pack for version 17870
...85%
Extracting os-core-update pack for version 17870
...100%
Adding any missing files
...88%
Inspected 33982 files
33974 files were missing
33974 of 33974 missing files were replaced
0 of 33974 missing files were not replaced
Calling post-update helper scripts.
WARNING: boot files update skipped due to --no-boot-update argument
Fix successful
.. note::
The `WARNING` message is expected and can be ignored.
#. Tar up the files and compress it.
.. code-block:: console
# tar -C base -cf base.tar .
# xz -v -T0 base.tar
#. Create the Dockerfile to build the image.
.. code-block:: console
# cat > Dockerfile << EOF
FROM scratch
MAINTAINER First Last <first.last@example.com>
ADD base.tar.xz /
CMD ["/bin/bash"]
EOF
#. Build the |CL| container image.
.. code-block:: console
# docker build -t my-custom-clear-linux-container .
Example output:
.. code-block:: console
# docker build -t my-custom-clear-linux-container .
Sending build context to Docker daemon 806.5MB
Step 1/4 : FROM scratch
--->
Step 2/4 : MAINTAINER First Last <first.last@example.com>
---> Running in 7238f35abcd0
---> ec5064287c60
Removing intermediate container 7238f35abcd0
Step 3/4 : ADD base.tar.xz /
---> 2723b7d20716
Removing intermediate container 16e3ed0df8da
Step 4/4 : CMD /bin/bash
---> Running in efa893350647
---> 5414c3a12993
Removing intermediate container efa893350647
Successfully built 5414c3a12993
Successfully tagged my-custom-clear-linux-container:latest
#. List the newly created |CL| container image.
.. code-block:: console
# docker images
Example output:
.. code-block:: console
# docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
my-custom-clear-linux-container latest 5414c3a12993 About a minute ago 616MB
#. Launch the built |CL| container.
.. code-block:: console
# docker run -it my-custom-clear-linux-container
Manage bundles in a Clear Linux based container
***********************************************
Bundles can be added and removed from an existing |CL| container by using
the `swupd` command in the Dockerfile.
Add a bundle (`swupd bundle-add`)
---------------------------------
This example Dockerfile shows how to add the `pxe-server` bundle to the
previously created |CL| Docker image:
.. code-block:: console
# cat > Dockerfile << EOF
FROM my-customer-clear-linux-container
MAINTAINER First Last <first.last@example.com>
RUN swupd bundle-add pxe-server
CMD ["/bin/bash/bash"]
EOF
Example output:
.. code-block:: console
# docker build -t my-clearlinux-with-pxe-server-bundle .
Sending build context to Docker daemon 806.5MB
Step 1/4 : FROM my-custom-clear-linux-container
---> 5414c3a12993
Step 2/4 : MAINTAINER First Last <first.last@example.com>
---> Running in 19b4411cf4bd
---> 08d400baffde
Removing intermediate container 19b4411cf4bd
Step 3/4 : RUN swupd bundle-add pxe-server
---> Running in 3e634d6e0792
swupd-client bundle adder 3.12.2
Copyright (C) 2012-2017 Intel Corporation
Attempting to download version string to memory
Downloading packs...
Extracting pxe-server pack for version 17820
.
Installing bundle(s) files...
..............................................................................
..............................................................................
..............................................................................
..............................................................................
..............................................................................
..............................................................................
Calling post-update helper scripts.
WARNING: systemctl not operable, unable to run systemd update triggers
Bundle(s) installation done.
---> 8ead5f2c0c33
Removing intermediate container 3e634d6e0792
Step 4/4 : CMD /bin/bash
---> Running in 0ceae320279b
---> dcd9adb40611
Removing intermediate container 0ceae320279b
Successfully built dcd9adb40611
Successfully tagged my-clearlinux-with-pxe-server-bundle:latest
.. note::
This `WARNING` message is expected and can be ignored because Systemd
doesn't run inside a container.
Remove a bundle (`swupd bundle-remove`)
---------------------------------------
This example Dockerfile shows how to remove the `pxe-server` bundle from the
previously created |CL| Docker image:
.. code-block:: console
# cat > Dockerfile << EOF
FROM my-clearlinux-with-pxe-server-bundle
MAINTAINER First Last <first.last@example.com>
RUN swupd bundle-remove pxe-server
CMD ["/bin/bash/bash"]
EOF
Example output:
.. code-block:: console
# docker build -t my-clearlinux-remove-pxe-server-bundle .
Sending build context to Docker daemon 806.5MB
Step 1/4 : FROM my-clearlinux-with-pxe-server-bundle
---> dcd9adb40611
Step 2/4 : MAINTAINER First Last <first.last@example.com>
---> Running in 71b60f15003e
---> 742192751c1a
Removing intermediate container 71b60f15003e
Step 3/4 : RUN swupd bundle-remove pxe-server
---> Running in ad28a3390ecc
swupd-client bundle remover 3.12.2
Copyright (C) 2012-2017 Intel Corporation
Removing bundle: pxe-server
Deleting bundle files...
Total deleted files: 92
Untracking bundle from system...
Success: Bundle removed
1 bundle(s) were removed successfully
---> d6ee7903e14d
Removing intermediate container ad28a3390ecc
Step 4/4 : CMD /bin/bash
---> Running in 7694989e97de
---> ec23189ef954
Removing intermediate container 7694989e97de
Successfully built ec23189ef954
Successfully tagged my-clearlinux-remove-pxe-server-bundle:latest
Also see:
* :ref:`cc-getting-started`
source/clear-linux/guides/network/network.rst
+1
View File
@@ -13,3 +13,4 @@ the configuration, administration, and use of networks in the |CLOSIA|.
dpdk
ovs-dpdk
network-bonding
custom-clear-container