使用 Conan 备份第三方源

对于开源、公开可用库的食谱和构建脚本，通常的做法是从规范源（如 Github 发布或项目下载网页）下载源。记录这些文件的来源有助于追溯，但是，这些文件长期可用性通常无法保证，将来用户从源构建相同食谱时可能会遇到问题。因此，Conan 可以配置为透明地从配置的镜像获取源，而无需修改食谱或 conandata.yml 文件。此外，这些源文件可以通过 conan upload 命令与包一起透明地上传。

源备份功能旨在将下载的食谱源存储在您自己的基础设施中的文件服务器上，即使原始下载 URL 不再可访问，也能保证您未来的构建可重现性。

当提供了 sha256 文件签名时，对 download 和 get 方法的调用会触发备份。

配置概述

此功能由几个 global.conf 项控制

  • core.sources:download_cache：存储源备份的本地路径。如果未设置，将使用默认的 Conan 主目录缓存路径。

  • core.sources:download_urls：Conan 将尝试下载源的 URL 有序列表，其中 origin 代表从 conandata.yml 传递给 get/download 的原始 URL。这允许控制获取顺序，例如 ["origin", "https://your.backup/remote/"] 表示仅当原始源不存在时才查看并从您的备份远程获取；或者 ["https://your.backup/remote/", "origin"] 表示优先使用您的备份服务器而不是食谱的规范链接。由于它是列表，因此也可以包含多个远程。默认为 ["origin"]

  • core.sources:upload_url：调用 conan upload 时上传备份的远程 URL，此 URL 可能与下载定义的任何 URL 不同。默认为空

  • core.sources:exclude_urls：跳过备份的源列表。如果传递给 get/download 的 URL 以此列表中的任何源开头，则在调用 conan upload 时不会将该源上传到备份远程。默认为空

用法

让我们通过一个从头到尾的示例用法来概述此功能的工作原理

总结一下，大致如下

  • 设置一个远程备份仓库。该仓库应允许使用 PUT 和 GET HTTP 方法来修改和获取其内容。如果需要访问凭据（强烈建议用于上传权限），您可以使用 source_credentials.json 功能。如果您需要配置自己的仓库，请参阅下方。

  • 然后可以在 core.sources:download_urls 和 core.sources:upload_url 中设置远程仓库的 URL。

  • 在您的食谱的 source() 方法中，确保相关的 get/download 调用提供了下载文件的 sha256 签名。

  • 如果需要自定义位置，请在您的 global.conf 文件中设置 core.sources:download_cache，否则将使用默认的缓存文件夹

  • 正常运行 Conan，创建包等。

  • 一旦某些源已本地下载，由 core.sources:download_cache 指向的文件夹将包含每个下载的文件：

    • 一个以 get/download 中提供的 sha256 签名命名的 blob 文件（无扩展名）。

    • 一个 .json 文件，其名称也将是 sha256 签名，其中将包含此 blob 属于哪个引用以及哪个镜像的信息。

  • 如果设置了 core.sources:upload_url，调用 conan upload 将选择性地上传匹配引用的备份。

注意

有关如何配置您自己的备份服务器的指南，请参阅下方

设置必要的配置

如果希望从自定义备份源远程下载，global.conf 文件应包含 core.sources:download_urls；如果希望自定义本地缓存路径来下载备份，则应包含 core.sources:download_cache。

global.conf
core.sources:download_urls=["https://myteam.myorg.com/artifactory/backup-sources/", "origin"]
core.sources:download_cache=/path/to/backup/sources

注意

必须定义 core.sources:download_urls 或 core.sources:download_cache 才能启用此功能。

您可能希望根据您的使用案例添加额外的配置，如本文档开头所述。

注意

处理组织中 CI worker 和开发者配置的推荐方法是使用 conan config install 命令从仓库安装配置。在此处阅读更多

正常运行 Conan

完成上述步骤后，现在可以正常使用 Conan 了。对于每个下载的源，Conan 将首先查看 core.sources:download_cache 中指示的文件夹，如果找不到，则会遍历 core.sources:download_urls，直到找到文件或失败，并将本地副本存储在相同的 core.sources:download_cache 位置。

当从备份远程获取备份时，将向用户显示类似以下的消息

客户端现在将打印关于它能够从哪个远程下载源的信息
$ conan create . --version=1.3

...

======== Installing packages ========
zlib/1.3: Calling source() in /Users/ruben/.conan2/p/zlib0f4e45286ecd1/s/src
zlib/1.3: Sources for ['https://zlib.net/fossils/zlib-1.3.tar.gz', 'https://github.com/madler/zlib/releases/download/v1.3/zlib-1.3.tar.gz']
          found in remote backup https://myteam.myorg.com/artifactory/backup-sources

-------- Installing package zlib/1.3 (1 of 1) --------

...

如果我们现在再次尝试运行此操作，我们会发现没有执行下载，而是使用了本地存储的文件版本。

上传包

如上所示创建包后，当执行 conan upload zlib/1.3 -c 调用以上传生成的二进制文件到您的 Conan 仓库时，如果配置了相关设置，它也会将该相同引用的源备份上传到您的备份远程仓库，将来下载此食谱的源时将使用最新更新的内容。

注意

有关仅上传已构建包的方法，请参阅包列表功能

如果需要为未链接到任何包的源或已在远程仓库中因此在上传过程中会被跳过的包上传备份，可以使用 conan cache backup-upload 命令来解决此情况。

创建备份仓库

您也可以设置自己的远程备份仓库，而不是依赖于已有的仓库。虽然 Artifactory 通用仓库（Artifactory CE 免费提供）推荐用于此目的，但任何允许使用 PUT 和 GET HTTP 方法来修改和获取其内容的简单服务器就足够了。

阅读下一节，了解如何创建一个 Artifactory 通用备份仓库，以及如何赋予其公共读取权限，同时只允许授权代理进行写入访问。