Harbor是一个由CNCF托管的开源的Docker镜像仓库管理工具,可以通过它快速的建立起自己的私有仓库。
Harbor 的每个组件都是以 Docker 容器的形式构建的,使用 docker-compose 来对它进行部署。
用于部署 Harbor 的 docker-compose 模板位于 harbor/docker-compose.yml。
1)基于角色控制:用户和仓库都是基于项目进行组织的,而用户在项目中可以拥有不同的权限。
2)基于镜像的复制策略:镜像可以在多个Harbor实例之间进行复制(同步)。
3)支持 LDAP/AD:Harbor 可以集成企业内部已有的 AD/LDAP(类似数据库的一张表),用于对已经存在的用户认证和管理。
4)镜像删除和垃圾回收:镜像可以被删除,也可以回收镜像占用的空间。
5)图形化用户界面:用户可以通过浏览器来浏览,搜索镜像仓库以及对项目进行管理。
6)审计管理:所有针对镜像仓库的操作都可以被记录追溯,用于审计管理。
7)支持 RESTful API:RESTful API 提供给管理员对于 Harbor 更多的操控, 使得与其它管理软件集成变得更容易。
Harbor实质上是对docker registry做了封装,扩展了自己的业务模板。
Harbor在架构上主要有Proxy、Registry、Core services、Database(Harbor-db)、Log collector(Harbor-log)、Job services 六个组件。
UI(harbor-ui): 提供图形化界面,帮助用户管理 Registry 上的镜像(image), 并对用户进行授权。
WebHook:为了及时获取Registry 上image 状态变化的情况,在Registry 上配置 Webhook,把状态变化传递给UI 模块。
Token 服务:负责根据用户权限给每个 Docker push/pull 命令签发 Token。Docker 客户端向 Registry服务发起的请求, 如果不包含 Token,会被重定向到 Token 服务,获得 Token 后再重新向 Registry 进行请求。
总共分为7个容器运行,通过在docker-compose.yml所在目录中执行 docker-compose ps 命令来查看, 名称分别为:nginx、harbor-jobservice、harbor-ui、harbor-db、harbor-adminserver、registry、harbor-log。
其中 harbor-adminserver 主要是作为一个后端的配置数据管理,并没有太多的其他功能。
harbor-ui 所要操作的所有数据都通过 harbor-adminserver 这样一个数据配置管理中心来完成。
关于 harbor.yml 配置文件中有两类参数:所需参数和可选参数
这些参数需要在配置文件中设置。
如果用户更新它们并运行 install.sh 脚本重新安装 Harbor, 参数将生效。
具体参数如下:
hostname:用于访问用户界面和 register 服务。它应该是目标机器的 IP 地址或完全限定的域名(FQDN),例如 192.168.2.103 或 hub.kgc.cn。不要使用 localhost 或 127.0.0.1 为主机名。
ui_url_protocol:(http 或 https,默认为 http)用于访问 UI 和令牌/通知服务的协议。如果公证处于启用状态,则此参数必须为 https。
max_job_workers:镜像复制作业线程。
db_password:用于db_auth 的MySQL数据库root 用户的密码。
customize_crt:该属性可设置为打开或关闭,默认打开。打开此属性时,准备脚本创建私钥和根证书,用于生成/验证注册表令牌。当由外部来源提供密钥和根证书时,将此属性设置为 off。
ssl_cert:SSL 证书的路径,仅当协议设置为 https 时才应用。
secretkey_path:用于在复制策略中加密或解密远程 register 密码的密钥路径。
这些参数对于更新是可选的,即用户可以将其保留为默认值,并在启动 Harbor 后在 Web UI 上进行更新。
如果进入 harbor.yml,只会在第一次启动 Harbor 时生效,随后对这些参数的更新,harbor.yml将被忽略。
注意:如果选择通过 UI 设置这些参数,请确保在启动 Harbor 后立即执行此操作。
具体来说,必须在注册或在 Harbor 中创建任何新用户之前设置所需的 auth_mode。
当系统中有用户时(除了默认的 admin 用户), auth_mode 不能被修改。
具体参数如下:
Email:Harbor 需要该参数才能向用户发送“密码重置”电子邮件,并且只有在需要该功能时才启用。请注意,在默认情况下 SSL 连接时没有启用。如果 SMTP 服务器需要 SSL,但不支持 STARTTLS,那么应该通过设置启用 SSL email_ssl = TRUE。
harbor_admin_password:管理员的初始密码,只在 Harbor 第一次启动时生效。之后, 此设置将被忽略,并且应在 UI 中设置管理员的密码。请注意,默认的用户名/密码是admin/Harbor12345。
auth_mode:使用的认证类型,默认情况下,它是 db_auth,即凭据存储在数据库中。对于LDAP身份验证,请将其设置为 ldap_auth。
self_registration:启用/禁用用户注册功能。禁用时,新用户只能由 Admin 用户创建,只有管理员用户可以在 Harbor 中创建新用户。注意:当 auth_mode 设置为 ldap_auth 时,自注册功能将始终处于禁用状态,并且该标志被忽略。
Token_expiration:由令牌服务创建的令牌的到期时间(分钟),默认为 30 分钟。
project_creation_restriction:用于控制哪些用户有权创建项目的标志。默认情况下,每个人都可以创建一个项目。 如果将其值设置为“adminonly”,那么只有 admin 可以创建项目。
verify_remote_cert:打开或关闭,默认打开。此标志决定了当Harbor与远程 register 实例通信时是否验证 SSL/TLS 证书。 将此属性设置为 off 将绕过 SSL/TLS 验证,这在远程实例具有自签名或不可信证书时经常使用。
另外,默认情况下,Harbor 将镜像存储在本地文件系统上。
在生产环境中,可以考虑 使用其他存储后端而不是本地文件系统,如 S3、Openstack Swif、Ceph 等对象存储。
但需要更新 common/templates/registry/config.yml 文件。
Harbor的默认镜像存储路径在 /data/registry 目录下,映射到docker容器里面的 /storage 目录下。
这个参数是在 docker-compose.yml 中指定的,在 docker-compose up -d 运行之前修改。
如果希望将 Docker 镜像存储到其他的磁盘路径,可以修改这个参数。
Server | IP | Compoments |
---|---|---|
Harbor服务器 | 190.168.190.170 | docker-ce、docker-compose、harbor-offline-v1.2.2 |
Client服务器 | 192.168.190.180 | docker-ce |
[root ~]# systemctl stop firewalld.service
[root ~]# setenforce 0
[root ~]#
//下载或者上传 Docker-Compose
curl -L https://github.com/docker/compose/releases/download/1.21.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
docker-compose -v
#docker-compose执行文件
Harbor的压缩包下载地址:https://github.com/goharbor/harbor/releases
wget http://harbor.orientsoft.cn/harbor-1.2.2/harbor-offline-installer-v1.10.18.tgz
tar zxvf harbor-offline-installer-v1.10.18.tgz -C /usr/local/
vim /usr/local/harbor/harbor.yml
#--5行--修改,设置为Harbor服务器的IP地址或者域名
hostname = 192.168.67.101
#--27行--指定管理员的初始密码,默认的用户名/密码是admin/Harbor12345
harbor_admin_password = Harbor12345
#在配置好了 harbor.cfg 之后,执行 ./prepare 命令,为 harbor 启动的容器生成一些必要的文件(环境)。
#再执行命令 ./install.sh 以 pull 镜像并启动容器。
cd /usr/local/harbor/
./prepare
[root harbor]#
[root harbor]# ./install.sh
[root harbor]# cd /usr/local/harbor/
[root harbor]# docker-compose ps
Name Command State Ports
--------------------------------------------------------------------------------------------------------
harbor-core /harbor/harbor_core Up (healthy)
harbor-db /docker-entrypoint.sh 96 13 Up (healthy) 5432/tcp
harbor-jobservice /harbor/harbor_jobservice ... Up (healthy)
harbor-log /bin/sh -c /usr/local/bin/ ... Up (healthy) 127.0.0.1:1514->10514/tcp
harbor-portal nginx -g daemon off; Up (healthy) 8080/tcp
nginx nginx -g daemon off; Up (healthy) 0.0.0.0:80->8080/tcp,:::80->8080/tcp
redis redis-server /etc/redis.conf Up (healthy) 6379/tcp
registry /home/harbor/entrypoint.sh Up (healthy) 5000/tcp
registryctl /home/harbor/start.sh Up (healthy)
[root harbor]#
[root harbor]#
#相关启动停止命令
docker-compose up -d #启动
docker-compose stop #停止
docker-compose restart #重新启动
docker-compose down #删除
浏览器访问:http://192.168.190.170 登录 Harbor WEB UI 界面 默认的管理员用户名和密码是admin/Harbor12345
输入用户名和密码登录界面后可以创建一个新项目。
点击“+项目”按钮
填写项目名称为“myproject-test”,点击“确定”按钮,创建新项目
此时可使用 Docker 命令在本地通过 127.0.0.1 来登录和推送镜像。
默认情况下,Registry 服务器在端口 80 上侦听。
#登录 Harbor
docker login -u admin -p Harbor12345 http://127.0.0.1
docker pull nginx
#下载镜像进行测试
#将镜像打标签
#格式:docker tag 镜像:标签 仓库IP/项目名称/镜像名:标签
docker tag nginx:latest 127.0.0.1/myproject-test/nginx:v1
docker push 127.0.0.1/myproject-test/nginx:v1
#上传镜像到 Harbor
在 Harbor 界面 myproject-test目录下可看见此镜像及相关信息
#在其他客户端连接到harbor,会报错 docker login -u admin -p Harbor12345 http://192.168.190.170
出现这问题的原因为Docker Registry 交互默认使用的是 HTTPS,但是搭建私有镜像默认使用的是 HTTP
服务,所以与私有镜像交互时出现以下错误。
(1)在 Docker 客户端配置操作 //解决办法是:在 Docker server 启动的时候,增加启动参数,默认使用 HTTP 访问。
vim /usr/lib/systemd/system/docker.service
--13行--修改
ExecStart=/usr/bin/dockerd -H fd:// --insecure-registry 192.168.190.170 --containerd=/run/containerd/containerd.sock
或
ExecStart=/usr/bin/dockerd --insecure-registry 192.168.190.170
[root ~]# systemctl daemon-reload
[root ~]# systemctl restart docker
[root ~]#
[root ~]# docker login -u admin -p Harbor12345 http://192.168.190.170
WARNING! Using --password via the CLI is insecure. Use --password-stdin.
WARNING! Your password will be stored unencrypted in /root/.docker/config.json.
Configure a credential helper to remove this warning. See
https://docs.docker.com/engine/reference/commandline/login/#credentials-store
Login Succeeded
[root ~]#
//将自动保存凭据到/root/.docker/config.json,下次登录时可直接使用凭据登录 Harbor
//下载镜像进行测试
docker pull 192.168.190.170/myproject-test/nginx:v1
#进行镜像上传测试,登录到harbor web界面,查看镜像是否上传成功
#获取镜像
docker pull httpd
#加上标签
docker tag httpd:latest 192.168.190.170/myproject-test/httpd:v2
#上传到私有仓库
docker push 192.168.190.170/myproject-test/httpd:v2
登录到Harbor web界面
刷新 Harbor 的 Web 管理界面进行查看,会发现 myproject-test 项目里面有两个镜像。
在 Harbor 仓库中,任何镜像在被 push 到 regsitry 之前都必须有一个自己所属的项目。
单击“+项目”,填写项目名称,项目级别若设置为"私有",则不勾选。
如果设置为公共仓库,则所有人对此项目下的镜像拥有读权限,命令行中不需要执行"Docker login"即可下载镜像,镜像操作与 Docker Hub一致。
在 Web 管理界面中单击系统管理 -> 用户管理 -> +用户,
填写用户名为“scj-test”,邮箱为“scj-test@123.com”,全名为“scj”,密码为“Abc123456”,注释为“管理员”(可省略)。
附:用户创建成功后,单击左侧“…”按钮可将上述创建的用户设置为管理员角色或进行删除操作,本例不作任何设置。
角色 | 权限说明 |
---|---|
访客 | 对于指定项目拥有只读权限 |
开发人员 | 对于指定项目拥有读写权限,但没用删除权限 |
维护人员 | 对于指定项目拥有读写权限,也能对修改其它配置,比如创建 Webhooks |
项目管理员 | 对于指定项目拥有读写权限,也能对修改其它配置,比如创建 Webhooks |
单击项目 -> myproject-test-> 成员 -> + 成员,填写上述创建的用户scj-test 并分配角色为“开发人员”。
附:此时单击左侧“…”按钮仍然可对成员角色进行变更或者删除操作
#先使用普通账户登录harbor
#删除上述打标签的本地镜像
[root ~]#
[root ~]# docker rmi 192.168.190.170/myproject-test/httpd:v2
Untagged: 192.168.190.170/myproject-test/httpd:v2
Untagged: 192.168.190.170/myproject-test/httpd:57c1e4ff150e2782a25c8cebb80b574f81f06b74944caf972f27e21b76074194
[root ~]#
[root ~]#
#先退出当前用户,然后使用上述创建的账户fsj 登录
docker logout 192.168.190.170
docker login 192.168.190.170
或docker login -u fsj -p Fsj12210614 http://192.168.190.170
[root ~]#
[root ~]#
[root ~]# docker login -u fsj -p Fsj12210614 http://192.168.190.170
WARNING! Using --password via the CLI is insecure. Use --password-stdin.
WARNING! Your password will be stored unencrypted in /root/.docker/config.json.
Configure a credential helper to remove this warning. See
https://docs.docker.com/engine/reference/commandline/login/#credentials-store
Login Succeeded
[root ~]#
#下载测试
docker pull 192.168.190.170/myproject-test/httpd:v2
#上传测试
docker tag httpd:latest 192.168.190.170/myproject-test/httpd:v3
docker push 192.168.190.170/myproject-test/httpd:v3
刷新web界面
Web 界面日志,操作日志按时间顺序记录用户相关操作。
更改 Harbor的配置文件中的可选参数的步骤:
1、要更改 Harbor的配置文件中的可选参数时,请先停止现有的 Harbor实例并更新 Harbor.cfg;
2、然后运行 prepare 脚本来填充配置;
3、最后重新创建并启动 Harbor 的实例。
使用 docker-compose 管理 Harbor 时,必须在与 docker-compose.yml 相同的目录中运行。
这些参数需要在配置文件 Harbor.cfg 中设置。如果用户更新它们并运行 install.sh 脚本重新安装 Harbor, 参数将生效。
- hostname:用于访问用户界面和 register 服务。它应该是目标机器的 IP 地址或完全限定的域名(FQDN)
- ui_url_protocol:(http 或 https,默认为 http)用于访问 UI 和令牌/通知服务的协议。如果公证处于启用状态,则此参数必须为 https。
- max_job_workers:镜像复制作业线程。
- db_password:用于db_auth 的MySQL数据库root 用户的密码。
- customize_crt:该属性可设置为打开或关闭,默认打开。打开此属性时,准备脚本创建私钥和根证书,用于生成/验证注册表令牌。当由外部来源提供密钥和根证书时,将此属性设置为 off。
- ssl_cert:SSL 证书的路径,仅当协议设置为 https 时才应用。
- secretkey_path:用于在复制策略中加密或解密远程 register 密码的密钥路径。
这些参数对于更新是可选的,即用户可以将其保留为默认值,并在启动 Harbor 后在 Web UI 上进行更新。
如果进入 Harbor.cfg,只会在第一次启动 Harbor 时生效,随后对这些参数的更新,Harbor.cfg 将被忽略。
注意:如果选择通过 UI 设置这些参数,请确保在启动 Harbor 后立即执行此操作。
- Email:Harbor 需要该参数才能向用户发送“密码重置”电子邮件,并且只有在需要该功能时才启用。请注意,在默认情况下 SSL 连接时没有启用。如果 SMTP 服务器需要 SSL,但不支持 STARTTLS,那么应该通过设置启用 SSL email_ssl = TRUE。
- harbor_admin_password:管理员的初始密码,只在 Harbor 第一次启动时生效。之后, 此设置将被忽略,并且应在 UI 中设置管理员的密码。请注意,默认的用户名/密码是admin/Harbor12345。
- auth_mode:使用的认证类型,默认情况下,它是 db_auth,即凭据存储在数据库中。对于LDAP身份验证,请将其设置为 ldap_auth。
- self_registration:启用/禁用用户注册功能。禁用时,新用户只能由 Admin 用户创建,只有管理员用户可以在 Harbor 中创建新用户。注意:当 auth_mode 设置为 ldap_auth 时,自注册功能将始终处于禁用状态,并且该标志被忽略。
- Token_expiration:由令牌服务创建的令牌的到期时间(分钟),默认为 30 分钟。
- project_creation_restriction:用于控制哪些用户有权创建项目的标志。默认情况下,每个人都可以创建一个项目。 如果将其值设置为“adminonly”,那么只有 admin 可以创建项目。
- verify_remote_cert:打开或关闭,默认打开。此标志决定了当Harbor与远程 register 实例通信时是否验证 SSL/TLS 证书。 将此属性设置为 off 将绕过 SSL/TLS 验证,这在远程实例具有自签名或不可信证书时经常使用。
cd /usr/local/harbor
docker-compose down -v
vim harbor.yml #只能修改可选参数
#运行 prepare 脚本来填充配置
./prepare
#重新创建并启动 Harbor 的实例
docker-compose up -d
#如果有以下报错,需要开启防火墙 firewalld 服务解决
Creating network "harbor_harbor" with the default driver
ERROR: Failed to Setup IP tables: Unable to enable SKIP DNAT rule: (iptables failed: iptables --wait -t nat -I DOCKER -i br-b53c314f45e8 -j RETURN: iptables: No chain/target/match by that name.
(exit status 1))
systemctl restart firewalld.service
docker-compose up -d
cd /usr/local/harbor
docker-compose down -v
持久数据,如镜像,数据库等在宿主机的/data/目录下。
日志在宿主机的/var/log/Harbor/目录下。
ls /data/registry/docker/registry/v2/repositories/myproject-test
cd /data/registry/docker/registry/v2/repositories/myproject-test
tar zcvf fsj-registry.tar.gz ./*
#如需重新部署,需要移除 Harbor 服务容器全部数据
cd /usr/local/harbor
docker-compose down -v
rm -r /data/database
rm -r /data/registry