Merge remote-tracking branch 'upstream/master'

Deploy/docker-compose.yml

@@ -1,10 +1,12 @@
-log:
+version: '2'
+services:
+  log:
     build: ./log/
     volumes:
       - /var/log/harbor/:/var/log/docker/
     ports:
       - 1514:514
-registry:
+  registry:
     image: library/registry:2.3.0
     volumes:
       - /data/registry:/storage
@@ -13,50 +15,53 @@ registry:
       - 5001:5001
     command:
       /etc/registry/config.yml
-  links:
+    depends_on:
       - log
-  log_driver: "syslog"
+    logging:
-  log_opt:
+      driver: "syslog"
+      options:  
         syslog-address: "tcp://127.0.0.1:1514"
         syslog-tag: "registry"
-mysql:
+  mysql:
     build: ./db/
     volumes:
       - /data/database:/var/lib/mysql
     env_file:
       - ./config/db/env
-  links:
+    depends_on:
       - log
-  log_driver: "syslog"
+    logging:
-  log_opt:
+      driver: "syslog"
+      options:  
         syslog-address: "tcp://127.0.0.1:1514"
         syslog-tag: "mysql"
-ui:
+  ui:
     build: ../
     env_file:
       - ./config/ui/env
     volumes:
       - ./config/ui/app.conf:/etc/ui/app.conf
       - ./config/ui/private_key.pem:/etc/ui/private_key.pem
-  links:
+    depends_on:
-    - registry
-    - mysql
       - log
-  log_driver: "syslog"
+    logging:
-  log_opt:
+      driver: "syslog"
+      options:  
         syslog-address: "tcp://127.0.0.1:1514"
         syslog-tag: "ui"
-proxy:
+  proxy:
     image: library/nginx:1.9
     volumes:
       - ./config/nginx:/etc/nginx
-  links:
-    - ui
-    - registry
-    - log
     ports:
       - 80:80
-  log_driver: "syslog"
+    depends_on:
-  log_opt:
+      - mysql
+      - registry
+      - ui
+      - log
+    logging:
+      driver: "syslog"
+      options:  
         syslog-address: "tcp://127.0.0.1:1514"
         syslog-tag: "proxy"

Deploy/harbor.cfg

@@ -1,25 +1,34 @@
-## CONFIGURATIONS 
+## Configuration file of Harbor
-#The endpoint for user to access UI and registry service
+
-hostname = mydomain.com
+#The IP address or hostname to access admin UI and registry service.
-#The protocol for accessing the UI and token/notification service, by default it is http
+#DO NOT use localhost or 127.0.0.1, because Harbor needs to be accessed by external clients.
-#User can set it to https if ssl is setup on nginx
+hostname = reg.mydomain.com
+
+#The protocol for accessing the UI and token/notification service, by default it is http.
+#It can be set to https if ssl is enabled on nginx.
 ui_url_protocol = http
-#Email settings for ui to send password resetting emails
+
+#Email account settings for sending out password resetting emails.
 email_server = smtp.mydomain.com 
 email_server_port = 25
 email_username = sample_admin@mydomain.com
 email_password = abc
 email_from = admin <sample_admin@mydomain.com>
-##The password of harbor admin
+
+##The password of Harbor admin, change this before any production use.
 harbor_admin_password= Harbor12345
-##By default the auth mode is db_auth, i.e. the creadentials are stored in a databse
+
-#please set it to ldap_auth if you want to verify user's credentials against an ldap server.
+##By default the auth mode is db_auth, i.e. the credentials are stored in a local database.
+#Set it to ldap_auth if you want to verify a user's credentials against an LDAP server.
 auth_mode = db_auth
-#The url for ldap endpoint
+
+#The url for an ldap endpoint.
 ldap_url = ldaps://ldap.mydomain.com
-#The basedn template for verifying the user's password
+
+#The basedn template to look up a user in LDAP and verify the user's password.
 ldap_basedn = uid=%s,ou=people,dc=mydomain,dc=com
