Docker Guide: Difference between revisions

From Variscite Wiki
No edit summary
No edit summary
 
(55 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<!-- Set release according to "release" parameter in URL and use RELEASE_THUD_V1.0_VAR-SOM-MX6 as default
--> {{INIT_RELEASE_PARAM|RELEASE_THUD_V1.0_VAR-SOM-MX6}}<!--
--> {{#lst:Yocto_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
--> {{#lst:B2QT_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
--> {{#lst:Debian_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
--> {{#vardefine:GUIDE_NAME|{{#if: {{#var:B2QT_GIT}} | B2QT | Yocto }}}} <!--
--> {{#vardefine:DOCKER_INTEGRATION_PREFIX|{{#varexists:DEBIAN_NAME | DEBIAN_ |}}}} <!--
--> {{PageHeader|{{#var:HARDWARE_NAME}} - Docker}} {{DocImage|category1=Yocto|category2=Debian}} <!--
--> {{VAR_FILES_DOMAIN}} <!--
--> [[category:{{#var:HARDWARE_NAME}}]] __toc__
= Docker Introduction =
= Docker Introduction =
<https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-debian-9>
Docker is a software platform that allows the creation, testing and distribution of applications via containers.<br>
 
Containers let you run your applications in resource-isolated processes. There are some similarities to virtual machines, but  
Docker is an application that simplifies the process of managing application processes in containers.<br>
containers are more portable, more resource-friendly, and enables faster software delivery cycles.<br>
Containers let you run your applications in resource-isolated processes. They’re similar to virtual machines, but containers<br>
Often used with docker there's a companion tool known as docker-compose: compose is used for defining and running multi-container Docker applications.<br>
are more portable, more resource-friendly, and more dependent on the host operating system.<br>
<br>
For a detailed introduction to the different components of a Docker container, check out The Docker Ecosystem: An Introduction to<br> Common Components.<br>
<br>
You can check SWUpdate's online documentation at: [http://sbabic.github.io/swupdate http://sbabic.github.io/swupdate]<br>
This Introduction was taken from the SWUpdate README.md at: [https://github.com/sbabic/swupdate https://github.com/sbabic/swupdate]<br>
<br>
<br>
You can check Docker online documentation at:<br>
https://docs.docker.com/get-started/<br>
https://docs.docker.com/compose/<br>
https://training.play-with-docker.com/<br>
https://docker-curriculum.com/<br>


= Yocto Integration =
{{#switch: {{#var:SOC_SERIES}}
| am6=
|#default=
{{{{#var:DOCKER_INTEGRATION_PREFIX}}DOCKER_INTEGRATION}}
}}


== Recipes ==
= Test Docker =
* Check docker version:<br>
root@{{#var:MACHINE_NAME}}:~# docker --version


Before you begin, get familiar with the Varicite {{Varlink2|Yocto Build Release|{{#var:RELEASE_LINK}}}} guide.<br>
== Test hello-world ==
<br>
Variscite provides the following image recipes:


* '''var-image-docker''' - Based on fsl-image-core with the following differences:
* Pull the hello-world image from Docker Hub:<br>
** xxxxxxxxxxxxxx
  root@{{#var:MACHINE_NAME}}:~# docker pull hello-world
<br>
== Create a Docker-ready Image ==
* Follow steps 1-3 of the {{Varlink2|Yocto Build Release|{{#var:RELEASE_LINK}}}} page.
  $ cd {{#var:BUILD_FOLDER}}
{{#ifeq: {{#var:SOC_SERIES}} | imx8 |
$ MACHINE={{#var:MACHINE_NAME}} DISTRO={{#var:BUILD_DISTRO}} {{#var:BUILD_SCRIPT}} -b {{#var:BUILD_FOLDER_XWAYLAND}}
|
$ MACHINE={{#var:MACHINE_NAME}} DISTRO={{#var:BUILD_DISTRO}} {{#var:BUILD_SCRIPT}} {{#var:BUILD_FOLDER_X11}}
}}


  $ bitbake var-image-docker (for the rootfs to be installed on the eMMC)
* List docker images:<br>
  root@{{#var:MACHINE_NAME}}:~# docker images


= Test Docker =
* Run hello-world container:<br>
* Check target internet connection<br>
root@{{#var:MACHINE_NAME}}:~# docker run hello-world
  root@imx8mm-var-dart:~# ping www.google.com
Hello from Docker!<br>
This message shows that your installation appears to be working correctly.
To generate this message, Docker took the following steps:<br>
  1. The Docker client contacted the Docker daemon.<br>
  2. The Docker daemon pulled the "hello-world" image from the Docker Hub.<br>
  3. The Docker daemon created a new container from that image which runs the<br>
    executable that produces the output you are currently reading.<br>
  4. The Docker daemon streamed that output to the Docker client, which sent it<br>
    to your terminal.


* Get target ip address.<br>
== Test Ubuntu ==
* Open ssh terminal from host:<br>
* Pull the ubuntu image from Docker Hub:<br>
  ssh root@<ip address>
root@{{#var:MACHINE_NAME}}:~# docker pull ubuntu


* Check docker version.<br>
* Run ubuntu:<br>
  root@imx8mm-var-dart:~# docker --version<br>
root@{{#var:MACHINE_NAME}}:~# docker run -it ubuntu<br>
  Docker version 18.09.3-ce, build f5e591e
root@8637148015f5:/# apt update<br>
…<br>
root@8637148015f5:/# apt install nodejs<br>
…<br>
root@8637148015f5:/# node -v<br>
…<br>
root@8637148015f5:/# exit<br>
root@{{#var:MACHINE_NAME}}:~#


== Test hello-world ==
= Test docker-compose =
root@imx8mm-var-dart:~# docker pull hello-world<br>
* Check the docker-compose version:<br>
Using default tag: latest<br>
root@{{#var:MACHINE_NAME}}:~# docker-compose --version
latest: Pulling from library/hello-world<br>
256ab8fe8778: Pull complete <br>
Digest: sha256:f9dfddf63636d84ef479d645ab5885156ae030f611a56f3a7ac7f2fdd86d7e4e<br>
Status: Downloaded newer image for hello-world:latest


* List docker images:<br>
== Examples ==
  root@imx8mm-var-dart:~# docker images<br>
  REPOSITORY          TAG                IMAGE ID            CREATED            SIZE<br>
  hello-world        latest              a29f45ccde2a        3 months ago        9.14kB


* Run hello-world:<br>
=== RESTful-based data-logger ===
  root@imx8mm-var-dart:~# docker run hello-world


  Hello from Docker!<br>
This [{{#var:VAR_FILES_HTTPS}}/docker/Docker_Example01_RestDataLogger.zip archive] provides an example of a RESTful-based data-logger to be deployed on an embedded device acting as an intelligent edge node in large connected networks.<br>
  This message shows that your installation appears to be working correctly.
Through a developed web service application based on the ''Tornado web framework'', data can be easily inserted and retrieved from a ''MongoDB'' instance by remote devices.


  To generate this message, Docker took the following steps:<br>
In the tutorial the application is proposed as a '''Docker'''-based solution in which each component is run in a separate container.<br>
  1. The Docker client contacted the Docker daemon.<br>
'''Docker Compose''' is used to simplify the build of custom Docker images, their deployment, and configuration.<br>
  2. The Docker daemon pulled the "hello-world" image from the Docker Hub.<br>
The application can be easily tested on any device which supports Docker and Docker Compose, be it a PC or an embedded device.
      (arm64v8)<br>
  3. The Docker daemon created a new container from that image which runs the<br>
      executable that produces the output you are currently reading.<br>
  4. The Docker daemon streamed that output to the Docker client, which sent it<br>
      to your terminal.


== Test ubuntu ==
=== PyQt application ===
root@imx8mm-var-dart:~# docker pull ubuntu
Using default tag: latest
latest: Pulling from library/ubuntu
b2f61026a351: Pull complete
5538fb30c42c: Pull complete
f0b05810781a: Pull complete
0180a33352d6: Pull complete
Digest: sha256:bec5a2727be7fff3d308193cfde3491f8fba1a2ba392b7546b43a051853a341d
Status: Downloaded newer image for ubuntu:latest


* List docker images:<br>
This [{{#var:VAR_FILES_HTTPS}}/docker/Docker_Example02_PyQtApplication.zip archive] provides a PyQt reference application . The Wayland graphic server is abstracted as resource to be passed to a Docker image in which the application is deployed.
  root@imx8mm-var-dart:~# root@imx8mm-var-dart:~# docker images
  REPOSITORY          TAG                IMAGE ID            CREATED            SIZE
  ubuntu              latest              428b2f74b0fb        2 weeks ago        57.7MB
  hello-world        latest              a29f45ccde2a        3 months ago        9.14kB


* Run ubuntu:<br>
In the Dockerfile the reference buster-slim image is used as a starting point, then python3 and all dependencies necessary to execute Qt applications are installed. Wayland backend has been chosen because the only one available for all Variscite SoMs.
  root@imx8mm-var-dart:~# docker run -it ubuntu<br>
  root@8637148015f5:/# apt update<br>
  .................................<br>
  Fetched 16.3 MB in 11s (1471 kB/s)<br>                                                                                                             
  Reading package lists... Done<br>
  Building dependency tree<br>
  Reading state information... Done<br>
  12 packages can be upgraded. Run 'apt list --upgradable' to see them.


  root@8637148015f5:/# apt install nodejs<br>
=== GStreamer application ===
  Reading package lists... Done<br>
  Building dependency tree<br>
  Reading state information... Done<br>
  The following additional packages will be installed:<br>
    ca-certificates libc-ares2 libhttp-parser2.7.1 libicu60 libnghttp2-14 libssl1.0.0 libssl1.1 libuv1 nodejs-doc openssl<br>
  The following NEW packages will be installed:<br>
    ca-certificates libc-ares2 libhttp-parser2.7.1 libicu60 libnghttp2-14 libssl1.0.0 libssl1.1 libuv1 nodejs nodejs-doc openssl<br>
  0 upgraded, 11 newly installed, 0 to remove and 12 not upgraded.<br>
  Need to get 15.6 MB of archives.<br>
  After this operation, 62.8 MB of additional disk space will be used.<br>
  Do you want to continue? [Y/n] y<br>
  ...........................................<br>
  Updating certificates in /etc/ssl/certs...<br>
  0 added, 0 removed; done.<br>
  Running hooks in /etc/ca-certificates/update.d...<br>
  done.<br>


  root@8637148015f5:/# node -v<br>
This [{{#var:VAR_FILES_HTTPS}}/docker/Docker_Example03_GStreamer.zip archive] provides a Gstreamer test application . The Wayland graphic server is abstracted as resource to be passed to a Docker image in which the application is deployed.
  v8.10.0<br>
  root@8637148015f5:/# exit<br>


= Test docker-compose =
In the Dockerfile the reference buster-slim image is used as a starting point, then gstreamer1.0 and all dependencies necessary to execute GStreamer applications are installed. Wayland backend has been chosen because the only one available for all Variscite SoMs.
* Check docker-compose version.<br>
  root@imx8mm-var-dart:~# docker-compose --version<br>
  docker-compose version 1.21.2, build e7de1bc<br>
  root@imx8mm-var-dart:~#

Latest revision as of 13:41, 1 December 2023

Warning: This page is designed to be used with a 'release' URL parameter.

This page is using the default release RELEASE_THUD_V1.0_VAR-SOM-MX6.
To view this page for a specific Variscite SoM and software release, please follow these steps:

  1. Visit variwiki.com
  2. Select your SoM
  3. Select the software release
VAR-SOM-MX6 - Docker

Docker Introduction

Docker is a software platform that allows the creation, testing and distribution of applications via containers.
Containers let you run your applications in resource-isolated processes. There are some similarities to virtual machines, but containers are more portable, more resource-friendly, and enables faster software delivery cycles.
Often used with docker there's a companion tool known as docker-compose: compose is used for defining and running multi-container Docker applications.

You can check Docker online documentation at:
https://docs.docker.com/get-started/
https://docs.docker.com/compose/
https://training.play-with-docker.com/
https://docker-curriculum.com/

Yocto Integration

Recipe

Before you begin, get familiar with the Yocto Build Release guide.

The Yocto BSP provides 2 dedicated images:

  • var-image-docker: a graphic enabled image based on fsl-image-gui with the addition of a few more packages:
    • docker
    • python3-docker-compose
  • var-image-docker-minimal: a console image based on the core-image bbclass with the addition of a few more packages and features:
    • docker
    • python3-docker-compose
    • ssh-server-dropbear
    • basic command line tools

Create a Docker-ready Image

$ cd ~/var-fslc-yocto
$ MACHINE=var-som-mx6 DISTRO=fslc-x11 . setup-environment build_x11

Append the following to the conf/local.conf file in your Yocto build directory:

DISTRO_FEATURES_append = " virtualization"

Build var-image-docker:

$ bitbake var-image-docker

Test Docker

  • Check docker version:
root@var-som-mx6:~# docker --version

Test hello-world

  • Pull the hello-world image from Docker Hub:
root@var-som-mx6:~# docker pull hello-world
  • List docker images:
root@var-som-mx6:~# docker images
  • Run hello-world container:
root@var-som-mx6:~# docker run hello-world

Hello from Docker!
This message shows that your installation appears to be working correctly. To generate this message, Docker took the following steps:
1. The Docker client contacted the Docker daemon.
2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
3. The Docker daemon created a new container from that image which runs the
executable that produces the output you are currently reading.
4. The Docker daemon streamed that output to the Docker client, which sent it
to your terminal.

Test Ubuntu

  • Pull the ubuntu image from Docker Hub:
root@var-som-mx6:~# docker pull ubuntu
  • Run ubuntu:
root@var-som-mx6:~# docker run -it ubuntu
root@8637148015f5:/# apt update

root@8637148015f5:/# apt install nodejs

root@8637148015f5:/# node -v

root@8637148015f5:/# exit
root@var-som-mx6:~#

Test docker-compose

  • Check the docker-compose version:
root@var-som-mx6:~# docker-compose --version

Examples

RESTful-based data-logger

This archive provides an example of a RESTful-based data-logger to be deployed on an embedded device acting as an intelligent edge node in large connected networks.
Through a developed web service application based on the Tornado web framework, data can be easily inserted and retrieved from a MongoDB instance by remote devices.

In the tutorial the application is proposed as a Docker-based solution in which each component is run in a separate container.
Docker Compose is used to simplify the build of custom Docker images, their deployment, and configuration.
The application can be easily tested on any device which supports Docker and Docker Compose, be it a PC or an embedded device.

PyQt application

This archive provides a PyQt reference application . The Wayland graphic server is abstracted as resource to be passed to a Docker image in which the application is deployed.

In the Dockerfile the reference buster-slim image is used as a starting point, then python3 and all dependencies necessary to execute Qt applications are installed. Wayland backend has been chosen because the only one available for all Variscite SoMs.

GStreamer application

This archive provides a Gstreamer test application . The Wayland graphic server is abstracted as resource to be passed to a Docker image in which the application is deployed.

In the Dockerfile the reference buster-slim image is used as a starting point, then gstreamer1.0 and all dependencies necessary to execute GStreamer applications are installed. Wayland backend has been chosen because the only one available for all Variscite SoMs.