Merge pull request #43 from codefresh-io/SAAS-1248

The Makisu plugin

Author: alex-codefresh

README.md

@@ -16,6 +16,7 @@ See each plugin readme for more info and usage instructions.
 | [Run Jenkins Jobs](plugins/run-jenkins-job/README.md)| Run jenkins job from codefresh pipeline| `jenkins` `job`|
 | [Deploy to DCOS](plugins/dcos-app-deploy/README.md) | Deploy application image to DC/OS cluster | `dcos` `deploy` `containers` |
 | [Interact with Jira](plugins/jira/README.md) | Interact with Jira from codefresh pipelines| `jira` `workflow`|
+| [Makisu](plugins/makisu/README.md) | Building images using the Makisu tool | `makisu` `uber`|
 | [release to npm](plugins/release-to-NPM/README.md) | Release npm modules from a pipeline | `npm` |
 | [Twistlock](plugins/cfstep-twistlock) | Security scanning of docker images using Twistlock | `security` |
 | [Clair](plugins/clair/README.md) |  Security scanning of Docker images using Clair | `security` |

plugins/makisu/README.md

@@ -0,0 +1,45 @@
+# Makisu plugin
+
+The plugin makes using [Makisu build tool](https://github.com/uber/makisu) easier in a Codefresh pipeline. 
+
+### Requirements
+
+The plugin requires access to the docker daemon enabled, so one have to request it from Codefresh administrators, unless the user uses a Hybrid solution (running builds on his own infrastructure.
+
+### Basic usage
+
+This example covers the most common case - to build and push an image using Makisu distributed cache and flexible layer generation features.
+
+```
+makisuBuildStep:
+  image: codefresh/cfstep-makisu
+  environment:
+    - REGISTRY_HOSTNAME=docker.io
+    - R_USER=my_username
+    - R_PASSWORD=my_password
+    - IMAGE_NAME_TAG=image/name:tag
+```
+
+By default the makisu context is the main clone directory, but it can be changed with the WORKING_DIRECTORY environment variable. The dockerfile path can also be specified by the DOCKERFILE variable
+
+### Advanced usage
+
+If a user needs more flexibility, it is not a problem to add custom flags to the makisu buildcommand:
+
+```
+....
+  environment:
+    - CUSTOM_FLAGS='--compression=speed ...' 
+```
+
+or to completely override the makisu command:
+
+```
+makisuBuildStep:
+  image: codefresh/cfstep-makisu
+  environment:
+    - REGISTRY_HOSTNAME=docker.io
+    - R_USER=my_username
+    - R_PASSWORD=my_password
+    - MAKISU_COMMAND='makisu build -t myimage/name:tag --storage /codefresh/volume/makisu --modifyfs=true --commit=explicit --registry-config=/makisu-internal/registry-conf.yml --push docker.io --compression=speed .'
+```

plugins/makisu/plugin.yml

@@ -0,0 +1,33 @@
+image: codefresh/cfstep-makisu
+tag: latest
+version: 0.1.0
+description: The plugin makes using Makisu build tool easier in a Codefresh pipeline
+keywords:
+  - makisu
+  - uber
+home: https://github.com/codefresh-contrib/cfstep-makisu
+sources:
+  - https://github.com/codefresh-contrib/cfstep-makisu
+maintainers: # (optional)
+  - name: Alexander Cheshko
+    email: a.cheshko@codefresh.io
+envs:
+  - name: IMAGE_NAME_TAG 
+    type: required
+    description: "Name and tag of the image to build"
+  - name: REGISTRY_HOSTNAME
+    type: required
+    description: "Docker registry host name. Example: docker.io"
+  - name: R_USER
+    type: required
+    description: "User name to authenticate against the registry"
+  - name: R_PASSWORD
+    type: required
+    description: "Password to authenticate against the registry"
+  - name: DOCKERFILE
+  - name: CUSTOM_FLAGS
+    description: "Add custom flags to the makisu build command"
+  - name: MAKISU_COMMAND
+    description: "This is to override the makisu build command"
+  - name: WORKING_DIRECTORY
+    description: "Changes the makisu context directory. Default is the main clone directory"