Repackage the front end to simplify the compilation process

Author: YenchangChan

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "frontend"]
+	path = frontend
+	url = https://github.com/housepower/ckman-fe.git

Makefile

@@ -14,6 +14,13 @@ ARCH=$(shell uname -m)
 TARNAME=${PKGDIR}-${VERSION}-${DATE}.${OS}.$(ARCH).tar.gz
 TAG?=$(shell date +%y%m%d)
 LDFLAGS=-ldflags "-X main.BuildTimeStamp=${TIME} -X main.GitCommitHash=${REVISION} -X main.Version=${VERSION}"
+export GOPROXY=https://goproxy.cn,direct
+
+.PHONY: frontend
+frontend:
+	rm -rf static/dist
+	make -C frontend build
+	cp -r frontend/dist static
 
 .PHONY: backend
 backend:
@@ -28,14 +35,12 @@ backend:
 .PHONY: pre
 pre:
 	go mod tidy
-	go get  github.com/markbates/pkger/cmd/pkger
+	go get github.com/markbates/pkger/cmd/pkger
 	go get github.com/swaggo/swag/cmd/swag
 
 .PHONY: build
-build: pre
-	@rm -rf ${PKGFULLDIR}
-	make -C frontend build
-	pkger
+build:pre
+	@test -d static/dist || (git submodule update --init --recursive && make frontend && pkger)
 	swag init
 	go build ${LDFLAGS}
 	go build ${LDFLAGS} -o ckmanpasswd password/password.go
@@ -45,7 +50,7 @@ build: pre
 	go build ${LDFLAGS} -o purger cmd/purger/purger.go
 
 .PHONY: package
-package:
+package:build
 	@rm -rf ${PKGFULLDIR_TMP}
 	@mkdir -p ${PKGFULLDIR_TMP}/bin ${PKGFULLDIR_TMP}/conf ${PKGFULLDIR_TMP}/run ${PKGFULLDIR_TMP}/logs ${PKGFULLDIR_TMP}/package ${PKGFULLDIR_TMP}/template
 	@mv ${SHDIR}/ckman ${PKGFULLDIR_TMP}/bin
@@ -70,20 +75,20 @@ package:
 .PHONY: docker-build
 docker-build:
 	rm -rf ${PKGDIR}-*.tar.gz
-	docker run --rm -v "$$PWD":/var/ckman -w /var/ckman -e GO111MODULE=on -e GOPROXY=https://goproxy.cn,direct eoitek/ckman-build:go-1.16 make build VERSION=${VERSION} && make package VERSION=${VERSION}
+	docker run --rm -v "$$PWD":/var/ckman -w /var/ckman -e GO111MODULE=on -e GOPROXY=https://goproxy.cn,direct eoitek/ckman-build:go-1.16 make package VERSION=${VERSION}
 
 .PHONY: docker-sh
 docker-sh:
 	docker run --rm  -it -v "$$PWD":/var/ckman -w /var/ckman -e GO111MODULE=on -e GOPROXY=https://goproxy.cn,direct eoitek/ckman-build:go-1.16 bash
 
 .PHONY: rpm
-rpm:
+rpm:build
 	@sed "s/trunk/${VERSION}/g" nfpm.yaml > nfpm_${VERSION}.yaml
 	nfpm -f nfpm_${VERSION}.yaml pkg --packager rpm --target .
 	@rm nfpm_${VERSION}.yaml
 
 .PHONY: deb
-deb:
+deb:build
 	@sed "s/trunk/${VERSION}/g" nfpm.yaml > nfpm_${VERSION}.yaml
 	nfpm -f nfpm_${VERSION}.yaml pkg --packager deb --target .
 	@rm nfpm_${VERSION}.yaml
@@ -103,7 +108,7 @@ test-ci:package
 	@docker-compose down -v
 
 .PHONY: docker-image
-docker-image:
+docker-image:build
 	docker build -t ckman:${VERSION} .
 	docker tag ckman:${VERSION} quay.io/housepower/ckman:${VERSION}
 	docker tag ckman:${VERSION} quay.io/housepower/ckman:latest

README.md

@@ -3,7 +3,6 @@ This is a tool which used to manage and monitor ClickHouse database
 
 ## build command
 ```bash
-make build VERSION=x.x.x
 make package VERSION=x.x.x
 ```
 

docs/Ckman_Document_zh.md

@@ -20,66 +20,17 @@ ckman支持多中心部署，使用nacos进行配置同步，可以对多个集
 
 ## Linux & MacOS下编译
 
-### 编译环境配置
-
-1.  安装Node.js
-
-由于ckman将前端代码静态嵌入到了server中，因此需要安装Node.js以编译前端代码：
-
-MacOS上安装Node.js:
-
-```bash
-brew install node
-```
-
-Linux下安装Node.js:
-
-```bash
-yum install -y nodejs
-```
-
-安装完成后，在frontend目录下执行：
-
-```
-cd frontend
-sudo rm -rf node_modules package-lock.json && npm install
-```
-
-2.  安装`pkger`
-
-```bash
-go get github.com/markbates/pkger/cmd/pkger
-```
-
-3.  安装`swag`
-
-```bash
-go get -u github.com/swaggo/swag/cmd/swag
-```
-
-4.  安装 `nfpm2.2.4`:
-
-`nfpm`是一款用来打包``rpm`的工具，如果不打算做成`rpm`包，可以不安装。
-
-由于`nfpm`新版本配置文件和旧版本差别很大，建议安装指定的`2.2.4`版本。
-
-```
-wget -q https://github.com/goreleaser/nfpm/releases/download/v2.2.4/nfpm_2.2.4_Linux_x86_64.tar.gz
-tar -xzvf nfpm_2.2.4_Linux_x86_64.tar.gz
-cp nfpm /usr/local/bin
-```
-
 ### 编译命令
 
-`Linux`和`MacOS`下编译命令都是一样的：
+`ckman`依赖`golang`(推荐`1.16`)，需要提前安装好, `Linux`和`MacOS`下编译命令都是一样的：
 
 ```bash
 make package VERSION=x.x.x   
 ```
 
 以上命令会编译成打包成一个`tar.gz`安装包，该安装包解压即可用。
 
-`VERSION`是指定的版本号，如果不指定，则默认生成一个版本号为`trunk`的版本。
+`VERSION`是指定的版本号，如果不指定，则默认取`git describe --tags --dirty`的结果作为版本号。
 
 ### rpm编译
 
@@ -112,7 +63,11 @@ make rpm VERSION=x.x.x
 
 # ckman安装部署
 
-`ckman`部署分为`rpm`包安装和`tar.gz`包安装。其实只是提供的安装包不一样，实际安装还是一样的。
+## 部署依赖
+- `prometheus`(非必需)
+- `node_exporter`(非必需)
+- `nacos`(>`1.4`，目前不支持`2.0`)(非必需)
+- `zookeeper`(>`3.5.0`, 推荐 )
 
 ## rpm安装