跳到主要内容

仓库

仓库（Repository）是存放和管理 Ansible 内容（如 playbook 和 role）的地方。

仓库列表

列表显示名称、带分支的 Git URL，以及用于认证的密钥。

Semaphore 支持以下类型的仓库：

  • 本地文件系统（/path/to/the/repo）
  • 本地 Git 仓库（file://）
  • 通过 HTTPS（https://）、SSH（ssh:// 或简写形式 git@host:org/repo.git）访问的远程 Git 仓库
  • 支持 git:// 协议，但出于安全原因不推荐使用。

所有任务模板（Task Templates）都需要一个仓库才能运行。

认证​

如果你使用的远程仓库需要认证，需要在 Semaphore 的**密钥库（Key Store）**分区中配置密钥。

对于使用 SSH 的远程仓库，你需要在密钥库中使用你的 SSH 密钥。

对于不需要认证的远程仓库，可以创建类型为 None 的密钥。

仓库的密钥仅用于该仓库。要访问托管在别处、拥有各自凭据的子模块、requirements.yml 角色或其他仓库，请在 Host config 中添加一条映射。

创建新仓库​

  1. 确保你已经在密钥库分区中为即将添加的仓库配置好了密钥。

  2. 进入 Semaphore 的 Repositories 分区，点击右上角的 New Repository 按钮。

  3. 配置仓库：

    • 为仓库命名
    • 添加 URL。URL 必须以下列形式之一开头：
      • /path/to/the/repo：文件系统上的本地文件夹
      • https://：通过 HTTPS 访问的远程 Git 仓库
      • ssh://：通过 SSH 访问的远程 Git 仓库
      • file://：本地 Git 仓库
      • git://：通过 Git 协议访问的远程 Git 仓库
    • 设置仓库的分支，如果不确定应该填什么，通常是 master 或 main
    • 如果该仓库是所有模板共用的 monorepo，勾选 Single checkout for all templates，参见 Monorepo
    • 选择你在设置此仓库之前配置好的 Access Key。

  4. 全部配置完成后点击 Save。

Monorepo：所有模板共用一次检出​

自 v2.20 起

Single checkout for all templates 选项自 Semaphore 2.20 起可用。更早的版本始终为每个模板单独克隆一次仓库。

默认情况下，Semaphore 为每个模板单独克隆一次仓库，因此每个模板都在自己的副本中工作。对于被许多模板共用的大型仓库，这些副本会占用磁盘空间，而且每个任务都要先克隆或拉取自己的副本。

勾选 Single checkout for all templates 可以只克隆一次仓库，并在项目的所有模板之间共享这一次检出。该选项对本地文件夹（/path/to/the/repo）不可用，因为本地文件夹从不会被克隆。

启用了 Single checkout for all templates 的仓库表单

共享检出的工作方式：

  • 任务启动前，Semaphore 先对检出加锁，fetch 并 pull 仓库中配置的分支，然后释放锁。在检出更新期间，其他模板的任务会等待该锁，但任务本身是并行运行的。
  • 每个分支仍然拥有自己的检出，因此分支不同的仓库永远不会共用同一个工作树。
  • 检出是共享的，但 Ansible 主目录（从 requirements.yml 安装的 role 和 collection）对每个模板仍然是独立的。

由于所有模板都在同一分支的同一检出中工作，monorepo 的模板不能拥有自己的 Branch，也不能启用允许任务选择分支或提交的 Branch 提示。模板表单会禁用这两项并说明原因，API 也会拒绝这样的模板。请确保 playbook 不会向检出中写入内容：被修改的工作树会导致下一次 pull 失败，Semaphore 随后会删除该检出并重新克隆。

编辑现有仓库​

  1. 进入 Semaphore 的 Repositories 分区。

  2. 点击要修改的仓库旁边的铅笔图标，随后会显示该仓库的配置。

删除仓库​

请确保要删除的仓库没有被任何任务模板使用。 被任务模板使用的仓库无法删除：

  1. 进入 Semaphore 的 Repositories 分区。

  2. 点击要删除的仓库上的垃圾桶图标。

  3. 如果确定要删除该仓库，请在确认弹窗中点击 Yes。

依赖要求​

在项目初始化时，Semaphore 会按以下位置和顺序查找并安装 requirements.yml 中的 Ansible role 和 collection。

Role​

  • playbook_dir/roles/requirements.yml
  • playbook_dir/requirements.yml
  • repo_path/roles/requirements.yml
  • repo_path/requirements.yml

Collection​

  • playbook_dir/collections/requirements.yml
  • playbook_dir/requirements.yml
  • repo_path/collections/requirements.yml
  • repo_path/requirements.yml

处理逻辑​

  • 每个文件独立处理
  • 如果文件存在，则按其类型（role 或 collection）进行处理
  • 如果任何文件的处理出错，安装过程会停止并返回该错误
  • 根目录中的同一个 requirements.yml 文件（playbook_dir/requirements.yml 和 repo_path/requirements.yml）会被处理两次——一次用于 role，一次用于 collection

无论之前的位置是否存在或是否处理成功，Semaphore 都会尝试处理所有这些位置，除非出现错误。