Docker Harbor 私有仓库

一、Harbor 概述

1. Harbor 的概念

Harbor 是一个由 VMware 公司开源的企业级 Docker Registry 项目，旨在帮助用户快速搭建一个企业级的 Docker Registry 服务。

Harbor 基于 Docker 公司开源的 Registry，并提供了一些企业用户需求的功能，包括图形管理界面、基于角色的访问控制（Role Based Access Control）、AD/LDAP集成和审计日志等。此外，Harbor 还原生地支持中文，便于中文用户使用和管理。

• 图形管理界面： Harbor 提供了一个易于使用的图形化管理界面，使用户能够方便地管理容器镜像仓库、访问控制和其他配置项。通过界面，可以轻松进行仓库的创建、删除、搜索和浏览镜像等操作。
• 基于角色的访问控制（RBAC）： Harbor 支持基于角色的访问控制，可以根据用户角色和权限来管理对镜像仓库的访问。通过 RBAC，可以细粒度地控制用户可以执行的操作，保证安全性和合规性。
• AD/LDAP集成： Harbor 可以与 Active Directory (AD) 或 LDAP 进行集成，实现单一登录和用户验证。这允许企业用户直接通过其现有的身份验证系统来管理和访问 Harbor。
• 审计日志： Harbor 提供了审计日志功能，记录用户的操作和系统事件。这对于安全审计、故障排除和合规性要求非常重要。通过审计日志，可以追踪和监控用户的活动以及系统的运行情况。
• 多租户支持： Harbor 支持创建多个租户，这样不同的团队或组织可以在同一个 Harbor 实例中独立管理和使用自己的镜像仓库。每个租户都有自己的访问控制和资源隔离。
• 安全扫描： Harbor 集成了容器镜像漏洞扫描工具，可以对上传的镜像进行漏洞扫描并生成报告。这帮助用户及早发现和解决镜像中的安全问题，并保证部署的应用程序的安全性。
• 镜像签名： Harbor 支持镜像的数字签名，确保镜像的完整性和来源的可信度。这可以防止恶意篡改和确保只有经过验证的镜像被部署。

Harbor 的各个组件都以 Docker 容器的形式进行构建，并可以使用 Docker Compose 来进行部署。用于部署 Harbor 的 Docker Compose 模板位于 harbor/docker-compose.yml 文件中。

2. Harbor 的特性

• 基于角色控制： Harbor 采用基于项目的角色控制机制，可以根据用户在项目中的角色来管理其对仓库和镜像的访问权限。这样可以实现细粒度的访问控制，并保障数据安全。
• 镜像复制策略： Harbor 支持镜像的复制和同步功能，允许将镜像从一个 Harbor 实例复制到另一个实例，以实现多地域或多部署场景下的镜像同步和管理。
• LDAP/AD集成： Harbor 可以与企业内部的 LDAP/AD 相集成，使用现有的身份验证系统进行用户认证和管理，简化用户的登录和管理流程。
• 镜像删除和垃圾回收： Harbor 允许用户删除不再需要的镜像，并提供垃圾回收机制来释放占用的存储空间，确保资源的有效利用。
• 图形化用户界面： Harbor 提供了直观的图形化用户界面，用户可以通过浏览器访问并浏览、搜索和管理镜像仓库和项目，方便用户操作和管理。
• 审计管理： Harbor 记录并追踪所有针对镜像仓库的操作，提供审计日志和审计功能，方便管理员对系统的操作进行监控和管理。
• 支持 RESTful API： Harbor 提供了丰富的 RESTful API，管理员可以通过 API 对 Harbor 进行更多操作，从而实现与其他管理软件的集成和自动化操作。
• Harbor 和 Docker Registry 的关系： Harbor 在 Docker Registry 的基础上进行封装和扩展，添加了许多额外的功能和特性，使其更适用于企业级的需求，提供更全面的镜像仓库管理解决方案。

3. Harbor 的构成

（1）认证方式

令牌认证（单向）： 令牌认证是基于 Token 的认证方式，通过生成一个令牌并将其用作身份验证凭据来访问 Harbor。这种认证方式一般用于与 Harbor API 进行交互，可以在登录后获取令牌并将其用于后续的 API 访问。

用户密码认证（双向）： 用户密码认证是最常见的认证方式，用户可以使用用户名和密码进行身份验证，登录到 Harbor 的图形化界面或通过命令行工具进行操作。这种认证方式需要用户提供正确的用户名和密码才能获得访问权限。

