Skip to main content

SDK Image Compilation (Docker Environment)

1. Introduction to Docker​

Docker is a lightweight containerization platform used to package, distribute, and run applications and their dependencies. Based on container technology, Docker packages an application and all required runtime environments into an independent and portable container, ensuring consistent behavior across different environments. This greatly improves development, deployment, and scaling efficiency. Docker defines applications and their runtime environments through images, and runs them through containers. Containers can run seamlessly on any operating system or cloud platform that supports Docker, while remaining lightweight, efficient, and isolated.

  • Container: Docker uses containers to package applications and all their dependencies, including code, runtime, system tools, and system libraries. Containers provide a lightweight, consistent, and portable way to run applications in different environments.
  • Image: An image is the basis of a container. It contains all information required to run the container, such as the filesystem, libraries, and configuration. Images can be shared, stored in repositories, and transferred over the network.
  • Repository: Images are stored in repositories for centralized management and sharing. Docker supports public repositories, such as Docker Hub, and private repositories. Users can pull required images from repositories, or push custom images for others to use or deploy.

  1. Install Docker tools, namely the Docker engine.

    sudo apt install docker.io -y

  2. Get the Docker image. Users in China are recommended to download the offline image directly.

    sudo docker pull luckfoxtech/luckfox_pico:1.0

  3. Get the offline Docker image.

    VersionDescriptionDownload
    luckfoxtech/luckfox_pico 1.0Offline Docker image downloadDocker Baidu Netdisk link
    # Install the Docker image
    sudo docker load -i ./luckfox_pico_docker.tar
Tip

The operations above only install Docker on the system, which is equivalent to installing the container runtime platform. To run a container, you still need to explicitly start one with commands such as docker run or docker start.

2. Build Images with Docker​

  1. Get the latest SDK. You can choose either of the following methods. Gitee is recommended for users in China. 
    git clone https://gitee.com/LuckfoxTECH/luckfox-pico.git
    git clone https://github.com/LuckfoxTECH/luckfox-pico.git
  2. Start an interactive container named luckfox, map the SDK directory on the host to /home inside the container, and run it with Bash. 
    sudo docker run -it --name luckfox --privileged -v /home/ubuntu/luckfox-pico:/home luckfoxtech/luckfox_pico:1.0 /bin/bash
    • -it: Runs an interactive container.
    • --name: Specifies a container name, making the container easier to identify and manage.
    • -v: Mounts a directory or file from the host into the container. In the example above, /home/ubuntu/luckfox-pico on the host is mounted to /home inside the container.
  3. If the container already exists, use the following command to start it again. 
    sudo docker start -ai luckfox
  4. Before compilation, select the code branch that matches the actual development board model to ensure that the compiled image can run correctly. 
    root@b165d8d4c29b:# cd /home
    root@807131c0df36:/home# ./build.sh lunch
    You're building on Linux
    Lunch menu...pick the Luckfox Pico hardware version:
    选择 Luckfox Pico 硬件版本:
                    [0] RV1103_Luckfox_Pico
                    [1] RV1103_Luckfox_Pico_Mini
                    [2] RV1103_Luckfox_Pico_Plus
                    [3] RV1103_Luckfox_Pico_WebBee
                    [4] RV1106_Luckfox_Pico_Pro_Max
                    [5] RV1106_Luckfox_Pico_Ultra
                    [6] RV1106_Luckfox_Pico_Pi
                    [7] RV1106_Luckfox_Pico_86Panel
                    [8] RV1106_Luckfox_Pico_Zero
                    [9] custom
    Which would you like? [0~9][default:0]: 5
    Lunch menu...pick the boot medium:
    选择启动媒介:
                    [0] EMMC
    Which would you like? [0][default:0]: 0
    Lunch menu...pick the system version:
    选择系统版本:
                    [0] Buildroot
    Which would you like? [0][default:0]: 0
    [build.sh:info] Lunching for Default BoardConfig_IPC/BoardConfig-EMMC-Buildroot-RV1106_Luckfox_Pico_Ultra-IPC.mk boards...
    [build.sh:info] switching to board: /home/ubuntu/Luckfox/rv1106/sdk-latest/luckfox-pico/project/cfg/BoardConfig_IPC/BoardConfig-EMMC-Buildroot-RV1106_Luckfox_Pico_Ultra-IPC.mk
    [build.sh:info] Running build_select_board succeeded.
    root@807131c0df36:/home# ./build.sh

3. Add the User to the Docker Group​

On Ubuntu, Docker commands need sudo by default because the Docker daemon runs with root privileges. Docker performs privileged operations such as accessing system resources, managing containers, building images, and mounting filesystems. If you do not want to use sudo every time you run Docker commands, add the current user to the docker group.

  1. Run the following command to add the current user to the docker group. 
    sudo usermod -aG docker $USER
  2. Log out and log in again, or run the following commands to make the change take effect. 
    sudo service docker restart
    newgrp docker
  3. Make sure that the user luckfox has been added to the docker group. 
    id luckfox

4. Common Docker Commands​

The following are some common Docker commands. To view the complete command list and help information, run docker --help.

  1. Image-related commands. 
    docker pull luckfoxtech/luckfox_pico:1.0      # Download the image from Docker Hub
    docker images                                 # List all local images
    docker rmi luckfoxtech/luckfox_pico:1.0       # Delete one or more local images
    docker search [image]                         # Search for an image on Docker Hub
  2. Container-related commands. 
    docker ps                                     # List currently running containers
    docker ps -a                                  # List all containers, including stopped containers
  3. Container operations. 
    docker start 1758                            # Start a stopped container
    docker stop 1758                             # Stop a running container
    docker restart 1758                          # Restart a container
    docker exec -it 1758 ls                      # Execute a command in a running container
    docker exec -it 1758 bash                    # Enter an already running container
    docker rm 1758                               # Delete one or more containers
    exit                                         # Exit
  4. Run a container. 
    sudo docker run -it --name luckfox --privileged -v /home/ubuntu/luckfox-pico:/home luckfoxtech/luckfox_pico:1.0 /bin/bash
    • -it: Runs an interactive container.
    • --name: Specifies a container name, making the container easier to identify and manage.
    • -v: Mounts a directory or file from the host into the container. In the example above, /home/ubuntu/luckfox-pico on the host is mounted to /home inside the container.
  5. If the container already exists, use the following command to start it again. 
    sudo docker start -ai luckfox
  6. System information. 
     docker logs 1758                             # View container logs
     docker inspect 1758                          # View detailed container information
     docker rmi luckfoxtech/luckfox_pico:1.0      # Delete one or more local images
     docker top 1758                              # View processes running in the container
    • A Docker container ID is unique. In most cases, the first few characters are enough to identify a container. Replace the example container ID with your own container ID, or its prefix, when running the commands.