codeship/ssh-helper

Codeship SSH辅助镜像

这是一个辅助镜像，旨在简化在Codeship Pro上使用SSH密钥的过程。它允许您轻松生成新的SSH密钥对、创建（未加密的）环境文件，并在Codeship Pro构建过程中将密钥写回文件。

本地构建

要在本地构建镜像，请克隆仓库并在本地副本目录中运行以下命令：

shell
docker build -t codeship/ssh-helper .

稍后我们也将通过Docker Hub提供该镜像。

生成新SSH密钥

以下命令将创建新的SSH密钥并将文件写入当前目录。私钥文件名为codeship_deploy_key，公钥文件名为codeship_deploy_key.pub。

shell
docker run -it --rm -v $(pwd):/keys/ codeship/ssh-helper generate "<您的邮箱>"

您的***地址会通过注释添加到密钥中，以便于识别密钥创建者。

此外，该工具具有较强的预设性，目前不允许更改密钥的任何参数或密钥写入的文件。所有其他命令也依赖这些文件，因此不建议自行重命名文件。

生成的密钥是4096位RSA密钥，无密码短语。因此，请确保私钥不会提交到仓库或分享给未授权访问资源的人员。

准备环境文件

以下命令将获取私钥（命名为codeship_deploy_key）并将其格式化为可传递给Codeship Pro构建（或jet CLI）的环境变量。强烈建议通过jet encrypt加密该值。

shell
docker run -it --rm -v $(pwd):/keys/ codeship/ssh-helper prepare

生成的文件将名为codeship.env，如果该文件已存在，值将被追加。

将环境变量写回文件

在Codeship Pro构建过程中，您需要将环境变量写回文件，以传递给ssh（或类似）命令。

shell
docker run -it --rm -v $(pwd):/keys/ --env-file codeship.env codeship/ssh-helper write

这是一种本地测试功能的方法。它将使用“准备”步骤中的环境文件，将私有SSH密钥写入名为id_rsa的文件。您可以通过运行diff ./.ssh/id_rsa ./codeship_deploy_key来检查此文件是否与“生成”步骤中生成的密钥相同。

在常规的Codeship Pro构建中，您需要在构建开始时运行一个步骤，将文件写入卷，然后在后续需要访问私钥的步骤中挂载该卷。类似以下配置片段：

yaml
# codeship-services.yml
ssh:
  image: codeship/ssh-helper
  encrypted_env_file: codeship.env.encrypted
  volumes:
    - ./:/keys/
deployment:
  image: codeship/ssh-helper
  volumes:
    - .ssh:/root/.ssh
    - .:/app

yaml
# codeship-steps.yml
- name: 写入私有SSH密钥
  service: ssh
  command: write
- name: 复制文件
  service: deployment
  command: scp -r /app/ user@myserver.com:app/
- name: 重启服务器
  service: deployment
  command: ssh user@myserver.com restart_server

贡献

我们欢迎您的反馈。在提交拉取请求或创建工单之前，请阅读我们的贡献指南和行为准则。

许可证

参见https://github.com/codeship-library/docker-utilities/blob/master/ssh-helper/LICENSE