Using SSH keys with GitLab CI/CD

Using SSH keys with GitLab CI/CD

GitLab 当前不支持在构建环境（运行 GitLab Runner 的环境）中管理 SSH 密钥的内置支持.

SSH 密钥在以下情况下很有用：

  1. 您想签出内部子模块
  2. 您想使用包管理器（例如 Bundler）下载私有包
  3. 您想要将应用程序部署到自己的服务器上，例如 Heroku
  4. 您要执行从构建环境到远程服务器的 SSH 命令
  5. 您想将文件从构建环境同步到远程服务器

如果上述任何事情都响了，那么您很可能需要 SSH 密钥.

支持最广泛的方法是通过扩展来将 SSH 密钥注入构建环境，该解决方案可与任何类型的执行器 （Docker，shell 等）一起使用.

  1. 使用在本地创建新的 SSH 密钥对
  2. 将私钥作为变量添加到您的项目中
  3. 在作业期间运行以加载私钥.

注意：除非您启用调试日志记录，否则私钥将不会显示在作业日志中. 您可能还需要检查的可见性 .

当您的 CI / CD 作业在 Docker 容器中运行（意味着包含环境）并且您想要在私有服务器中部署代码时，您需要一种访问它的方法. 这是 SSH 密钥对派上用场的地方.

  1. 您首先需要创建一个 SSH 密钥对. 有关更多信息，请按照说明 . 不要在 SSH 密钥中添加密码，否则before_script会提示您输入密码.

  2. 创建一个新变量 . 在” 密钥”中输入名称SSH_PRIVATE_KEY然后在” 值”字段中粘贴先前创建的私钥的内容.

  3. 注意： 可以全局设置或按作业设置.

  4. 确保专用服务器的SSH 主机密钥已验证 .

  5. 作为最后一步，从添加您在第一步，你想拥有从构建环境中的接入服务创建一个公共密钥. 如果要访问私有的 GitLab 存储库，则需要将其添加为 .

而已！ 现在，您可以在构建环境中访问私有服务器或存储库.

如果您使用的是 Shell 执行程序而不是 Docker，则设置 SSH 密钥会更加容易.

您可以从安装了 GitLab Runner 的计算机生成 SSH 密钥，并将该密钥用于在该计算机上运行的所有项目.

  1. 首先，登录到运行您的作业的服务器.

  2. 然后，从终端以gitlab-runner用户身份登录：

  4. 作为最后一步，加前面创建要具有从构建环境中的接入服务的一个公共密钥. 如果要访问私有的 GitLab 存储库，则需要将其添加为部署密钥 .

完成后，尝试登录到远程服务器以接受指纹：

要访问 GitLab.com 上的存储库，可以使用git@gitlab.com .

最好检查私有服务器自己的公用密钥，以确保您不会受到中间人攻击的攻击. 万一发生任何可疑事件，您将注意到它，因为作业将失败（如果公钥不匹配，则 SSH 连接将失败）.

要查找服务器的主机密钥，请从受信任的网络（最好是从私有服务器本身）运行命令：

使用SSH_KNOWN_HOSTS作为”密钥”创建一个新 ，并作为”值”添加ssh-keyscan的输出.

注意：如果需要连接到多个服务器，则所有服务器主机密钥都需要收集在变量的Value中，每行一个密钥.提示：通过在.gitlab-ci.yml直接使用变量而不是ssh-keyscan ，这样做的好处是，如果主机域名由于某种原因而更改，则不必更改.gitlab-ci.yml . 而且，这些值是由您预定义的，这意味着如果主机密钥突然更改，CI / CD 作业将失败，并且您将知道服务器或网络出了点问题.

现在已经创建了变量，除了上面.gitlab-ci.yml的之外，还需要添加以下内容：

想要破解吗？ 只需对其进行分叉，提交并推送您的更改. 稍后，公共跑步者将选择更改并开始工作.