From f41fcdeeb496de1d84bd5633dcc8ced16937cc44 Mon Sep 17 00:00:00 2001 From: wangyan Date: Sun, 16 Apr 2017 05:44:19 -0700 Subject: [PATCH] update compile document update makefile update per comments update document --- Makefile | 2 +- docs/compile_guide.md | 72 ++++++++++++++-------------- make/dev/docker-compose-clarity.yml | 7 --- make/dev/docker-compose.yml | 73 +++++++++++++++++++---------- make/dev/ui/Dockerfile | 7 ++- make/docker-compose-clarity.yml | 9 ---- 6 files changed, 87 insertions(+), 83 deletions(-) delete mode 100644 make/dev/docker-compose-clarity.yml delete mode 100644 make/docker-compose-clarity.yml diff --git a/Makefile b/Makefile index 6b6bf5bd9..6faa7dc65 100644 --- a/Makefile +++ b/Makefile @@ -88,7 +88,7 @@ MARIADBVERSION=mariadb-10.1.10 HTTPPROXY= #clarity parameters -CLARITYIMAGE=danieljt/harbor-clarity-base[:tag] +CLARITYIMAGE=vmware/harbor-clarity-ui-builder[:tag] CLARITYSEEDPATH=/clarity-seed CLARITYBUILDSCRIPT=/entrypoint.sh diff --git a/docs/compile_guide.md b/docs/compile_guide.md index 7459a97d0..664a850d2 100644 --- a/docs/compile_guide.md +++ b/docs/compile_guide.md @@ -1,21 +1,21 @@ ## Introduction -This guide provides instructions for developers to build and run Harbor from source code. +This guide provides instructions for developers to build and run Harbor from source code. ## Step 1: Prepare for a build environment for Harbor -Harbor is deployed as several Docker containers and most of the code is written in Go language. The build host requires Python, Docker, Docker Compose and golang development environment. Please install the below prerequisites: +Harbor is deployed as several Docker containers and most of the code is written in Go language. The build environment requires Python, Docker, Docker Compose and golang development environment. Please install the below prerequisites: Software | Required Version ----------------------|-------------------------- -docker | 1.10.0 + -docker-compose | 1.7.1 + +docker | 1.13.1 + +docker-compose | 1.11.1 + python | 2.7 + git | 1.9.1 + make | 3.81 + -golang* | 1.6.0 + - *optional +golang* | 1.7.3 + +*optional, required only if you use your own Golang environment. ## Step 2: Getting the source code @@ -28,13 +28,13 @@ golang* | 1.6.0 + ### Configuration -Edit the file **make/harbor.cfg** and make necessary configuration changes such as hostname, admin password and mail server. Refer to **[Installation and Configuration Guide](installation_guide.md#configuring-harbor)** for more info. +Edit the file **make/harbor.cfg** and make necessary configuration changes such as hostname, admin password and mail server. Refer to **[Installation and Configuration Guide](installation_guide.md#configuring-harbor)** for more info. ```sh $ cd harbor $ vi make/harbor.cfg ``` - + ### Compiling and Running You can compile the code by one of the three approaches: @@ -47,10 +47,16 @@ You can compile the code by one of the three approaches: $ docker pull golang:1.7.3 ``` -* Build, install and bring up Harbor: +* Build, install and bring up Harbor without Notary: ```sh - $ make install -e GOBUILDIMAGE=golang:1.7.3 COMPILETAG=compile_golangimage + $ make install GOBUILDIMAGE=golang:1.7.3 COMPILETAG=compile_golangimage CLARITYIMAGE=vmware/harbor-clarity-ui-builder:0.8.4 + ``` + +* Build, install and bring up Harbor with Notary: + + ```sh + $ make install GOBUILDIMAGE=golang:1.7.3 COMPILETAG=compile_golangimage CLARITYIMAGE=vmware/harbor-clarity-ui-builder:0.8.4 NOTARYFLAG=true ``` #### II. Compile code with your own Golang environment, then build Harbor @@ -63,40 +69,27 @@ You can compile the code by one of the three approaches: $ mv harbor $GOPATH/src/github.com/vmware/. ``` -* Build, install and run Harbor +* Build, install and run Harbor without Notary: ```sh $ cd $GOPATH/src/github.com/vmware/harbor $ make install ``` - -#### III. Manual build process (compatible with previous versions) + +* Build, install and run Harbor with Notary: ```sh - $ cd make - - $ ./prepare - Generated configuration file: ./config/ui/env - Generated configuration file: ./config/ui/app.conf - Generated configuration file: ./config/registry/config.yml - Generated configuration file: ./config/db/env - ... - - $ cd dev - - $ docker-compose up -d - ``` + $ cd $GOPATH/src/github.com/vmware/harbor + $ make install -e NOTARYFLAG=true + ``` ### Verify your installation -If everyting worked properly, you can get the below message: +If everything worked properly, you can get the below message: ```sh ... - ----Harbor has been installed and started successfully.---- - - Now you should be able to visit the admin portal at http://$YOURIP. - For more details, please visit https://github.com/vmware/harbor . + Start complete. You can visit harbor now. ``` Refer to [Installation and Configuration Guide](installation_guide.md#managing-harbors-lifecycle) for more information about managing your Harbor instance. @@ -109,8 +102,11 @@ The `Makefile` contains these configurable parameters: Variable | Description -------------------|------------- BASEIMAGE | Container base image, default: photon +CLARITYIMAGE | Clarity UI builder image, default: harbor-clarity-ui-builder DEVFLAG | Build model flag, default: dev COMPILETAG | Compile model flag, default: compile_normal (local golang build) +NOTARYFLAG | Notary mode flag, default: false +HTTPPROXY | NPM http proxy for Clarity UI builder REGISTRYSERVER | Remote registry server IP address REGISTRYUSER | Remote registry server user name REGISTRYPASSWORD | Remote registry server user password @@ -120,23 +116,24 @@ REGISTRYPROJECTNAME| Project name on remote registry server Target | Description --------------------|------------- -all | prepare env, compile binaries, build images and install images +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 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 +start | startup Harbor instance (set NOTARYFLAG=true when with Notary) +down | shutdown Harbor instance (set NOTARYFLAG=true when with Notary) 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 +cleanimage | remove Harbor images +cleandockercomposefile | remove specific version docker-compose cleanversiontag | remove specific version tag cleanpackage | remove online/offline install package @@ -163,7 +160,7 @@ cleanpackage | remove online/offline install package $ make clean -e VERSIONTAG=[TAG] ``` - **Note**: If new code had been added to Github, the git commit TAG will change. Better use this command to clean up images and files of previous TAG. + **Note**: If new code had been added to Github, the git commit TAG will change. Better use this command to clean up images and files of previous TAG. #### By default, the make process create a development build. To create a release build of Harbor, set the below flag to false. @@ -171,4 +168,3 @@ cleanpackage | remove online/offline install package $ make XXXX -e DEVFLAG=false ``` - diff --git a/make/dev/docker-compose-clarity.yml b/make/dev/docker-compose-clarity.yml deleted file mode 100644 index 8e239fe54..000000000 --- a/make/dev/docker-compose-clarity.yml +++ /dev/null @@ -1,7 +0,0 @@ -version: '2' -services: - nodeclarity: - image : danieljt/harbor-clarity-base:0.8.1 - volumes: - - ../../src/ui/static/new-ui:/clarity-seed/dist - - ../../src/ui_ng:/clarity-seed diff --git a/make/dev/docker-compose.yml b/make/dev/docker-compose.yml index f99224b92..3b1b80906 100644 --- a/make/dev/docker-compose.yml +++ b/make/dev/docker-compose.yml @@ -4,17 +4,23 @@ services: build: context: ../../ dockerfile: make/photon/log/Dockerfile + container_name: harbor-log restart: always volumes: - - /var/log/harbor/:/var/log/docker/ + - /var/log/harbor/:/var/log/docker/:z ports: - - 1514:514 + - 127.0.0.1:1514:514 + networks: + - harbor registry: - image: library/registry:2.6.0 + image: vmware/registry:photon-2.6.0 + container_name: registry restart: always volumes: - - /data/registry:/storage - - ../common/config/registry/:/etc/registry/ + - /data/registry:/storage:z + - ./common/config/registry/:/etc/registry/:z + networks: + - harbor environment: - GODEBUG=netdns=cgo command: @@ -23,89 +29,105 @@ services: - log logging: driver: "syslog" - options: + options: syslog-address: "tcp://127.0.0.1:1514" tag: "registry" mysql: build: ../common/db/ + container_name: harbor-db restart: always volumes: - - /data/database:/var/lib/mysql + - /data/database:/var/lib/mysql:z + networks: + - harbor env_file: - ../common/config/db/env depends_on: - log logging: driver: "syslog" - options: + options: syslog-address: "tcp://127.0.0.1:1514" tag: "mysql" adminserver: build: context: ../../ dockerfile: make/dev/adminserver/Dockerfile + container_name: harbor-adminserver env_file: - ../common/config/adminserver/env restart: always volumes: - - /data/config/:/etc/adminserver/config/ - - /data/secretkey:/etc/adminserver/key - - /data/:/data/ + - /data/config/:/etc/adminserver/config/:z + - /data/secretkey:/etc/adminserver/key:z + - /data/:/data/:z depends_on: - log + networks: + - harbor logging: driver: "syslog" - options: + options: syslog-address: "tcp://127.0.0.1:1514" tag: "adminserver" ui: build: context: ../../ dockerfile: make/dev/ui/Dockerfile + container_name: harbor-ui env_file: - ../common/config/ui/env restart: always volumes: - - ../common/config/ui/app.conf:/etc/ui/app.conf - - ../common/config/ui/private_key.pem:/etc/ui/private_key.pem - - /data/secretkey:/etc/ui/key - - /data/ca_download/:/etc/ui/ca/ + - ./common/config/ui/app.conf:/etc/ui/app.conf:z + - ./common/config/ui/private_key.pem:/etc/ui/private_key.pem:z + - /data/secretkey:/etc/ui/key:z + - /data/ca_download/:/etc/ui/ca/:z + networks: + - harbor depends_on: - log - adminserver - registry logging: driver: "syslog" - options: + options: syslog-address: "tcp://127.0.0.1:1514" tag: "ui" jobservice: build: context: ../../ dockerfile: make/dev/jobservice/Dockerfile + container_name: harbor-jobservice env_file: - ../common/config/jobservice/env restart: always volumes: - - /data/job_logs:/var/log/jobs - - ../common/config/jobservice/app.conf:/etc/jobservice/app.conf - - /data/secretkey:/etc/jobservice/key + - /data/job_logs:/var/log/jobs:z + - ./common/config/jobservice/app.conf:/etc/jobservice/app.conf:z + - /data/secretkey:/etc/jobservice/key:z + networks: + - harbor depends_on: - ui - adminserver logging: driver: "syslog" - options: + options: syslog-address: "tcp://127.0.0.1:1514" tag: "jobservice" proxy: - image: library/nginx:1.11.5 + image: vmware/nginx:1.11.5-patched + container_name: nginx restart: always volumes: - - ../common/config/nginx:/etc/nginx + - ./common/config/nginx:/etc/nginx:z + networks: + - harbor ports: - 80:80 - 443:443 + - 4443:4443 depends_on: - mysql - registry @@ -113,6 +135,9 @@ services: - log logging: driver: "syslog" - options: + options: syslog-address: "tcp://127.0.0.1:1514" tag: "proxy" +networks: + harbor: + external: false diff --git a/make/dev/ui/Dockerfile b/make/dev/ui/Dockerfile index f2d965b4e..47f24c954 100644 --- a/make/dev/ui/Dockerfile +++ b/make/dev/ui/Dockerfile @@ -7,14 +7,13 @@ WORKDIR /go/src/github.com/vmware/harbor/src/ui RUN go build -v -a -o /go/bin/harbor_ui -ENV MYSQL_USR root \ - MYSQL_PWD root \ - REGISTRY_URL localhost:5000 - COPY src/ui/views /go/bin/views COPY src/ui/static /go/bin/static COPY src/favicon.ico /go/bin/favicon.ico +RUN mkdir /go/bin/harbor/ +COPY VERSION /go/bin/harbor/VERSION + RUN chmod u+x /go/bin/harbor_ui WORKDIR /go/bin/ diff --git a/make/docker-compose-clarity.yml b/make/docker-compose-clarity.yml deleted file mode 100644 index da624079d..000000000 --- a/make/docker-compose-clarity.yml +++ /dev/null @@ -1,9 +0,0 @@ -version: '2' -services: - nodeclarity: - image : danieljt/harbor-clarity-base:0.8.0 - volumes: - - ../src/ui/static/new-ui:/clarity-seed/dist - - ../src/ui_ng/src/app:/clarity-seed/src/app - depends_on: - - ui