Configure a Git Repo Artifact Account

Overview

Each time a pipeline needs a Git repo artifact during execution, Clouddriver clones the entire repo, sends the repo artifact to the pipeline, and then deletes the cloned repo immediately.

Spinnaker includes a feature for caching a Git repo artifact. Clouddriver clones the Git repo the first time a pipeline needs it and then caches the repo for a configured retention time. Each subsequent time the pipeline needs to use that Git repo artifact, Clouddriver does a git pull to fetch updates rather than cloning the entire repo again. This behavior is especially useful if you have large repositories. Clouddriver deletes the cloned Git repo when the configured retention time expires.
This is an opt-in feature that is disabled by default. See the Enable <code>git pull</code> support section for details.

Prerequisites

• You need a Git account.

Download credentials

Token auth

Generate an access token for your Git provider (eg, GitHub or GitLab ). The token requires the repo scope.

User-Password auth

1. Create a username-password file, with contents in the following format:

   <username>:<password>
   

SSH key auth

Create an SSH key for your user or add to the ssh allowed keys configuration.

Store the credentials for user

Add the credentials either to a secrets manager for use by reference or to a volume mounted into the clouddriver pods by modifying the deployment.yaml for clouddriver.

Add the account and enable it with one of the auth options

artifacts:
  enabled: true
  gitrepo:
    enabled: true
    accounts:
    - name: my-git-account
      username: git
      password: password
      tokenFile: /mnt/someplace/tokenFile
      sshPrivateKeyFilePath: SSH_KEY_FILE
      sshPrivateKeyPassphrase: somePassPhrase
      sshPrivateKeyPassphraseCmd: <some command>
      sshKnownHostsFilePath: KNOWN_HOSTS_FILE
      sshTrustUnknownHosts: false

Enable git pull caching support

This feature is disabled by default. To enable git pull support, add the following section to your clouddriver-local.yml file:

artifacts:
  enabled: true
  gitrepo:
    enabled: true
    clone-retention-minutes: 60
    clone-retention-max-bytes: 104857600

• clone-retention-minutes: Default: 0. How much time to keep clones. Values are:
  • 0: no retention.
  • -1: retain forever.
  • any whole number of minutes, such as 60.
• clone-retention-max-bytes: Default: 104857600 (100 MB). Maximum amount of disk space to use for clones. When the maximum amount of space is reached, Clouddriver deletes the clones after returning the artifact to the pipeline, just as if retention were disabled.

Other options

See the GitRepo Artifact Account code for additional options.