使用 Docker 运行器创建 Conan 包¶
警告
此功能为实验性功能，可能会有破坏性更改。有关更多信息，请参阅Conan 稳定性部分。
首先，您需要安装并运行 Docker 守护程序，以及 Conan 和 docker Python 包。本教程假设您在 Python 虚拟环境中运行 Conan，如果您已经在您的虚拟环境中安装了 docker Python 包，请跳过第一行。
# install docker in your virtual environment if you don't have it already installed
$ pip install conan docker
$ docker ps
$ CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
现在我们将创建一个简单的 cmake_lib Conan 模板，稍后使用运行器功能在 Docker 内部运行。让我们在我们的项目文件夹中创建 Conan 包和一个 Dockerfile。
$ cd </my/runner/folder>
$ mkdir mylib
$ cd mylib
$ conan new cmake_lib -d name=mylib -d version=0.1
$ tree
.
├── CMakeLists.txt
├── conanfile.py
├── include
│ └── mylib.h
├── src
│ └── mylib.cpp
└── test_package
├── CMakeLists.txt
├── conanfile.py
└── src
└── example.cpp
Dockerfile
FROM ubuntu:22.04
RUN apt-get update \
&& DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
build-essential \
cmake \
python3 \
python3-pip \
python3-venv \
&& rm -rf /var/lib/apt/lists/*
RUN pip install conan
$ cd </my/runner/folder>/mylib
$ tree
.
...
├── Dockerfile
...
现在，我们需要在 conan profiles 文件夹中定义两个新的 profile。将 </my/runner/folder> 替换为您的实际项目文件夹路径。
docker_example_host profile
[settings]
build_type=Release
arch=x86_64
compiler=gcc
compiler.cppstd=gnu17
compiler.libcxx=libstdc++11
compiler.version=11
os=Linux
[runner]
type=docker
dockerfile=</my/runner/folder>/mylib
cache=copy
remove=true
platform=linux/amd64
注意
用户可以自由配置主机 profile 上的架构和平台。Conan docker 集成将使用指定的平台构建和运行镜像。
例如，如果您正在使用 Mac Silicon，您可以将平台设置为 linux/arm64/v8 以使用 armv8 架构构建镜像。
[settings]
arch=armv8
# ...
[runner]
platform=linux/arm64/v8
docker_example_build profile
[settings]
arch=x86_64
build_type=Release
compiler=gcc
compiler.cppstd=gnu17
compiler.libcxx=libstdc++11
compiler.version=11
os=Linux
我们将从一个完全干净的环境开始，没有任何容器、镜像或 conan 包。
$ conan list "*:*"
Found 0 pkg/version recipes matching * in local cache
$ docker ps --all
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
现在，是时候使用我们新的运行器定义创建我们的库 mylib 了。
$ conan create . -pr:h docker_example_host -pr:b docker_example_build
如果我们拆分并分析命令输出，我们可以看到正在发生什么以及命令在哪里执行。
1. 标准 conan 执行。
======== Exporting recipe to the cache ========
mylib/0.1: Exporting package recipe: </my/runner/folder>/mylib/conanfile.py
mylib/0.1: Copied 1 '.py' file: conanfile.py
mylib/0.1: Copied 1 '.txt' file: CMakeLists.txt
mylib/0.1: Copied 1 '.h' file: mylib.h
mylib/0.1: Copied 1 '.cpp' file: mylib.cpp
mylib/0.1: Exported to cache folder: /Users/<user>/.conan2/p/mylib4abd06a04bdaa/e
mylib/0.1: Exported: mylib/0.1#8760bf5a311f01cc26f3b95428203210 (2024-07-08 12:22:01 UTC)
======== Input profiles ========
Profile host:
[settings]
arch=x86_64
build_type=Release
compiler=gcc
compiler.cppstd=gnu17
compiler.libcxx=libstdc++11
compiler.version=11
os=Linux
Profile build:
[settings]
arch=x86_64
build_type=Release
compiler=gcc
compiler.cppstd=gnu17
compiler.libcxx=libstdc++11
compiler.version=11
os=Linux
2. 构建 docker 镜像
Building the Docker image: conan-runner-default
Dockerfile path: '</my/runner/folder>/mylib/Dockerfile'
Docker build context: '</my/runner/folder>/mylib'
Step 1/3 : FROM ubuntu:22.04
---> 97271d29cb79
Step 2/3 : RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends build-essential cmake python3 python3-pip python3-venv g++-x86-64-linux-gnu && rm -rf /var/lib/apt/lists/*
...
---> 2bcf70201cce
Successfully built 2bcf70201cce
Successfully tagged conan-runner-default:latest
3. 保存本地缓存，运行 conan cache save。
Save host cache in: /Users/<user>/sources/test/mylib/.conanrunner/local_cache_save.tgz
Found 1 pkg/version recipes matching * in local cache
Saving mylib/0.1: mylib4abd06a04bdaa
4. 创建并初始化 docker 容器。
Creating the docker container
Container conan-runner-docker running
5. 检查容器是否具有带有 runner 功能的 conan 版本。
conan-runner-docker | $ conan --version
conan-runner-docker | Conan version 2.12.1
6. 使用主机副本初始化容器 conan 缓存，运行 conan cache restore。
conan-runner-docker | $ conan cache restore "/root/conanrunner/mylib/.conanrunner/local_cache_save.tgz"
conan-runner-docker | Restore: mylib/0.1 in mylib4abd06a04bdaa
conan-runner-docker | Local Cache
conan-runner-docker | mylib
conan-runner-docker | mylib/0.1
conan-runner-docker | revisions
conan-runner-docker | 8760bf5a311f01cc26f3b95428203210 (2025-01-31 12:34:25 UTC)
conan-runner-docker | packages
conan-runner-docker | recipe_folder: mylib4abd06a04bdaa
7. 在容器内运行 conan create 并构建 “mylib”。
conan-runner-docker | $ conan create /root/conanrunner/mylib -pr:h docker_param_example_host -pr:b docker_param_example_build
-f json > create.json
conan-runner-docker |
conan-runner-docker | ======== Exporting recipe to the cache ========
conan-runner-docker | mylib/0.1: Exporting package recipe: /root/conanrunner/mylib/conanfile.py
conan-runner-docker | mylib/0.1: Copied 1 '.py' file: conanfile.py
conan-runner-docker | mylib/0.1: Copied 1 '.txt' file: CMakeLists.txt
conan-runner-docker | mylib/0.1: Copied 1 '.h' file: mylib.h
conan-runner-docker | mylib/0.1: Copied 1 '.cpp' file: mylib.cpp
conan-runner-docker | mylib/0.1: Exported to cache folder: /root/.conan2/p/mylib4abd06a04bdaa/e
conan-runner-docker | mylib/0.1: Exported: mylib/0.1#8760bf5a311f01cc26f3b95428203210 (2025-01-31 12:34:26 UTC)
conan-runner-docker |
conan-runner-docker | ======== Input profiles ========
conan-runner-docker | Profile host:
conan-runner-docker | [settings]
conan-runner-docker | arch=x86_64
conan-runner-docker | build_type=Release
conan-runner-docker | compiler=gcc
conan-runner-docker | compiler.cppstd=gnu17
conan-runner-docker | compiler.libcxx=libstdc++11
conan-runner-docker | compiler.version=11
conan-runner-docker | os=Linux
conan-runner-docker |
conan-runner-docker | Profile build:
conan-runner-docker | [settings]
conan-runner-docker | arch=x86_64
conan-runner-docker | build_type=Release
conan-runner-docker | compiler=gcc
conan-runner-docker | compiler.cppstd=gnu17
conan-runner-docker | compiler.libcxx=libstdc++11
conan-runner-docker | compiler.version=11
conan-runner-docker | os=Linux
conan-runner-docker |
conan-runner-docker |
conan-runner-docker | ======== Computing dependency graph ========
conan-runner-docker | Graph root
conan-runner-docker | cli
conan-runner-docker | Requirements
conan-runner-docker | mylib/0.1#8760bf5a311f01cc26f3b95428203210 - Cache
conan-runner-docker |
conan-runner-docker | ======== Computing necessary packages ========
conan-runner-docker | mylib/0.1: Forced build from source
conan-runner-docker | Requirements
conan-runner-docker | mylib/0.1#8760bf5a311f01cc26f3b95428203210:8631cf963dbbb4d7a378a64a6fd1dc57558bc2fe - Build
conan-runner-docker |
...
conan-runner-docker | [ 50%] Building CXX object CMakeFiles/example.dir/src/example.cpp.o
conan-runner-docker | [100%] Linking CXX executable example
conan-runner-docker | [100%] Built target example
conan-runner-docker |
conan-runner-docker |
conan-runner-docker | ======== Testing the package: Executing test ========
conan-runner-docker | mylib/0.1 (test package): Running test()
conan-runner-docker | mylib/0.1 (test package): RUN: ./example
conan-runner-docker | mylib/0.1: Hello World Release!
conan-runner-docker | mylib/0.1: __x86_64__ defined
conan-runner-docker | mylib/0.1: _GLIBCXX_USE_CXX11_ABI 1
conan-runner-docker | mylib/0.1: __cplusplus201703
conan-runner-docker | mylib/0.1: __GNUC__11
conan-runner-docker | mylib/0.1: __GNUC_MINOR__4
conan-runner-docker | mylib/0.1 test_package
8. 仅复制在容器内创建的包，使用来自先前 conan create 的 pkglist.json 信息，将这个新包恢复到主机缓存中，运行 conan cache save 并移除容器。
conan-runner-docker | $ conan cache save --list=pkglist.json --file "/root/conanrunner/mylib"/.conanrunner/docker_cache_save.tgz
conan-runner-docker | Saving mylib/0.1: mylib4abd06a04bdaa
conan-runner-docker | Saving mylib/0.1:8631cf963dbbb4d7a378a64a6fd1dc57558bc2fe: b/mylib11242e0a7e627/p
conan-runner-docker | Saving mylib/0.1:8631cf963dbbb4d7a378a64a6fd1dc57558bc2fe metadata: b/mylib11242e0a7e627/d/metadata
conan-runner-docker | Local Cache
conan-runner-docker | mylib
conan-runner-docker | mylib/0.1
conan-runner-docker | revisions
conan-runner-docker | 8760bf5a311f01cc26f3b95428203210 (2025-01-31 12:34:26 UTC)
conan-runner-docker | packages
conan-runner-docker | 8631cf963dbbb4d7a378a64a6fd1dc57558bc2fe
conan-runner-docker | revisions
conan-runner-docker | ded6547554ff2306db5250451340fa43
conan-runner-docker | package_folder: b/mylib11242e0a7e627/p
conan-runner-docker | metadata_folder: b/mylib11242e0a7e627/d/metadata
conan-runner-docker | info
conan-runner-docker | settings
conan-runner-docker | os: Linux
conan-runner-docker | arch: x86_64
conan-runner-docker | compiler: gcc
conan-runner-docker | compiler.cppstd: gnu17
conan-runner-docker | compiler.libcxx: libstdc++11
conan-runner-docker | compiler.version: 11
conan-runner-docker | build_type: Release
conan-runner-docker | options
conan-runner-docker | fPIC: True
conan-runner-docker | shared: False
conan-runner-docker | recipe_folder: mylib4abd06a04bdaa
conan-runner-docker |
Restore host cache from: /Users/<user>/sources/test/mylib/.conanrunner/docker_cache_save.tgz
Restore: mylib/0.1 in mylib4abd06a04bdaa
Restore: mylib/0.1:8631cf963dbbb4d7a378a64a6fd1dc57558bc2fe in b/mylib11242e0a7e627/p
Restore: mylib/0.1:8631cf963dbbb4d7a378a64a6fd1dc57558bc2fe metadata in b/mylib11242e0a7e627/d/metadata
Stopping container
Removing container
如果我们现在检查我们的 conan 和 docker 缓存的状态，我们将看到为 Linux 编译的新 mylib 包和新的 docker 镜像，但我们没有任何容器，因为我们定义了 remove=true
$ conan list "*:*"
Found 1 pkg/version recipes matching * in local cache
Local Cache
mylib
mylib/0.1
revisions
8760bf5a311f01cc26f3b95428203210 (2024-07-08 12:33:28 UTC)
packages
8631cf963dbbb4d7a378a64a6fd1dc57558bc2fe
info
settings
arch: x86_64
build_type: Release
compiler: gcc
compiler.cppstd: gnu17
compiler.libcxx: libstdc++11
compiler.version: 11
os: Linux
options
fPIC: True
shared: False
$ docker ps --all
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
my-conan-runner latest 2bcf70201cce 11 minutes ago 531MB
我们刚刚做的是在 Docker 容器内从头开始编译一个库，而无需运行任何 Docker 命令，并通过我们的终端输出以完全透明且易于调试的方式检索生成的包。
通过这种方式，我们可以像往常一样工作，无论是在我们的机器上还是在容器中，无需打开多个终端，并将每个操作的结果放在同一个缓存中，从而能够自动和透明地重用来自先前在另一个容器中编译的包。