Harbor is powered by Beego.
### About
-Project Harbor is initiated by VMware China R&D as a Cloud Application Accelerator (CAA) project. CAA provides a set of tools to improve the productivity of cloud developers in China and other countries. CAA includes tools like registry server, mirror server, decentralized image distributor, etc.
+Project Harbor is initiated by the Advanced Technology Center (ATC), VMware China R&D as a Cloud Application Accelerator (CAA) project.
diff --git a/api/replication_job.go b/api/replication_job.go
index ae3d080a3..49db4ccad 100644
--- a/api/replication_job.go
+++ b/api/replication_job.go
@@ -134,6 +134,10 @@ func (ra *RepJobAPI) Delete() {
ra.CustomAbort(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
}
+ if job == nil {
+ ra.CustomAbort(http.StatusNotFound, fmt.Sprintf("job %d not found", ra.jobID))
+ }
+
if job.Status == models.JobPending || job.Status == models.JobRunning {
ra.CustomAbort(http.StatusBadRequest, fmt.Sprintf("job is %s, can not be deleted", job.Status))
}
diff --git a/api/repository.go b/api/repository.go
index 8de2f2bcc..260757538 100644
--- a/api/repository.go
+++ b/api/repository.go
@@ -17,6 +17,7 @@ package api
import (
"encoding/json"
+ "fmt"
"net/http"
"os"
"sort"
@@ -210,6 +211,10 @@ func (ra *RepositoryAPI) GetTags() {
ra.CustomAbort(http.StatusInternalServerError, "")
}
+ if project == nil {
+ ra.CustomAbort(http.StatusNotFound, fmt.Sprintf("project %s not found", projectName))
+ }
+
if project.Public == 0 {
userID := ra.ValidateUser()
if !checkProjectPermission(userID, project.ProjectID) {
diff --git a/contrib/docker-compose.yml.daocloud b/contrib/docker-compose.yml.daocloud
deleted file mode 100644
index e93fb42f1..000000000
--- a/contrib/docker-compose.yml.daocloud
+++ /dev/null
@@ -1,68 +0,0 @@
-version: '2'
-services:
- log:
- image: daocloud.io/harbor/deploy_log:latest
- volumes:
- - /var/log/harbor/:/var/log/docker/
- ports:
- - 1514:514
- registry:
- image: daocloud.io/library/registry:2.3.0
- volumes:
- - /data/registry:/storage
- - ./config/registry/:/etc/registry/
- ports:
- - 5001:5001
- command:
- /etc/registry/config.yml
- depends_on:
- - log
- logging:
- driver: "syslog"
- options:
- syslog-address: "tcp://127.0.0.1:1514"
- syslog-tag: "registry"
- mysql:
- image: daocloud.io/harbor/deploy_mysql:latest
- volumes:
- - /data/database:/var/lib/mysql
- env_file:
- - ./config/db/env
- depends_on:
- - log
- logging:
- driver: "syslog"
- options:
- syslog-address: "tcp://127.0.0.1:1514"
- syslog-tag: "mysql"
- ui:
- image: daocloud.io/harbor/deploy_ui:latest
- env_file:
- - ./config/ui/env
- volumes:
- - ./config/ui/app.conf:/etc/ui/app.conf
- - ./config/ui/private_key.pem:/etc/ui/private_key.pem
- depends_on:
- - log
- logging:
- driver: "syslog"
- options:
- syslog-address: "tcp://127.0.0.1:1514"
- syslog-tag: "ui"
- proxy:
- image: daocloud.io/library/nginx:1.9
- volumes:
- - ./config/nginx:/etc/nginx
- ports:
- - 80:80
- - 443:443
- depends_on:
- - mysql
- - registry
- - ui
- - log
- logging:
- driver: "syslog"
- options:
- syslog-address: "tcp://127.0.0.1:1514"
- syslog-tag: "proxy"
diff --git a/contrib/prebuild-install/README.md b/contrib/prebuild-install/README.md
new file mode 100644
index 000000000..3984e78b4
--- /dev/null
+++ b/contrib/prebuild-install/README.md
@@ -0,0 +1 @@
+docker-compose.sh is used to configure docker-compose.yml to pull images from platform like docker hub, daocloud.io and others. If you don't want to waste time on building images, you can execute this script to pull images from platform you prefer. Currently, we only support daocloud.io and docker hub, the default is docker hub.
diff --git a/contrib/prebuild-install/docker-compose.sh b/contrib/prebuild-install/docker-compose.sh
new file mode 100755
index 000000000..2e3a2f946
--- /dev/null
+++ b/contrib/prebuild-install/docker-compose.sh
@@ -0,0 +1,32 @@
+#/bin/bash
+read -p "Please input the platform name you want to pull images, for docker hub, enter 1; for daocloud.io, enter 2, otherwise enter the name of the platform, the default is 1:" choice
+cd ../../Deploy
+template_file="docker-compose.yml.template"
+yml_file='docker-compose.yml'
+if test -e $template_file
+then
+ cp $template_file $yml_file
+else
+ cp $yml_file $template_file
+fi
+platform=''
+choice=${choice:-1}
+if [ $choice == '1' ]
+then
+ platform='prjharbor/'
+elif [ $choice == '2' ]
+then
+ platform='daocloud.io/harbor/'
+else
+ platform=$choice
+fi
+version='0.3.0'
+log='deploy_log:'
+db='deploy_mysql:'
+job_service='deploy_jobservice:'
+ui='deploy_ui:'
+sed -i -- '/build: .\/log\//c\ image: '$platform$log$version'' $yml_file
+sed -i -- '/build: .\/db\//c\ image: '$platform$db$version'' $yml_file
+sed -i -- '/ui:/{n;N;N;d}' $yml_file && sed -i -- '/ui:/a\\ image: '$platform$ui$version'' $yml_file
+sed -i -- '/jobservice:/{n;N;N;d}' $yml_file && sed -i -- '/jobservice:/a\\ image: '$platform$job_service$version'' $yml_file
+echo "succeed! "
diff --git a/contrib/sdk/harbor-py/.gitignore b/contrib/sdk/harbor-py/.gitignore
new file mode 100644
index 000000000..11ead4b5e
--- /dev/null
+++ b/contrib/sdk/harbor-py/.gitignore
@@ -0,0 +1,94 @@
+# Temporary files
+files.txt
+*.swp
+*~
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
diff --git a/contrib/sdk/harbor-py/README.md b/contrib/sdk/harbor-py/README.md
new file mode 100644
index 000000000..0e27fd2d1
--- /dev/null
+++ b/contrib/sdk/harbor-py/README.md
@@ -0,0 +1,69 @@
+## Introduction
+
+[harbor](https://github.com/vmware/harbor) is the enterprise-class registry server for docker distribution.
+
+[harbor-py](https://github.com/tobegit3hub/harbor-py) is the native and compatible python SDK for harbor. The supported APIs are list below.
+
+- [x] Projects APIs
+ - [x] [Get projects](./examples/get_projects.py)
+ - [x] [Create project](./examples/create_project.py)
+ - [x] [Check project exist](./examples/check_project_exist.py)
+ - [x] [Set project publicity](./examples/set_project_publicity.py)
+ - [x] [Get project id from name](./examples/get_project_id_from_name.py)
+ - [ ] Get project access logs
+ - [ ] Get project member
+ - [ ] Get project and user member
+- [x] Users APIs
+ - [x] [Get users](./examples/get_users.py)
+ - [x] [Create user](./examples/create_user.py)
+ - [x] [Update user profile](./examples/update_user_profile.py)
+ - [x] [Delete user](./examples/delete_user.py)
+ - [x] [Change password](./examples/change_password.py)
+ - [x] [Promote as admin](./examples/promote_as_admin.py)
+- [x] Repositories APIs
+ - [x] [Get repositories](./examples/get_repositories.py)
+ - [x] [Delete repository](./examples/delete_repository.py)
+ - [x] [Get repository tags](./examples/get_repository_tags.py)
+ - [x] [Get repository manifests](./examples/get_repository_manifests.py)
+- [x] Others APIs
+ - [x] [Search](./examples/search.py)
+ - [x] [Get statistics](./examples/get_statistics.py)
+ - [x] [Get top accessed repositories](./examples/get_top_accessed_repositories.py)
+ - [x] [Get logs](./examples/get_logs.py)
+
+## Installation
+
+```
+pip install harbor-py
+```
+
+## Usage
+
+```
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+client.get_projects()
+client.get_users()
+client.get_statistics()
+client.get_top_accessed_repositories()
+client.search("library")
+```
+
+For more usage, please refer to the [examples](./examples/).
+
+## Contribution
+
+If you have any suggestion, feel free to submit [issues](https://github.com/tobegit3hub/harbor-py/issues) or send [pull-requests](https://github.com/tobegit3hub/harbor-py/pulls) for `harbor-py`.
+
+Publish `harbor-py` package to [pypi](https://pypi.python.org/pypi/harbor-py/) server with the following commands.
+
+```
+python setup.py register -r pypi
+python setup.py sdist upload -r pypi
+```
diff --git a/contrib/sdk/harbor-py/examples/change_password.py b/contrib/sdk/harbor-py/examples/change_password.py
new file mode 100755
index 000000000..8b69cd12e
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/change_password.py
@@ -0,0 +1,18 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Change password
+user_id = 2
+old_password = "test-password"
+new_password = "new-password"
+client.change_password(user_id, old_password, new_password)
diff --git a/contrib/sdk/harbor-py/examples/check_project_exist.py b/contrib/sdk/harbor-py/examples/check_project_exist.py
new file mode 100755
index 000000000..3667b71ba
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/check_project_exist.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Check if project exists
+project_name = "test-project"
+print(client.check_project_exist(project_name))
diff --git a/contrib/sdk/harbor-py/examples/create_project.py b/contrib/sdk/harbor-py/examples/create_project.py
new file mode 100755
index 000000000..adb07eefa
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/create_project.py
@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Create project
+project_name = "test-project"
+is_public = True
+client.create_project(project_name, is_public)
diff --git a/contrib/sdk/harbor-py/examples/create_user.py b/contrib/sdk/harbor-py/examples/create_user.py
new file mode 100755
index 000000000..1ac2e5e39
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/create_user.py
@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Create user
+username = "test-username"
+email = "test-email@gmail.com"
+password = "test-password"
+realname = "test-realname"
+comment = "test-comment"
+client.create_user(username, email, password, realname, comment)
diff --git a/contrib/sdk/harbor-py/examples/delete_repository.py b/contrib/sdk/harbor-py/examples/delete_repository.py
new file mode 100755
index 000000000..b12508ec5
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/delete_repository.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Delete repository
+repo_name = "library/cirros"
+client.delete_repository(repo_name)
diff --git a/contrib/sdk/harbor-py/examples/delete_user.py b/contrib/sdk/harbor-py/examples/delete_user.py
new file mode 100755
index 000000000..7fa6ecbcb
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/delete_user.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Delete user
+user_id = 2
+print(client.delete_user(user_id))
diff --git a/contrib/sdk/harbor-py/examples/get_logs.py b/contrib/sdk/harbor-py/examples/get_logs.py
new file mode 100755
index 000000000..c62c5ac0a
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/get_logs.py
@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Get logs
+print(client.get_logs())
diff --git a/contrib/sdk/harbor-py/examples/get_project_id_from_name.py b/contrib/sdk/harbor-py/examples/get_project_id_from_name.py
new file mode 100755
index 000000000..67366679f
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/get_project_id_from_name.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Get project id from name
+project_name = "library"
+print(client.get_project_id_from_name(project_name))
diff --git a/contrib/sdk/harbor-py/examples/get_projects.py b/contrib/sdk/harbor-py/examples/get_projects.py
new file mode 100755
index 000000000..b95d0701e
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/get_projects.py
@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Get all projects
+print(client.get_projects())
diff --git a/contrib/sdk/harbor-py/examples/get_repositories.py b/contrib/sdk/harbor-py/examples/get_repositories.py
new file mode 100755
index 000000000..3c83c7eca
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/get_repositories.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Get all repositories
+project_id = 1
+print(client.get_repositories(project_id))
diff --git a/contrib/sdk/harbor-py/examples/get_repository_manifests.py b/contrib/sdk/harbor-py/examples/get_repository_manifests.py
new file mode 100755
index 000000000..7a3fd0b0b
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/get_repository_manifests.py
@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Get repository manifests
+repo_name = "library/cirros"
+tag = "latest"
+client.get_repository_manifests(repo_name, tag)
diff --git a/contrib/sdk/harbor-py/examples/get_repository_tags.py b/contrib/sdk/harbor-py/examples/get_repository_tags.py
new file mode 100755
index 000000000..03fffdea1
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/get_repository_tags.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Get repository tags
+repo_name = "library/cirros"
+client.get_repository_tags(repo_name)
diff --git a/contrib/sdk/harbor-py/examples/get_statistics.py b/contrib/sdk/harbor-py/examples/get_statistics.py
new file mode 100755
index 000000000..8a6dcb6b2
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/get_statistics.py
@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+print(client.get_statistics())
diff --git a/contrib/sdk/harbor-py/examples/get_top_accessed_repositories.py b/contrib/sdk/harbor-py/examples/get_top_accessed_repositories.py
new file mode 100755
index 000000000..b19e5901d
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/get_top_accessed_repositories.py
@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Get top accessed respositories
+print(client.get_top_accessed_repositories())
+
+# Get top accessed respositories with count
+count = 1
+print(client.get_top_accessed_repositories(count))
diff --git a/contrib/sdk/harbor-py/examples/get_users.py b/contrib/sdk/harbor-py/examples/get_users.py
new file mode 100755
index 000000000..1a634bed5
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/get_users.py
@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Get all users
+print(client.get_users())
diff --git a/contrib/sdk/harbor-py/examples/promote_as_admin.py b/contrib/sdk/harbor-py/examples/promote_as_admin.py
new file mode 100755
index 000000000..c7692f21a
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/promote_as_admin.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Promote as admin
+user_id = 2
+client.promote_as_admin(user_id)
diff --git a/contrib/sdk/harbor-py/examples/search.py b/contrib/sdk/harbor-py/examples/search.py
new file mode 100755
index 000000000..3ecd52f4a
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/search.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Search with query string
+query_string = "library"
+print(client.search(query_string))
diff --git a/contrib/sdk/harbor-py/examples/set_project_publicity.py b/contrib/sdk/harbor-py/examples/set_project_publicity.py
new file mode 100755
index 000000000..6f29b6dd7
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/set_project_publicity.py
@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Set project publicity
+project_id = 1
+is_public = True
+client.set_project_publicity(project_id, is_public)
diff --git a/contrib/sdk/harbor-py/examples/test_harborclient.py b/contrib/sdk/harbor-py/examples/test_harborclient.py
new file mode 100755
index 000000000..b1731ebd8
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/test_harborclient.py
@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
diff --git a/contrib/sdk/harbor-py/examples/update_user_profile.py b/contrib/sdk/harbor-py/examples/update_user_profile.py
new file mode 100755
index 000000000..750ab120a
--- /dev/null
+++ b/contrib/sdk/harbor-py/examples/update_user_profile.py
@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("../")
+
+from harborclient import harborclient
+
+host = "127.0.0.1"
+user = "admin"
+password = "Harbor12345"
+
+client = harborclient.HarborClient(host, user, password)
+
+# Update user profile
+user_id = 2
+email = "new@gmail.com"
+realname = "new_realname"
+comment = "new_comment"
+client.update_user_profile(user_id, email, realname, comment)
diff --git a/contrib/sdk/harbor-py/format_code.sh b/contrib/sdk/harbor-py/format_code.sh
new file mode 100755
index 000000000..ee8253cbb
--- /dev/null
+++ b/contrib/sdk/harbor-py/format_code.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -x
+
+find ./ -name "*.py" |xargs sudo yapf -i
diff --git a/contrib/sdk/harbor-py/harborclient/__init__.py b/contrib/sdk/harbor-py/harborclient/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/contrib/sdk/harbor-py/harborclient/harborclient.py b/contrib/sdk/harbor-py/harborclient/harborclient.py
new file mode 100755
index 000000000..31f9690bc
--- /dev/null
+++ b/contrib/sdk/harbor-py/harborclient/harborclient.py
@@ -0,0 +1,372 @@
+#!/usr/bin/env python
+
+import json
+import logging
+import requests
+
+logging.basicConfig(level=logging.INFO)
+
+
+class HarborClient(object):
+ def __init__(self, host, user, password, protocol="http"):
+ self.host = host
+ self.user = user
+ self.password = password
+ self.protocol = protocol
+
+ self.session_id = self.login()
+
+ def __del__(self):
+ self.logout()
+
+ def login(self):
+ login_data = requests.post('%s://%s/login' %
+ (self.protocol, self.host),
+ data={'principal': self.user,
+ 'password': self.password})
+ if login_data.status_code == 200:
+ session_id = login_data.cookies.get('beegosessionID')
+
+ logging.debug("Successfully login, session id: {}".format(
+ session_id))
+ return session_id
+ else:
+ logging.error("Fail to login, please try again")
+ return None
+
+ def logout(self):
+ requests.get('%s://%s/logout' % (self.protocol, self.host),
+ cookies={'beegosessionID': self.session_id})
+ logging.debug("Successfully logout")
+
+ # Get project id
+ def get_project_id_from_name(self, project_name):
+ registry_data = requests.get(
+ '%s://%s/api/projects?project_name=%s' %
+ (self.protocol, self.host, project_name),
+ cookies={'beegosessionID': self.session_id})
+ if registry_data.status_code == 200 and registry_data.json():
+ project_id = registry_data.json()[0]['project_id']
+ logging.debug(
+ "Successfully get project id: {}, project name: {}".format(
+ project_id, project_name))
+ return project_id
+ else:
+ logging.error("Fail to get project id from project name",
+ project_name)
+ return None
+
+ # GET /search
+ def search(self, query_string):
+ result = None
+ path = '%s://%s/api/search?q=%s' % (self.protocol, self.host,
+ query_string)
+ response = requests.get(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = response.json()
+ logging.debug("Successfully get search result: {}".format(result))
+ else:
+ logging.error("Fail to get search result")
+ return result
+
+ # GET /projects
+ def get_projects(self, project_name=None, is_public=None):
+ # TODO: support parameter
+ result = None
+ path = '%s://%s/api/projects' % (self.protocol, self.host)
+ response = requests.get(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = response.json()
+ logging.debug("Successfully get projects result: {}".format(
+ result))
+ else:
+ logging.error("Fail to get projects result")
+ return result
+
+ # HEAD /projects
+ def check_project_exist(self, project_name):
+ result = False
+ path = '%s://%s/api/projects?project_name=%s' % (
+ self.protocol, self.host, project_name)
+ response = requests.head(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = True
+ logging.debug(
+ "Successfully check project exist, result: {}".format(result))
+ elif response.status_code == 404:
+ result = False
+ logging.debug(
+ "Successfully check project exist, result: {}".format(result))
+ else:
+ logging.error("Fail to check project exist")
+ return result
+
+ # POST /projects
+ def create_project(self, project_name, is_public=False):
+ result = False
+ path = '%s://%s/api/projects' % (self.protocol, self.host)
+ request_body = json.dumps({'project_name': project_name,
+ 'public': is_public})
+ response = requests.post(path,
+ cookies={'beegosessionID': self.session_id},
+ data=request_body)
+ if response.status_code == 201 or response.status_code == 500:
+ # TODO: the response return 500 sometimes
+ result = True
+ logging.debug(
+ "Successfully create project with project name: {}".format(
+ project_name))
+ else:
+ logging.error(
+ "Fail to create project with project name: {}, response code: {}".format(
+ project_name, response.status_code))
+ return result
+
+ # PUT /projects/{project_id}/publicity
+ def set_project_publicity(self, project_id, is_public):
+ result = False
+ path = '%s://%s/api/projects/%s/publicity?project_id=%s' % (
+ self.protocol, self.host, project_id, project_id)
+ request_body = json.dumps({'public': is_public})
+ response = requests.put(path,
+ cookies={'beegosessionID': self.session_id},
+ data=request_body)
+ if response.status_code == 200:
+ result = True
+ logging.debug(
+ "Success to set project id: {} with publicity: {}".format(
+ project_id, is_public))
+ else:
+ logging.error(
+ "Fail to set publicity to project id: {} with status code: {}".format(
+ project_id, response.status_code))
+ return result
+
+ # GET /statistics
+ def get_statistics(self):
+ result = None
+ path = '%s://%s/api/statistics' % (self.protocol, self.host)
+ response = requests.get(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = response.json()
+ logging.debug("Successfully get statistics: {}".format(result))
+ else:
+ logging.error("Fail to get statistics result")
+ return result
+
+ # GET /users
+ def get_users(self, user_name=None):
+ # TODO: support parameter
+ result = None
+ path = '%s://%s/api/users' % (self.protocol, self.host)
+ response = requests.get(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = response.json()
+ logging.debug("Successfully get users result: {}".format(result))
+ else:
+ logging.error("Fail to get users result")
+ return result
+
+ # POST /users
+ def create_user(self, username, email, password, realname, comment):
+ result = False
+ path = '%s://%s/api/users' % (self.protocol, self.host)
+ request_body = json.dumps({'username': username,
+ 'email': email,
+ 'password': password,
+ 'realname': realname,
+ 'comment': comment})
+ response = requests.post(path,
+ cookies={'beegosessionID': self.session_id},
+ data=request_body)
+ if response.status_code == 201:
+ result = True
+ logging.debug("Successfully create user with username: {}".format(
+ username))
+ else:
+ logging.error(
+ "Fail to create user with username: {}, response code: {}".format(
+ username, response.status_code))
+ return result
+
+ # PUT /users/{user_id}
+ def update_user_profile(self, user_id, email, realname, comment):
+ # TODO: support not passing comment
+ result = False
+ path = '%s://%s/api/users/%s?user_id=%s' % (self.protocol, self.host,
+ user_id, user_id)
+ request_body = json.dumps({'email': email,
+ 'realname': realname,
+ 'comment': comment})
+ response = requests.put(path,
+ cookies={'beegosessionID': self.session_id},
+ data=request_body)
+ if response.status_code == 200:
+ result = True
+ logging.debug(
+ "Successfully update user profile with user id: {}".format(
+ user_id))
+ else:
+ logging.error(
+ "Fail to update user profile with user id: {}, response code: {}".format(
+ user_id, response.status_code))
+ return result
+
+ # DELETE /users/{user_id}
+ def delete_user(self, user_id):
+ result = False
+ path = '%s://%s/api/users/%s?user_id=%s' % (self.protocol, self.host,
+ user_id, user_id)
+ response = requests.delete(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = True
+ logging.debug("Successfully delete user with id: {}".format(
+ user_id))
+ else:
+ logging.error("Fail to delete user with id: {}".format(user_id))
+ return result
+
+ # PUT /users/{user_id}/password
+ def change_password(self, user_id, old_password, new_password):
+ result = False
+ path = '%s://%s/api/users/%s/password?user_id=%s' % (
+ self.protocol, self.host, user_id, user_id)
+ request_body = json.dumps({'old_password': old_password,
+ 'new_password': new_password})
+ response = requests.put(path,
+ cookies={'beegosessionID': self.session_id},
+ data=request_body)
+ if response.status_code == 200:
+ result = True
+ logging.debug(
+ "Successfully change password for user id: {}".format(user_id))
+ else:
+ logging.error("Fail to change password for user id: {}".format(
+ user_id))
+ return result
+
+ # PUT /users/{user_id}/sysadmin
+ def promote_as_admin(self, user_id):
+ # TODO: always return 404, need more test
+ result = False
+ path = '%s://%s/api/users/%s/sysadmin?user_id=%s' % (
+ self.protocol, self.host, user_id, user_id)
+ response = requests.put(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = True
+ logging.debug(
+ "Successfully promote user as admin with user id: {}".format(
+ user_id))
+ else:
+ logging.error(
+ "Fail to promote user as admin with user id: {}, response code: {}".format(
+ user_id, response.status_code))
+ return result
+
+ # GET /repositories
+ def get_repositories(self, project_id, query_string=None):
+ # TODO: support parameter
+ result = None
+ path = '%s://%s/api/repositories?project_id=%s' % (
+ self.protocol, self.host, project_id)
+ response = requests.get(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = response.json()
+ logging.debug(
+ "Successfully get repositories with id: {}, result: {}".format(
+ project_id, result))
+ else:
+ logging.error("Fail to get repositories result with id: {}".format(
+ project_id))
+ return result
+
+ # DELETE /repositories
+ def delete_repository(self, repo_name, tag=None):
+ # TODO: support to check tag
+ # TODO: return 200 but the repo is not deleted, need more test
+ result = False
+ path = '%s://%s/api/repositories?repo_name=%s' % (self.protocol,
+ self.host, repo_name)
+ response = requests.delete(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = True
+ logging.debug("Successfully delete repository: {}".format(
+ repo_name))
+ else:
+ logging.error("Fail to delete repository: {}".format(repo_name))
+ return result
+
+ # Get /repositories/tags
+ def get_repository_tags(self, repo_name):
+ result = None
+ path = '%s://%s/api/repositories/tags?repo_name=%s' % (
+ self.protocol, self.host, repo_name)
+ response = requests.get(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = response.json()
+ logging.debug(
+ "Successfully get tag with repo name: {}, result: {}".format(
+ repo_name, result))
+ else:
+ logging.error("Fail to get tags with repo name: {}".format(
+ repo_name))
+ return result
+
+ # GET /repositories/manifests
+ def get_repository_manifests(self, repo_name, tag):
+ result = None
+ path = '%s://%s/api/repositories/manifests?repo_name=%s&tag=%s' % (
+ self.protocol, self.host, repo_name, tag)
+ response = requests.get(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = response.json()
+ logging.debug(
+ "Successfully get manifests with repo name: {}, tag: {}, result: {}".format(
+ repo_name, tag, result))
+ else:
+ logging.error(
+ "Fail to get manifests with repo name: {}, tag: {}".format(
+ repo_name, tag))
+ return result
+
+ # GET /repositories/top
+ def get_top_accessed_repositories(self, count=None):
+ result = None
+ path = '%s://%s/api/repositories/top' % (self.protocol, self.host)
+ if count:
+ path += "?count=%s" % (count)
+ response = requests.get(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = response.json()
+ logging.debug(
+ "Successfully get top accessed repositories, result: {}".format(
+ result))
+ else:
+ logging.error("Fail to get top accessed repositories")
+ return result
+
+ # GET /logs
+ def get_logs(self, lines=None, start_time=None, end_time=None):
+ result = None
+ path = '%s://%s/api/logs' % (self.protocol, self.host)
+ response = requests.get(path,
+ cookies={'beegosessionID': self.session_id})
+ if response.status_code == 200:
+ result = response.json()
+ logging.debug("Successfully get logs")
+ else:
+ logging.error("Fail to get logs and response code: {}".format(
+ response.status_code))
+ return result
diff --git a/contrib/sdk/harbor-py/harborclient/test_harborclient.py b/contrib/sdk/harbor-py/harborclient/test_harborclient.py
new file mode 100644
index 000000000..07ca718d6
--- /dev/null
+++ b/contrib/sdk/harbor-py/harborclient/test_harborclient.py
@@ -0,0 +1,3 @@
+#!/usr/bin/env python
+
+import harborclient
diff --git a/contrib/sdk/harbor-py/requirements.txt b/contrib/sdk/harbor-py/requirements.txt
new file mode 100644
index 000000000..f7778fa68
--- /dev/null
+++ b/contrib/sdk/harbor-py/requirements.txt
@@ -0,0 +1 @@
+requests>2.2.0
diff --git a/contrib/sdk/harbor-py/setup.py b/contrib/sdk/harbor-py/setup.py
new file mode 100644
index 000000000..ea63d8d24
--- /dev/null
+++ b/contrib/sdk/harbor-py/setup.py
@@ -0,0 +1,103 @@
+""" The missing harbor python SDK
+
+See: https://github.com/tobegit3hub/harbor-py
+"""
+
+from setuptools import setup, find_packages
+from codecs import open
+from os import path
+
+setup(
+ name='harbor-py',
+
+ # Versions should comply with PEP440. For a discussion on single-sourcing
+ # the version across setup.py and the project code, see
+ # https://packaging.python.org/en/latest/single_source_version.html
+ version='1.2.0',
+ description='The missing harbor python SDK',
+
+ # The project's main homepage.
+ url='https://github.com/tobegit3hub/harbor-py',
+
+ # Author details
+ author='tobe',
+ author_email='tobeg3oogle@gmail.com',
+
+ # Choose your license
+ license='Apache Software',
+
+ # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+ classifiers=[
+ # How mature is this project? Common values are
+ # 3 - Alpha
+ # 4 - Beta
+ # 5 - Production/Stable
+ 'Development Status :: 3 - Alpha',
+
+ # Indicate who your project is intended for
+ 'Intended Audience :: Developers',
+ 'Topic :: Software Development :: Build Tools',
+
+ # Pick your license as you wish (should match "license" above)
+ 'License :: OSI Approved :: Apache Software License',
+
+ # Specify the Python versions you support here. In particular, ensure
+ # that you indicate whether you support Python 2, Python 3 or both.
+ 'Programming Language :: Python :: 2',
+ 'Programming Language :: Python :: 2.6',
+ 'Programming Language :: Python :: 2.7',
+ 'Programming Language :: Python :: 3',
+ 'Programming Language :: Python :: 3.3',
+ 'Programming Language :: Python :: 3.4',
+ 'Programming Language :: Python :: 3.5',
+ ],
+
+ # What does your project relate to?
+ keywords='docker registry distribution harbor python sdk',
+
+ # You can just specify the packages manually here if your project is
+ # simple. Or you can use find_packages().
+ #packages=find_packages(exclude=['contrib', 'docs', 'tests']),
+ packages=['harborclient'],
+
+ # Alternatively, if you want to distribute just a my_module.py, uncomment
+ # this:
+ # py_modules=["my_module"],
+
+ # List run-time dependencies here. These will be installed by pip when
+ # your project is installed. For an analysis of "install_requires" vs pip's
+ # requirements files see:
+ # https://packaging.python.org/en/latest/requirements.html
+ #install_requires=['peppercorn'],
+
+ # List additional groups of dependencies here (e.g. development
+ # dependencies). You can install these using the following syntax,
+ # for example:
+ # $ pip install -e .[dev,test]
+ #extras_require={
+ # 'dev': ['check-manifest'],
+ # 'test': ['coverage'],
+ #},
+
+ # If there are data files included in your packages that need to be
+ # installed, specify them here. If using Python 2.6 or less, then these
+ # have to be included in MANIFEST.in as well.
+ #package_data={
+ # 'sample': ['package_data.dat'],
+ #},
+
+ # Although 'package_data' is the preferred approach, in some case you may
+ # need to place data files outside of your packages. See:
+ # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa
+ # In this case, 'data_file' will be installed into '