From 9d4b36a97cc9eb7f3bfdfa88aecd463a50206c6d Mon Sep 17 00:00:00 2001
From: wy65701436 <wangyan@vmware.com>
Date: Thu, 23 Mar 2017 00:20:18 -0700
Subject: [PATCH] add doc for make

---
 docs/use_make.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 docs/use_make.md

diff --git a/docs/use_make.md b/docs/use_make.md
new file mode 100644
index 000000000..d8fd774cc
--- /dev/null
+++ b/docs/use_make.md
@@ -0,0 +1,51 @@
+### Variables
+Variable           | Description
+-------------------|-------------
+BASEIMAGE          | Container base image, default: photon
+DEVFLAG            | Build model flag, default: dev
+COMPILETAG         | Compile model flag, default: compile_normal (local golang build)
+GOBUILDIMAGE       | Golang image to compile harbor go source code.
+CLARITYIMAGE       | Clarity image that based on Node to compile UI.
+NOTARYFLAG         | Whether to enable notary in harbor, default:false
+HTTPPROXY          | Clarity proxy to build UI.
+
+
+### Targets
+Target              | Description
+--------------------|-------------
+all                 | prepare env, compile binaries, build images and install images 
+prepare             | prepare env
+compile             | compile ui and jobservice code
+compile_ui          | compile ui binary
+compile_jobservice  | compile jobservice binary
+compile_clarity     | compile clarity ui binary
+compile_adminserver | compile admin server binary
+build               | build Harbor docker images (default: using build_photon)
+build_photon        | build Harbor docker images from Photon OS base image
+install             | compile binaries, build images, prepare specific version of compose file and startup Harbor instance
+start               | startup Harbor instance 
+down                | shutdown Harbor instance
+package_online      | prepare online install package
+package_offline     | prepare offline install package
+pushimage           | push Harbor images to specific registry server
+clean all           | remove binary, Harbor images, specific version docker-compose file, specific version tag and online/offline install package
+cleanbinary         | remove ui and jobservice binary
+cleanimage          | remove Harbor images 
+cleandockercomposefile  | remove specific version docker-compose 
+cleanversiontag     | remove specific version tag
+cleanpackage        | remove online/offline install package
+version				 | set harbor version
+
+#### EXAMPLE:
+
+#### Build and run harbor from source code.
+make install GOBUILDIMAGE=golang:1.7.3 COMPILETAG=compile_golangimage CLARITYIMAGE=danieljt/harbor-clarity-base:0.8.4 NOTARYFLAG=true HTTPPROXY=http://proxy.vmware.com:3128
+
+### Package offline installer
+make package_offline GOBUILDIMAGE=golang:1.7.3 COMPILETAG=compile_golangimage CLARITYIMAGE=danieljt/harbor-clarity-base:0.8.4 NOTARYFLAG=true HTTPPROXY=http://proxy.vmware.com:3128
+
+### Start harbor with notary
+make -e NOTARYFLAG=true start
+
+### Stop harbor with notary
+make -e NOTARYFLAG=true down
\ No newline at end of file