SSL 双向认证（双向）： SSL 双向认证也被称为客户端证书认证，是一种更安全的认证方式。在 SSL 双向认证中，不仅服务器要验证客户端的身份，客户端也要验证服务器的身份。双向认证需要客户端和服务器之间交换证书，确保双方的身份真实有效。

（2）六个组件

Harbor在架构上主要有Proxy、 Registry、 Core services、 Database (Harbor-db) 、Log collector ( Harbor-log)、Job services六个组件

Proxy： Proxy 是 Harbor 的反向代理组件，负责将来自浏览器和 Docker 客户端的请求转发给后端的不同服务。它起到了路由和负载均衡的作用。

Registry： Registry 是主要的核心组件，负责存储和管理 Docker 镜像，并处理 Docker push/pull 命令。Registry 在用户访问控制方面与 Token 服务进行交互，通过验证 Token 来实现对镜像的权限控制。

Core services： Core services 是 Harbor 的核心功能模块，包括以下三个服务：

• UI (harbor-ui)：提供图形化界面，帮助用户管理 Registry 上的镜像，并进行用户授权管理。
• WebHook：通过在 Registry 上配置 WebHook，及时获取镜像状态变化的通知，并将其传递给 UI 模块。
• Token 服务：负责为每个 Docker push/pull 命令签发合法的 Token，基于用户权限授予用户相应的访问权限。如果 Docker 客户端请求不包含 Token，将被重定向到 Token 服务以获取 Token 后再访问 Registry。

Database (harbor-db)： Database 是为 Core services 提供数据库服务的组件，负责存储用户权限、审计日志、Docker 镜像分组等相关数据。

Job services： Job services 主要用于镜像复制功能。它允许将本地镜像同步到远程 Harbor 实例上，实现镜像的复制和同步。

Log collector (harbor-log)： Log collector 负责收集其他组件的日志信息，并将其集中存储在一个地方，便于后续的日志分析和监控。

Harbor 的每个组件都是以 Docker 容器的形式构建的，因此，使用 Docker Compose 来对它进行部署。

总共分为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 部署

1. 环境

节点	主机IP	安装软件
Harbor 服务器	192.168.23.35	docker-ce docker-compose harbor-offline
client 服务器	192.168.23.5	docker-ce

docker-ce 安装

docker-compose 安装

注： docker-compoes 需要安装 1.7.1版本以上的

2. 下载或上传 Harbor 安装包

cd /opt
# 方法一
wget http://harbor.orientsoft.cn/harbor-1.2.2/harbor-offline-installer-v1.2.2.tgz

# 方法二
# 上传 harbor-offline-installer-v1.2.2.tgz 安装包
rz -E

3. 安装 Harbor

# 解压至 /usr/local
tar -zxf /opt/harbor-offline-installer-v1.2.2.tgz -C /usr/local/

4. 修改 harbor 安装的配置文件

vim /usr/local/harbor/harbor.cfg
# 第5行，修改设置为harbor服务器的ip地址或者域名
hostname = 192.168.23.35
# 第59行，指定管理员的初始密码，默认的用户名/密码是admin/Harbor123123
harbor_admin_password = Harbor123123

关于 Harbor.cfg 配置文件中有两类参数：

所需参数 和 可选参数

（1）所需参数：

这些参数需要在配置文件 harbor.cfg 中设置。如果用户更新它们并运行 install.sh 脚本重新安装 Harbour， 参数将生效。具体参数如下：

hostname： 用于访问用户界面和 register 服务。它应该是目标机器的 IP 地址或完全限定的域名（FQDN），例如 192.168.23.35 或 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 密码的密钥路径。

（2）可选参数

这些参数对于更新是可选的，即用户可以将其保留为默认值，并在启动 Harbor 后在 Web UI 上进行更新。如果进入 Harbor.cfg，只会在第一次启动 Harbor 时生效，随后对这些参数的更新，Harbor.cfg 将被忽略。

注意：如果选择通过 UI 设置这些参数，请确保在启动 Harbor 后立即执行此操作。具体来说，必须在注册或在 Harbor 中创建任何新用户之前设置所需的 auth_mode。当系统中有用户时（除了默认的 admin 用户）， auth_mode 不能被修改。 具体参数如下：