-#The password for root user of db
+
+#The password for the root user of mysql db, change this before any production use.
 db_password = root123
 #Switch for self-registration feature
 self_registration = on

Deploy/prepare

@@ -61,6 +61,7 @@ for f in conf_files:
 render(os.path.join(templates_dir, "ui", "env"),
         ui_conf_env,
         hostname=hostname,
+        db_password=db_password,
         ui_url=ui_url,
         auth_mode=auth_mode,
         admin_pwd=harbor_admin_password,

Deploy/templates/registry/config.yml

@@ -27,7 +27,7 @@ notifications:
   endpoints:
       - name: harbor
         disabled: false
-        url: $ui_url/service/notifications
+        url: http://ui/service/notifications
         timeout: 500
         threshold: 5
         backoff: 1000

Deploy/templates/ui/env

@@ -1,5 +1,7 @@
 MYSQL_HOST=mysql
+MYSQL_PORT=3306
 MYSQL_USR=root
+MYSQL_PWD=$db_password
 REGISTRY_URL=http://registry:5000
 CONFIG_PATH=/etc/ui/app.conf
 HARBOR_REG_URL=$hostname

dao/base.go

@@ -66,18 +66,11 @@ func GenerateRandomString() (string, error) {
 func InitDB() {
 	orm.RegisterDriver("mysql", orm.DRMySQL)
 	addr := os.Getenv("MYSQL_HOST")
-	if len(addr) == 0 {
+	port := os.Getenv("MYSQL_PORT")
-		addr = os.Getenv("MYSQL_PORT_3306_TCP_ADDR")
-	}
-
-	port := os.Getenv("MYSQL_PORT_3306_TCP_PORT")
 	username := os.Getenv("MYSQL_USR")
+	password := os.Getenv("MYSQL_PWD")
 
-	password := os.Getenv("MYSQL_ENV_MYSQL_ROOT_PASSWORD")
+	log.Debugf("db url: %s:%s, db user: %s", addr, port, username)
-	if len(password) == 0 {
-		password = os.Getenv("MYSQL_PWD")
-	}
-
 	dbStr := username + ":" + password + "@tcp(" + addr + ":" + port + ")/registry"
 	ch := make(chan int, 1)
 	go func() {

dao/dao_test.go

@@ -128,8 +128,8 @@ func TestMain(m *testing.M) {
 
 	log.Infof("DB_HOST: %s, DB_USR: %s, DB_PORT: %s, DB_PWD: %s\n", dbHost, dbUser, dbPort, dbPassword)
 
-	os.Setenv("MYSQL_PORT_3306_TCP_ADDR", dbHost)
+	os.Setenv("MYSQL_HOST", dbHost)
-	os.Setenv("MYSQL_PORT_3306_TCP_PORT", dbPort)
+	os.Setenv("MYSQL_PORT", dbPort)
 	os.Setenv("MYSQL_USR", dbUser)
 	os.Setenv("MYSQL_PWD", dbPassword)
 	os.Setenv("AUTH_MODE", "db_auth")

docs/installation_guide.md

@@ -5,7 +5,7 @@ Harbor can be installed from the source code by using "docker-compose up" comman
 Harbor is deployed as several Docker containers. Hence, it can be deployed on any Linux distribution that supports Docker. 
 Before deploying Harbor, the target machine requires Python, Docker, Docker Compose to be installed.  
 * Python should be version 2.7 or higher.  Some Linux distributions (Gentoo, Arch) may not have a Python interpreter installed by default. On those systems, you need to install Python manually.  
-* The Docker engine should be version 1.8 or higher.  For the details to install Docker engine, please refer to: https://docs.docker.com/engine/installation/
+* The Docker engine should be version 1.10 or higher.  For the details to install Docker engine, please refer to: https://docs.docker.com/engine/installation/
 * The Docker Compose needs to be version 1.6.0 or higher.  For the details to install Docker compose, please refer to: https://docs.docker.com/compose/install/
 
 ### Configuration of Harbor 

utils/log/logger.go

@@ -27,6 +27,8 @@ import (
 var logger = New(os.Stdout, NewTextFormatter(), WarningLevel)
 
 func init() {
+	logger.callDepth = 3
+
 	// TODO add item in configuaration file
 	lvl := os.Getenv("LOG_LEVEL")
 	if len(lvl) == 0 {
@@ -49,6 +51,7 @@ type Logger struct {
 	out       io.Writer
 	fmtter    Formatter
 	lvl       Level
+	callDepth int
 	mu        sync.Mutex
 }
 
@@ -58,6 +61,7 @@ func New(out io.Writer, fmtter Formatter, lvl Level) *Logger {
 		out:       out,
 		fmtter:    fmtter,
 		lvl:       lvl,
+		callDepth: 2,
 	}
 }
 
@@ -117,7 +121,7 @@ func (l *Logger) output(record *Record) (err error) {
 // Debug ...
 func (l *Logger) Debug(v ...interface{}) {
 	if l.lvl <= DebugLevel {
-		line := line(2)
+		line := line(l.callDepth)
 		record := NewRecord(time.Now(), fmt.Sprint(v...), line, DebugLevel)
 		l.output(record)
 	}
@@ -126,7 +130,7 @@ func (l *Logger) Debug(v ...interface{}) {
 // Debugf ...
 func (l *Logger) Debugf(format string, v ...interface{}) {
 	if l.lvl <= DebugLevel {
-		line := line(2)
+		line := line(l.callDepth)
 		record := NewRecord(time.Now(), fmt.Sprintf(format, v...), line, DebugLevel)
 		l.output(record)
 	}
@@ -167,7 +171,7 @@ func (l *Logger) Warningf(format string, v ...interface{}) {
 // Error ...
 func (l *Logger) Error(v ...interface{}) {
 	if l.lvl <= ErrorLevel {
-		line := line(2)
+		line := line(l.callDepth)
 		record := NewRecord(time.Now(), fmt.Sprint(v...), line, ErrorLevel)
 		l.output(record)
 	}
@@ -176,7 +180,7 @@ func (l *Logger) Error(v ...interface{}) {
 // Errorf ...
 func (l *Logger) Errorf(format string, v ...interface{}) {
 	if l.lvl <= ErrorLevel {
-		line := line(2)
+		line := line(l.callDepth)
 		record := NewRecord(time.Now(), fmt.Sprintf(format, v...), line, ErrorLevel)
 		l.output(record)
 	}
@@ -185,7 +189,7 @@ func (l *Logger) Errorf(format string, v ...interface{}) {
 // Fatal ...
 func (l *Logger) Fatal(v ...interface{}) {
 	if l.lvl <= FatalLevel {
-		line := line(2)
+		line := line(l.callDepth)
 		record := NewRecord(time.Now(), fmt.Sprint(v...), line, FatalLevel)
 		l.output(record)
 	}
@@ -195,7 +199,7 @@ func (l *Logger) Fatal(v ...interface{}) {
 // Fatalf ...
 func (l *Logger) Fatalf(format string, v ...interface{}) {
 	if l.lvl <= FatalLevel {
-		line := line(2)
+		line := line(l.callDepth)
 		record := NewRecord(time.Now(), fmt.Sprintf(format, v...), line, FatalLevel)
 		l.output(record)
 	}
@@ -259,5 +263,12 @@ func line(calldepth int) string {
 		line = 0
 	}
 
-	return fmt.Sprintf("%s:%d", file, line)
+	for i := len(file) - 2; i > 0; i-- {
+		if file[i] == os.PathSeparator {
+			file = file[i+1:]
+			break
+		}
+	}
+
+	return fmt.Sprintf("[%s:%d]:", file, line)
 }