如何通过SSH为Gitlab运行器启用克隆?

时间:2016-08-29 14:13:29

标签: git ssh gitlab gitlab-ci gitlab-ci-runner

我在Windows Gitlab运行器上通过HTTP克隆大型存储库时遇到了一些麻烦。我尝试了几种方法来做浅克隆或禁用克隆压缩。仍然没有运气。

通过SSH克隆相同的存储库非常适合作为临时解决方案,我希望在我们的Gitlab CI过程中使用它。

现在的问题在于我不知道如何使用SSH作为gitlab-multi-runner的克隆方法。它似乎只是使用HTTP作为默认值,我唯一关于克隆的选项是它是完成克隆还是获取。

CI/CD Display

有人可以解释我如何通过SSH而不是HTTP来获取克隆/抓取功能吗?

Gitlab版本:GitLab社区版8.10.7

谢谢!

4 个答案:

答案 0 :(得分:4)

根据:

https://docs.gitlab.com/ee/ci/ssh_keys/README.html

你需要:

  1. 使用ssh-keygen
  2. 创建新的SSH密钥对
  3. 将私钥作为秘密变量添加到项目
  4. 在作业期间运行ssh-agent以加载私钥。
  5. 示例gitlab_ci.yml:

    before_script:
      # Install ssh-agent if not already installed, it is required by Docker.
      # (change apt-get to yum if you use a CentOS-based image)
      - 'which ssh-agent || ( apt-get update -y && apt-get install openssh-client -y )'
    
      # Run ssh-agent (inside the build environment)
      - eval $(ssh-agent -s)
    
      # Add the SSH key stored in SSH_PRIVATE_KEY variable to the agent store
      - ssh-add <(echo "$SSH_PRIVATE_KEY")
    
      # For Docker builds disable host key checking. Be aware that by adding that
      # you are suspectible to man-in-the-middle attacks.
      # WARNING: Use this only with the Docker executor, if you use it with shell
      # you will overwrite your user's SSH config.
      - mkdir -p ~/.ssh
      - '[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config'
      # In order to properly check the server's host key, assuming you created the
      # SSH_SERVER_HOSTKEYS variable previously, uncomment the following two lines
      # instead.
      # - mkdir -p ~/.ssh
      # - '[[ -f /.dockerenv ]] && echo "$SSH_SERVER_HOSTKEYS" > ~/.ssh/known_hosts'
    

答案 1 :(得分:4)

作为gitlab的新手,我已经成功解决了这个问题,因为我还没有找到更改默认克隆过程的内置方法(虽然here is a recent comment about how it can be done

通过disabling the automatic cloning process,只需在before_script中编写自己的克隆过程,即可完全有效地覆盖其行为。仅出于示例的目的,下面显示了如何为HTTP克隆实现此目的,但可以适用于ssh克隆(if you're trying to use HTTP cloning you should use the built-in cloning process and the config.toml):

  1. 创建一个名为&#34; gitlab-runner&#34;的新用户并生成他们的用户身份验证令以供以后使用(或者在您的情况下,您将生成ssh密钥)。

  2. 通过在项目或组设置中添加以下变量来停止跑步者的克隆过程:.../settings/ci_cd

    键:GIT_STRATEGY

    值:无

  3. before_script中克隆您的回购,例如:

  4. before_script:
      ## clean the working directory
      - BUILD_DIR=/home/gitlab-runner/builds/$RUNNER_TOKEN/0
      - CLONE_DIR="$BUILD_DIR/$CI_PROJECT_PATH"
      - cd $BUILD_DIR
      - rm -rf $CLONE_DIR
      - mkdir -p $CLONE_DIR
    
      ## clone the project each time (inefficient, consider performing fetch instead if it already exists)
      - git clone http://gitlab-runner:$GITLABRUNNER_USER_AUTH_TOKEN@server:8888/${CI_PROJECT_PATH}.git $CLONE_DIR
      - cd $CLONE_DIR
    

    注意:以下是我在步骤2中配置的相关变量,而不是在脚本中对它们进行硬编码:

    • RUNNER_TOKEN:&#34; Runner Token&#34; Admin&#34; Runners&#34;中列出的值您尝试运行的特定跑步者的菜单。
    • GITLABRUNNER_USER_AUTH_TOKEN:这是您在步骤1中生成的身份验证令牌。

答案 2 :(得分:1)

我有一个类似的问题,需要通过ssh进行克隆:将virtualbox执行程序与非常老的来宾linux操作系统一起使用。我可以通过做一些小的配置更改来解决它:

  1. 创建一个deploy key用于访问项目。

  2. 强制执行克隆的用户帐户使用部署密钥。在我的virtualbox情况下,我为virtualbox中为/etc/gitlab-runnner/config.toml配置的用户修改了ssh配置。

〜/ .ssh / config

Host gitlab.example.com
  Preferredauthentications publickey
  IdentityFile ~/.ssh/deploy-key
  1. 配置运行程序以通过/etc/config.toml中的ssh执行克隆。

/etc/config.toml

[[runners]]

  # [...]

  environment = ["GIT_STRATEGY=none"]
  pre_build_script = '''
    # Fetching using ssh (via pre_build_script in config.toml)
    if [ -d "${CI_PROJECT_DIR}" ]; then rm -rf "${CI_PROJECT_DIR}"; fi
    mkdir -p "${CI_PROJECT_DIR}"
    cd "${CI_PROJECT_DIR}"
    git init
    git remote add origin "ssh://git@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git"
    git fetch origin "${CI_COMMIT_SHA}"
    git reset --hard FETCH_HEAD
  '''

  # [...]

以下是config.toml新增内容的细分:

  • GIT_STRATEGY=none环境变量禁用运行程序的内部git克隆机制。 (请参阅CI / CD参考的Git Strategy部分)
  • pre_build_script使用predefined CI/CD environment variables执行实际的克隆。就我而言,这是一个bash脚本,用于执行类似于GIT_STRATEGY=fetch可能执行的操作。
  • 如果pre_build_script是多行,则运行器的输出将仅显示第一行。在第一行添加注释有助于提高跑步者输出的清晰度。
  • 此处未使用
  • pre_clone_script。由于设置了环境GIT_STRATEGY=none,因此已将其禁用。

答案 3 :(得分:1)

这对我有用,将其添加到您的 .gitlab-ci.yml 中

script:
  - git remote set-url --push origin git@$CI_SERVER_HOST:$CI_PROJECT_PATH.git

这将在 .git/config 文件中设置您的推送 url,运行程序将使用它,同时将代码推送回您的 git repo,而不是使用 ci-token 的 url。