Configure a Git Repo Artifact Account

This shows how to configure a Git repo artifact account so that Spinnaker can use an entire repo as a single artifact.

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 1.26+ 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 a large repo. 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.

Enable Git Repo artifacts

First, enable artifact support .

Next, enable the Git Repo artifact provider:

  1. hal config artifact gitrepo enable

Configure auth

Choose to set up token, user-password, or ssh key auth.

Token auth

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

  2. Place the token in a file ($TOKEN_FILE) readable by Halyard:

    1. echo $TOKEN > $TOKEN_FILE

  3. Add an artifact account:

    1. hal config artifact gitrepo account add $ARTIFACT_ACCOUNT_NAME \
    2.     --token-file $TOKEN_FILE

User-Password auth

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

    1. <username>:<password>

  2. Add an artifact account:

    1. hal config artifact gitrepo account add $ARTIFACT_ACCOUNT_NAME \
    2.  --username-password-file $PASSWORD_FILE

SSH key auth

Add an artifact account:

  1. hal config artifact gitrepo account add $ARTIFACT_ACCOUNT_NAME \
  2.     --ssh-private-key-file-path $SSH_KEY_FILE \
  3.     --ssh-private-key-passphrase \
  4.     --ssh-known-hosts-file-path $KNOWN_HOSTS_FILE

See the Halyard reference for additional options.

Enable git pull support

Spinnaker version: 1.26+

This feature is disabled by default. To enable git pull support, add the following artifacts section to your clouddriver profile:

  1. spec:
  2.   spinnakerConfig:
  3.     profiles:
  4.       clouddriver:
  5.         artifacts:
  6.           gitrepo:
  7.             clone-retention-minutes: 60
  8.             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.

Last modified May 7, 2021: docs(migration): fix imgs and links (9a18ce6)