Email： Harbor 需要该参数才能向用户发送“密码重置”电子邮件，并且只有在需要该功能时才启用。请注意，在默认情况下 SSL 连接时没有启用。如果 SMTP 服务器需要 SSL，但不支持 STARTTLS，那么应该通过设置启用 SSL email_ssl = TRUE。

harbour_admin_password： 管理员的初始密码，只在 Harbour 第一次启动时生效。之后， 此设置将被忽略，并且应在 UI 中设置管理员的密码。请注意，默认的用户名/密码是admin/Harbor123123。

auth_mode： 使用的认证类型，默认情况下，它是 db_auth，即凭据存储在数据库中。对于LDAP身份验证，请将其设置为 ldap_auth。

self_registration：启用/禁用用户注册功能。禁用时，新用户只能由 Admin 用户创建，只有管理员用户可以在 Harbour 中创建新用户。注意：当 auth_mode 设置为 ldap_auth 时，自注册功能将始终处于禁用状态，并且该标志被忽略。

Token_expiration：由令牌服务创建的令牌的到期时间（分钟），默认为 30 分钟。

project_creation_restriction：用于控制哪些用户有权创建项目的标志。默认情况下，每个人都可以创建一个项目。如果将其值设置为“adminonly”，那么只有 admin 可以创建项目。

verify_remote_cert：打开或关闭，默认打开。此标志决定了当Harbor与远程 register 实例通信时是否验证 SSL/TLS 证书。 将此属性设置为 off 将绕过 SSL/TLS 验证，这在远程实例具有自签名或不可信证书时经常使用。

另外，默认情况下，Harbour 将镜像存储在本地文件系统上。在生产环境中，可以考虑 使用其他存储后端而不是本地文件系统，如 S3、Openstack Swif、Ceph 等对象存储。但需要更新 common/templates/registry/config.yml 文件。

区别：

• 所需参数：重新安装
• 可选参数：重新加载

5. 启动 Harbor

在配置好了 harbor.cfg 之后，执行 ./prepare 命令，为 harbor 启动的容器生成一些必要的文件（环境），再执行命令 ./install.sh 以 pull 镜像并启动容器

cd /usr/local/harbor/
./install.sh

6. 查看 Harbor 启动镜像

cd /usr/local/harbor/
docker-compose ps

三、上传镜像

1. 创建一个新项目

（1）浏览器访问：http://192.168.23.35 登录 Harbor WEB UI 界面，默认的管理员用户名和密码是 admin/Harbor123123

（2）输入用户名和密码登录界面后可以创建一个新项目。点击“+项目”按钮

（4）此时可使用 Docker 命令在本地通过 127.0.0.1 来登录和推送镜像。默认情况下，Registry 服务器在端口 80 上侦听。

（5）登录 Harbor

docker login -u admin -p Harbor123123 http://127.0.0.1

2. 下载镜像进行测试

docker pull nginx

3. 将镜像打标签

格式：docker tag 镜像:标签 仓库IP/项目名称/镜像名:标签

docker tag nginx:latest 127.0.0.1/myproject/nginx:v1

4. 上传镜像到 Harbor

docker push 127.0.0.1/myproject/nginx:v1

5. Harbor web 界面查看镜像

在 Harbor 界面 myproject-kgc 目录下可看见此镜像及相关信息

四、客户端上传镜像

以上操作都是在 Harbor 服务器本地操作。如果其他客户端登录到 Harbor，就会报如下错误。出现这问题的原因为Docker Registry 交互默认使用的是 HTTPS，但是搭建私有镜像默认使用的是 HTTP 服务，所以与私有镜像交互时出现以下错误。

docker login -u admin -p Harbor123123 http://192.168.23.35
WARNING! Using --password via the CLI is insecure. Use --password-stdin.
Error response from daemon: Get https://192.168.23.35/v2/: dial tcp 192.168.23.35:443: connect: connection refused

1. 在 Docker 客户端配置操作

解决办法是： 在 Docker server 启动的时候，增加启动参数，默认使用 HTTP 访问。

vim /usr/lib/systemd/system/docker.service
--13行--修改
ExecStart=/usr/bin/dockerd -H fd:// --insecure-registry 192.168.23.35 --containerd=/run/containerd/containerd.sock
或
ExecStart=/usr/bin/dockerd --insecure-registry 192.168.23.35

# 重启 Docker，再次登录
systemctl daemon-reload
systemctl restart docker

