build from source locally

README.md

@@ -44,24 +44,30 @@ Or if you use Mac, you can use homebrew to install Helm by `brew install kuberne
 ```bash
 $ git clone https://github.com/pingcap/tidb-docker-compose.git
 $ cd tidb-docker-compose
-$ cp compose/values.yaml values.yaml
-$ vi values.yaml # custom cluster size, docker image, port mapping etc
-$ helm template -f values.yaml compose > generated-docker-compose.yaml
+$ vi compose/values.yaml # custom cluster size, docker image, port mapping etc
+$ helm template compose > generated-docker-compose.yaml
 $ docker-compose -f generated-docker-compose.yaml up -d
 ```
 
 You can build docker image yourself for development test.
 
-* Build locally
+* Build from binary
 
-  For pd, tikv and tidb, leave their `image` field empty and set their `buildFrom` field to `local`. And then copy their binary files to pd/bin/pd-server, tikv/bin/tikv-server and tidb/bin/tidb-server.
-  For tidbVision, leave its `image` field empty and set its `buildFrom` field to `local`. And then copy tidb-vision repo to tidb-vision/tidb-vision.
+  For pd, tikv and tidb, comment their `image` and `buildPath` fields out. And then copy their binary files to pd/bin/pd-server, tikv/bin/tikv-server and tidb/bin/tidb-server.
 
-* Build from remote source
+  These binary files can be built locally or downloaded from https://download.pingcap.org/tidb-latest-linux-amd64.tar.gz
 
-  Leave pd, tikv, tidb and tidbVision `image` field empty and set their `buildFrom` field to `remote`
+  For tidbVision, comment its `image` and `buildPath` fields out. And then copy tidb-vision repo to tidb-vision/tidb-vision.
 
-[tidb-vision](https://github.com/pingcap/tidb-vision) is a visiualization page of TiDB Cluster, it's WIP project and can be disabled by leaving `tidbVision` empty.
+* Build from source
+
+  Leave pd, tikv, tidb and tidbVision `image` field empty and set their `buildPath` field to their source directory.
+
+  For example, if your local tikv source directory is $GOPATH/src/github.com/pingcap/tikv, just set tikv `buildPath` to `$GOPATH/src/github.com/pingcap/tikv`
+
+  *Note:* Compiling tikv from source consumes lots of memory, memory of Docker for Mac needs to be adjusted to greater than 6GB
+
+[tidb-vision](https://github.com/pingcap/tidb-vision) is a visiualization page of TiDB Cluster, it's WIP project and can be disabled by commenting `tidbVision` out.
 
 ### Access TiDB cluster
 

compose/templates/docker-compose.yml

@@ -22,15 +22,8 @@ services:
     {{- else }}
     image: pd:latest
     build:
-      context: ./pd
-      {{- if eq $.Values.pd.buildFrom "remote" }}
-      dockerfile: Dockerfile.src
-      args:
-        repo: {{ $.Values.pd.repo | default "https://github.com/pingcap/pd.git" }}
-        branch: {{ $.Values.pd.branch | default "master" }}
-      {{- else }}
-      dockerfile: Dockerfile.bin
-      {{- end }}
+      context: {{ $.Values.pd.buildPath | default "./pd" }}
+      dockerfile: {{ $.Values.pd.dockerfile | default "Dockerfile" }}
     {{- end }}
     ports:
       - "2379"
@@ -62,17 +55,8 @@ services:
     {{- else }}
     image: tikv:latest
     build:
-      context: ./tikv
-      {{- if eq $.Values.tikv.buildFrom "remote" }}
-      dockerfile: Dockerfile.src
-      args:
-        repo: {{ $.Values.tikv.repo | default "https://github.com/pingcap/tikv.git" }}
-        branch: {{ $.Values.tikv.branch | default "master" }}
-        rustupVersion: {{ $.Values.rustupVersion | default "1.7.0" }}
-        rust_toolchain: {{ $.Values.rustToolChain | default "nightly-2017-08-09" }}
-      {{- else }}
-      dockerfile: Dockerfile.bin
-      {{- end }}
+      context: {{ $.Values.tikv.buildPath | default "./tikv" }}
+      dockerfile: {{ $.Values.tikv.dockerfile | default "Dockerfile" }}
     {{- end }}
     volumes:
       - ./config/tikv.toml:/tikv.toml:ro
@@ -102,15 +86,8 @@ services:
     {{- else }}
     image: tidb:latest
     build:
-      context: ./tidb
-      {{- if eq .Values.tidb.buildFrom "remote" }}
-      dockerfile: Dockerfile.src
-      args:
-        repo: {{ .Values.tidb.repo | default "https://github.com/pingcap/tidb.git" }}
-        branch: {{ .Values.tidb.branch | default "master" }}
-      {{- else }}
-      dockerfile: Dockerfile.bin
-      {{- end }}
+      context: {{ .Values.tidb.buildPath | default "./tidb" }}
+      dockerfile: {{ .Values.tidb.dockerfile | default "Dockerfile" }}
     {{- end }}
     ports:
       {{- if .Values.tidb.mysqlPort }}
@@ -149,15 +126,8 @@ services:
     {{- else }}
     image: tidb-vision:latest
     build:
-      context: ./tidb-vision
-      {{- if eq .Values.tidbVision.buildFrom "remote" }}
-      dockerfile: Dockerfile.remote
-      args:
-        repo: {{ .Values.tidbVision.repo | default "https://github.com/pingcap/tidb-vision.git" }}
-        branch: {{ .Values.tidbVision.branch | default "master" }}
-      {{- else }}
-      dockerfile: Dockerfile.local
-      {{- end }}
+      context: {{ .Values.tidbVision.buildPath | default "./tidb-vision" }}
+      dockerfile: {{ .Values.tidbVision.dockerfile | default "Dockerfile" }}
     {{- end }}
     environment:
       # TODO: we use only one pd endpoint

compose/values.yaml

@@ -3,26 +3,39 @@ data_dir: ./data
 pd:
   size: 3
   image: pingcap/pd:latest
-  # build from local binary or remote source if image is empty
-  buildFrom: local             # local | remote
+
+  # If you want to build pd image from source, leave image empty and specify pd source directory
+  # and its dockerfile name
+  # buildPath: ./pd
+  # dockerfile: Dockerfile
 
 tikv:
   size: 3
   image: pingcap/tikv:latest
-  # build from local binary or remote source if image is empty
-  buildFrom: local             # local | remote
+
+  # If you want to build tikv image from source, leave image empty and specify tikv source directory
+  # and its dockerfile name
+  # buildPath: ./tikv
+  # dockerfile: Dockerfile
 
 tidb:
   image: pingcap/tidb:latest
-  # build from local binary or remote source if image is empty
-  buildFrom: local             # local | remote
+
+  # If you want to build tidb image from source, leave image empty and specify tidb source directory
+  # and its dockerfile name
+  # buildPath: ./tidb
+  # dockerfile: Dockerfile
   mysqlPort: "4000"
   statusPort: "10080"
 
+# comment this out to disable tidb-vision
 tidbVision:
   image: pingcap/tidb-vision:latest
-  # build from local source or remote source if image is empty
-  buildFrom: local              # local | remote
+
+  # If you want to build tidb-vision image from source, leave image empty and specify tidb-vision source directory
+  # and its dockerfile name
+  # buildPath: ./tidb-vision
+  # dockerfile: Dockerfile
   port: "8010"
 
 grafana:
@@ -36,5 +49,7 @@ prometheus:
   image: prom/prometheus:v2.0.0
   port: "9090"
 
+# This is used to import tidb monitor dashboard templates to grafana
+# this container runs only once and keep running until templates imported successfully
 dashboardInstaller:
   image: pingcap/tidb-dashboard-installer:v1.0.0