AWS S3 Cache

The S3 cache plugin can be used to preserve files and directories between builds. The below pipeline configuration demonstrates simple usage:

kind: pipeline
name: default

steps:
- name: restore
  image: plugins/s3-cache
  settings:
    pull: true
    endpoint: http://minio.company.com
    access_key: myaccesskey
    secret_key: supersecretKey
    restore: true

- name: build
  image: node
  commands:
    - npm install

- name: rebuild
  image: plugins/s3-cache
  settings:
    pull: true
    endpoint: http://minio.company.com
    access_key: myaccesskey
    secret_key: supersecretKey
    rebuild: true
    mount:
      - node_modules
    when:
      event: push

- name: flush
  image: plugins/s3-cache:1
  settings:
    pull: true
    endpoint: http://minio.company.com
    access_key: myaccesskey
    secret_key: supersecretKey
    flush: true
    flush_age: 14

Example configuration using credentials from secrets:

kind: pipeline
name: default

steps:
- name: restore
  image: plugins/s3-cache
  settings:
    pull: true
    endpoint: http://minio.company.com
    access_key:
      from_secret: aws_access_key_id
    secret_key:
      from_secret: aws_secret_access_key
    restore: true

Parameter Reference

endpoint

custom endpoint URL (optional, to use a S3 compatible non-Amazon service)

access_key

amazon access key (optional)

secret_key

amazon secret key (optional)

restore

mode to restore the build environment from cache

rebuild

mode to rebuild the cache from the build environment and specified mounts

flush

mode to flush the cache of old cache items (please be sure to set this so we don’t waste storage)

flush_age

flush cache files older then # days, defaults to 30 (optional)

mount

list of files/directories to cache

debug

enabling more logging for debugging, defaults to false (optional)

filename

filename for the cache (optional)

root

root path prefix for all cache default paths (path, fallback_path, and flush_path), defaults to / (optional)

path

path to store the cache file, defaults to [root]/<owner>/<repo>/<branch>/ (optional)

fallback_path

fallback path for the cache file, defaults to [root]/<owner>/<repo>/<branch>/ (optional)

flush_path

path to search for flushable cache files, defaults to [root]/<owner>/<repo>/ (optional)