# 再次登录 Harbor
docker login -u admin -p Harbor123123 http://192.168.23.35
WARNING! Using --password via the CLI is insecure. Use --password-stdin.
WARNING! Your password will be stored unencrypted in /root/.docker/config.json.
Login Succeeded
# 将自动保存凭据到/root/.docker/config.json，下次登录时可直接使用凭据登录 Harbor

2. 下载镜像进行测试

docker pull 192.168.23.35/myproject/nginx:v1

3. 上传镜像镜像进行测试

docker pull cirros
docker tag cirros:latest 192.168.23.35/myproject/cirros:v1
docker push 192.168.23.35/myproject/cirros:v1

4. Harbor web 界面查看镜像

刷新 Harbor 的 Web 管理界面进行查看，会发现 myproject 项目里面有两个镜像

五、维护管理 Harbor

1. 通过 Harbor Web 创建项目

在 Harbor 仓库中，任何镜像在被 push 到 regsitry 之前都必须有一个自己所属的项目。
单击“+项目”，填写项目名称，项目级别若设置为"私有"，则不勾选。如果设置为公共仓库，则所有人对此项目下的镜像拥有读权限，命令行中不需要执行"Docker login"即可下载镜像，镜像操作与 Docker Hub 一致。

2. 创建 Harbor 用户

（1）创建用户并分配权限

在 Web 管理界面中单击系统管理 -> 用户管理 -> +用户，填写用户名为“user1”，邮箱为“user1@test.com”，全名为“user1”，密码为“Ab123123”，注释为“管理员”（可省略）。

附：用户创建成功后，单击左侧“…”按钮可将上述创建的用户设置为管理员角色或进行删除操作，本例不作任何设置。

（2）添加项目成员

单击项目 -> myproject-> 成员 -> + 成员，填写上述创建的用户 user1 并分配角色为“开发人员”。

附：此时单击左侧“…”按钮仍然可对成员角色进行变更或者删除操作

（3）在客户端上使用普通账户操作镜像

删除上述打标签的本地镜像

docker rmi 192.168.23.35/myproject/cirros:v1

先退出当前用户，然后使用上述创建的账户 user1 登录

# 登出
docker logout 192.168.23.35

# 登录
docker login 192.168.23.35
# 或
docker login -u user1 -p Ab123123 http://192.168.23.35

3. 下载和上传镜像进行测试

docker pull 192.168.23.35/myproject/cirros:v1

docker tag cirros:latest 192.168.23.35/myproject/cirros:v2
docker push 192.168.23.35/myproject/cirros:v2

4. 查看镜像

Web 界面查看

5. 修改 Harbor.cfg 配置文件

要更改 Harbor 的配置文件中的可选参数时，请先停止现有的 Harbor实例并更新 Harbor.cfg；然后运行 prepare 脚本来填充配置； 最后重新创建并启动 Harbor 的实例。

使用 docker-compose 管理 Harbor 时，必须在与 docker-compose.yml 相同的目录中运行。

cd /usr/local/harbor
docker-compose down -v

# 只能修改可选参数
vim harbor.cfg

./prepare

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

六、镜像迁移

1. 把项目中的镜像数据进行打包

持久数据，如镜像，数据库等在宿主机的/data/目录下，日志在宿主机的/var/log/Harbor/目录下

ls /data/registry/docker/registry/v2/repositories/myproject
cd /data/registry/docker/registry/v2/repositories/myproject
tar zcvf registry.tar.gz ./*

2. 部署新的 Harbor 服务器

部署新的 Harbor 服务器

部署方法与之前一致

# 原 Harbor 服务器
scp /data/registry/docker/registry/v2/repositories/myproject/myproject.tar.gz root@192.168.23.40:/opt

注：如需重新部署，需要移除 Harbor 服务容器全部数据

移除 Harbor 服务容器同时保留镜像数据/数据库，并进行迁移

在原Harbor服务器上操作

移除 Harbor 服务容器

cd /usr/local/harbor
docker-compose down -v

cd /usr/local/harbor
docker-compose down -v
rm -r /data/database
rm -r /data/registry

3. 迁移

新 Harbor

解压压缩包

mkdir -p /data/registry/docker/registry/v2/repositories/myproject
cd /opt
tar -zxf myproject.tar.gz -C /data/registry/docker/registry/v2/repositories/myproject/

服务器重启

cd /usr/local/harbor/
docker-compose down -v
./install.sh

4. Harbor web 界面查看镜像

刷新 Harbor 的 Web 管理界面进行查看

http://192.168.23.40

注：若出不来，重启服务器

reboot