文章目录
- Harbor
- 特性
- Harbor构成
- Harbor部署与管理
- Harbor 部署实例
- 环境准备
- 1. 部署 Docker-Compose 服务
- 2. 部署 Harbor 服务
- (1) 下载并解压 Harbor 安装程序
- (2) 修改 Harbor 配置文件
- 3. 启动 Harbor
- 4. 查看 Harbor 启动镜像
- 5. 创建一个新项目
- 6. 在其他客户端上传镜像
- 维护管理 Harbor 指南
- 通过 Harbor Web 创建项目
- 创建 Harbor 用户及权限管理
- 查看日志
- 修改 Harbor 配置文件
- 移除 Harbor 服务容器并保留镜像数据/数据库
- 移除 Harbor 服务容器全部数据并重新部署
Harbor
Harbor是VMware公司开源的企业级Docker Registry项目,旨在帮助用户快速搭建一个企业级的Docker Registry服务。
基础:Harbor以Docker公司开源的Registry为基础,并扩展了多种企业所需的功能,如图形管理UI、基于角色的访问控制等。
组件构建:Harbor的每个组件都是以Docker容器的形式构建的,使用docker-compose进行部署。
特性
- 基于角色控制:用户和仓库都是基于项目进行组织的,用户在项目中可以拥有不同的权限。
- 镜像复制策略:镜像可以在多个Harbor实例之间进行复制(同步),适用于负载均衡、高可用、混合云和多云等场景。
- LDAP/AD支持:Harbor可以集成企业内部已有的AD/LDAP,用于对已经存在的用户进行认证和管理。
- 图形化用户界面:用户可以通过浏览器浏览、搜索镜像仓库,并对项目进行管理。
- 审计管理:所有针对镜像仓库的操作都可以被记录追溯,用于审计管理。
- RESTful API支持:提供给管理员对Harbor的更多操控,使得与其他管理软件集成变得更容易。
- 镜像删除和垃圾回收:支持镜像的删除操作,并可以回收镜像占用的空间。
Harbor构成
Harbor在架构上主要有以下几个组件:
- Proxy:一个nginx的前端代理,负责将来自浏览器、docker clients的请求转发到后端不同的服务上。
- Registry:负责储存Docker镜像,并处理Docker push/pull命令。同时,它会强制用户的每次Docker pull/push请求都要携带一个合法的Token,并通过公钥对Token进行解密验证。
- Core services:Harbor的核心功能组件,主要提供UI、WebHook和Token服务。
- UI(harbor-ui):提供图形化界面,帮助用户管理Registry上的镜像,并对用户进行授权。
- WebHook:及时获取Registry上image状态变化的情况,并把状态变化传递给UI模块。
- Token服务:根据用户权限给每个Docker push/pull命令签发Token。
- Database(harbor-db):为core services提供数据库服务,负责储存用户权限、审计日志、Docker镜像分组信息等数据。
- Job services:主要用于镜像复制,使本地镜像可以被同步到远程Harbor实例上。
- Log collector(harbor-log):负责收集其他组件的日志,并进行统一管理。
此外,Harbor的整体架构从上到下还分为代理层、功能层和数据层。其中,代理层负责接收不同类型的客户端请求;功能层包括Portal(基于Angular的前端应用)、Core(封装了Harbor绝大部分的业务逻辑)、JobService(异步任务组件)等;数据层则包括Docker Distribution(实现Artifact的读写和存取等功能)、PostgreSQL(存储Harbor的应用数据)等。
Harbor部署与管理
-
部署前准备:
- 确保已经安装了Docker引擎(版本在1.10或以上)、Python(版本在2.7或以上)和Docker Compose(版本在1.6.0或以上)。
- 从Harbor的官方网站或GitHub仓库下载Harbor的安装包,并解压到本地。
-
部署Harbor服务:
- 在解压后的目录中,找到并编辑harbor.yml或harbor.cfg文件,进行必要的配置。配置项包括数据库连接信息、管理员密码、hostname(用于访问用户界面和register服务的IP地址或完全限定的域名)等。
- 运行install.sh脚本进行安装。脚本会进行一系列的配置和部署工作,包括创建数据库、生成证书等。
- 安装完成后,通过运行相应命令启动Harbor服务。
-
管理Harbor:
- 启动成功后,可以通过浏览器访问Harbor的管理界面(默认地址通常是http://),并使用初始用户名admin和密码登录。
- 登录后,可以创建自己的镜像仓库,并开始使用Harbor进行容器镜像的管理和分发。
- 在管理界面中,还可以进行用户管理、权限设置、审计日志查看等操作。
-
维护与更新:
- 需要定期备份数据和配置信息,以防止数据丢失和意外情况的发生。
- 需要及时更新和维护Harbor,以修复漏洞和提升安全性。
- 需要根据业务需求和实际情况,进行合理的配置和管理,以确保Harbor的高可用性和稳定性。
Harbor 部署实例
环境准备
- Harbor服务器: 192.168.80.10 (docker-ce, docker-compose, harbor-offline-v1.2.2)
- Client服务器: 192.168.80.15 (docker-ce)
1. 部署 Docker-Compose 服务
# 下载 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
2. 部署 Harbor 服务
(1) 下载并解压 Harbor 安装程序
# 下载 Harbor 安装包
wget http://harbor.orientsoft.cn/harbor-1.2.2/harbor-offline-installer-v1.2.2.tgz# 解压到 /usr/local/
tar zxvf harbor-offline-installer-v1.2.2.tgz -C /usr/local/
(2) 修改 Harbor 配置文件
# 编辑 harbor.cfg
vim /usr/local/harbor/harbor.cfg# 修改以下参数
hostname = 192.168.80.10 #--5行--修改,设置为Harbor服务器的IP地址或者域名
harbor_admin_password = Harbor12345 #--59行--指定管理员的初始密码,默认的用户名/密码是admin/Harbor12345
关于 Harbor.cfg 配置文件中有两类参数:所需参数和可选参数
1、所需参数:这些参数需要在配置文件 Harbor.cfg 中设置。如果用户更新它们并运行 install.sh 脚本重新安装 Harbor, 参数将生效。具体参数如下:
- hostname:用于访问用户界面和 register 服务。它应该是目标机器的 IP 地址或完全限定的域名(FQDN),例如 192.168.80.10 或 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。
- 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 镜像存储到其他的磁盘路径,可以修改这个参数。
3. 启动 Harbor
# 进入 Harbor 目录
cd /usr/local/harbor/# 准备环境
./prepare# 安装并启动 Harbor
./install.sh
4. 查看 Harbor 启动镜像
# 查看容器状态
docker-compose ps# 启动/停止/重启服务
docker-compose up -d
docker-compose stop
docker-compose restart
5. 创建一个新项目
- 浏览器访问:
http://192.168.80.10
登录 Harbor WEB UI 界面,默认的管理员用户名和密码是admin/Harbor12345
- 输入用户名和密码登录界面后可以创建一个新项目。点击“+项目”按钮
- 填写项目名称为“
myproject-kgc
”,点击“确定”按钮,创建新项目 - 此时可使用 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-kgc/nginx:v1//上传镜像到 Harbor
docker push 127.0.0.1/myproject-kgc/nginx:v1
- 在 Harbor 界面
myproject-kgc
目录下可看见此镜像及相关信息
6. 在其他客户端上传镜像
以上操作都是在 Harbor 服务器本地操作。如果其他客户端登录到 Harbor,就会报如下错误。出现这问题的原因为Docker Registry 交互默认使用的是 HTTPS,但是搭建私有镜像默认使用的是 HTTP 服务,所以与私有镜像交互时出现以下错误。
docker login -u admin -p Harbor12345 http://192.168.80.10
WARNING! Using --password via the CLI is insecure. Use --password-stdin.
Error response from daemon: Get https://192.168.80.10/v2/: dial tcp 192.168.80.10:443: connect: connection refused
配置 Docker 客户端
# 修改 Docker 服务配置
vim /usr/lib/systemd/system/docker.service
#--13行--修改
ExecStart=/usr/bin/dockerd -H fd:// --insecure-registry 192.168.80.10 --containerd=/run/containerd/containerd.sock
#或
ExecStart=/usr/bin/dockerd --insecure-registry 192.168.80.10# 重启 Docker 服务
systemctl daemon-reload
systemctl restart docker# 再次登录 Harbor
docker login -u admin -p Harbor12345 http://192.168.80.10
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#下载镜像进行测试
docker pull 192.168.80.10/myproject-kgc/nginx:v1#上传镜像进行测试
docker pull cirros
docker tag cirros:latest 192.168.80.10/myproject-kgc/cirros:v2
docker push 192.168.80.10/myproject-kgc/cirros:v2
刷新 Harbor 的 Web 管理界面进行查看,会发现 myproject-kgc 项目里面有两个镜像
维护管理 Harbor 指南
通过 Harbor Web 创建项目
在 Harbor 仓库中,任何镜像在被 push 到 regsitry 之前都必须有一个自己所属的项目。
- 步骤:
- 登录 Harbor Web 界面。
- 单击“+项目”按钮。
- 填写项目名称。
- 若设置为私有项目,不勾选公共仓库选项;若设置为公共项目,则所有人可以无需登录即可读取项目下的镜像。
创建 Harbor 用户及权限管理
-
创建用户:
- 在 Web 管理界面中,单击“系统管理” -> “用户管理” -> “+用户”。
- 填写用户名(kgc-zhangsan)、邮箱(kgc-zhangsan@kgc.com)、全名(zhangsan)、密码(Abc123456)和注释(管理员,可省略)。
- 用户创建成功后,不进行角色设置。
-
角色权限:
角色 权限说明 访客 对于指定项目拥有只读权限 开发人员 对于指定项目拥有读写权限,但无删除权限 维护人员 对于指定项目拥有读写权限,能修改其他配置(如创建 Webhooks) 项目管理员 拥有读写权限,同时拥有用户管理、镜像扫描等管理权限 -
添加项目成员:
- 单击“项目” -> “myproject-kgc” -> “成员” -> “+成员”。
- 添加用户 kgc-zhangsan 并分配为“开发人员”角色。
-
客户端操作:
# 删除本地镜像 docker rmi 192.168.80.10/myproject-kgc/cirros:v2# 退出当前用户,登录新账户 docker logout 192.168.80.10 login 192.168.80.10#或 docker login -u kgc-zhangsan -p Abc123456 http://192.168.80.10# 下载和上传镜像进行测试 docker pull 192.168.80.10/myproject-kgc/cirros:v2 docker tag cirros:latest 192.168.80.10/myproject-kgc/cirros:v3 docker push 192.168.80.10/myproject-kgc/cirros:v3
查看日志
- Web 界面日志:
- 操作日志按时间顺序记录用户相关操作。
修改 Harbor 配置文件
- 步骤:
- 停止 Harbor 实例:
cd /usr/local/harbor && docker-compose down -v
- 修改配置文件:
vim harbor.cfg
(只能修改可选参数) - 运行 prepare 脚本:
./prepare
- 启动 Harbor 实例:
docker-compose up -d
- 如果有以下报错,需要开启防火墙 firewalld 服务解决
- 停止 Harbor 实例:
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
移除 Harbor 服务容器并保留镜像数据/数据库
- 步骤:
- 移除 Harbor 服务容器:
cd /usr/local/harbor && docker-compose down -v
- 打包镜像数据:
ls /data/registry/docker/registry/v2/repositories/myproject-kgc cd /data/registry/docker/registry/v2/repositories/myproject-kgc tar zcvf kgc-registry.tar.gz ./*
移除 Harbor 服务容器全部数据并重新部署
- 步骤:
- 移除 Harbor 服务容器:
cd /usr/local/harbor && docker-compose down -v
- 删除数据库和镜像数据目录:
rm -r /data/database rm -r /data/registry
- 移除 Harbor 服务容器: