DOCS.md

Description

This plugin enables you to build and publish Docker images in a Vela pipeline.

Source Code: https://github.com/go-vela/vela-makisu

Registry: https://hub.docker.com/r/target/vela-makisu

Deprecation Warning

As of May 2021, makisu has been deprecated by the maintainers upstream. Therefore, this plugin will also be deprecated and not receive updates. It is suggested to use a different docker option. At an undecided later date it will be removed entirely.

uber-archive/makisu#365

Usage

NOTE: It is not recommended to use latest as the tag for the Docker image. Users should use a semantically versioned tag instead.

Sample of building and publishing an image:

steps:
  - name: publish_hello-world
    image: target/vela-makisu:latest
    pull: always
    parameters:
      registry: index.docker.io
      tag: index.docker.io/octocat/hello-world
      pushes: [ index.docker.io ]

Sample of building an image without publishing:

steps:
  - name: publish hello world
    image: target/vela-makisu:latest
    pull: always
    parameters:
-     pushes: [ index.docker.io ]
      registry: index.docker.io
      tag: index.docker.io/octocat/hello-world:latest

Sample of building and publishing an image with custom tags:

steps:
  - name: publish hello world
    image: target/vela-makisu:latest
    pull: always
    parameters:
      registry: index.docker.io
      tag: index.docker.io/octocat/hello-world:latest
      pushes: [ index.docker.io ]
+     replicas:
+       - index.docker.io/octocat/hello-world:1
+       - index.docker.io/octocat/hello-world:foobar

Sample of building and publishing an image with build arguments:

steps:
  - name: publish hello world
    image: target/vela-makisu:latest
    pull: always
    parameters:
+     build_args:
+       - FOO=bar
      registry: index.docker.io
      tag: index.docker.io/octocat/hello-world
      pushes: [ index.docker.io ]

Sample of building and publishing an image with redis caching:

steps:
  - name: publish_hello-world
    image: target/vela-makisu:latest
    pull: always
    parameters:
+     redis_cache_options: 
+       addr: redis.company.com
+       password: superSecretPassword
+       ttl: 7d
      registry: index.docker.io
      repo: index.docker.io/octocat/hello-world
      pushes: [ index.docker.io ]

Secrets

NOTE: Users should refrain from configuring sensitive information in your pipeline in plain text.

You can use Vela secrets to substitute sensitive values at runtime:

steps:
  - name: publish_hello-world
    image: target/vela-makisu:latest
    pull: always
+   secrets: [ docker_username, docker_password, redis_cache ]
    parameters:
      registry: index.docker.io
      repo: index.docker.io/octocat/hello-world
      pushes: [ index.docker.io ]
-     redis_cache: 
-       addr: redis.company.com
-       password: superSecretPassword
-       ttl: 7d      
-     username: octocat
-     password: superSecretPassword

Parameters

NOTE:

• the plugin supports reading all parameters via environment variables or files
• values set from a file take precedence over values set from the environment

The following parameters are used to configure the build and push process:

Name	Description	Required	Default
build_args	build time arguments for the Dockerfile	false	N/A
commit	commit info for #!COMMIT annotations	false	N/A
compression	compression on the tar file built - options: (no	speed	size
context	the context for the image to be built	false	.
deny_list	list of locations to be ignored within docker image	false	N/A
docker	configuration on the docker daemon	false	N/A
destination	the output of the tar file	false	N/A
file	a the absolute path to dockerfile	false	info
http_cache	custom http options caching	false	N/A
load	enables loading a docker image into the docker daemon post build	false	N/A
local_cache_ttl	a time to live for the local docker cache (default 168h0m0s)	false	N/A
modify_fs	makisu to modify files outside its internal storage directories	false	N/A
preserve_root	copying storage from root in the storage during and after build	false	N/A
pushes	registries to push the image to	false	N/A
redis_cache	custom redis server for caching	false	N/A
replicas	pushing image to alternative targets i.e. <registry>/<repo>:<tag>	false	N/A
storage	a directory for makisu to use for temp files and cached layers	false	N/A
tag	the tag for an image	true	N/A
storage	the target build stage to build	false	N/A

The following parameters are used to configure the registry:

Name	Description	Required	Default
mirror	name of the mirror registry to use	false	N/A
password	password for communication with the registry	true	N/A
registry	name of the registry for the repository	true	index.docker.io
repo	name of the repository for the image	true	N/A
username	user name for communication with the registry	true	N/A

Template

COMING SOON!

Troubleshooting

Below are a list of common problems and how to solve them: