ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

Harbor 全局标签管理实战:系统管理员创建、编辑与删除标签的完整流程与源码解析

Harbor 全局标签管理实战:系统管理员创建、编辑与删除标签的完整流程与源码解析 Harbor 全局标签管理实战系统管理员创建、编辑与删除标签的完整流程与源码解析【免费下载链接】harborAn open source trusted cloud native registry project that stores, signs, and scans content.项目地址: https://gitcode.com/GitHub_Trending/ha/harbor本篇技术指南围绕 Harbor 测试用例 11-01系统管理员管理全局级标签 展开系统讲解系统管理员System Admin如何在 Harbor 中完成全局级别标签的创建Create、编辑Update与删除Delete全流程并结合本仓库的 REST API 定义、Handler 实现、Manager/DAO 分层与数据库迁移脚本从 UI 操作与源码原理两个层面讲透标签这一核心元数据能力。读完本文你将掌握全局标签的完整 CRUD 操作、REST 调用方式及其底层数据模型与权限控制机制。标签体系Level 与 Scope 双维度理解在深入测试步骤之前先建立对 Harbor 标签体系的基本认知。从源码 src/pkg/label/model/model.go 可以看到标签Label模型包含以下关键字段字段类型说明IDint64标签唯一主键Namestring标签名称最长 128 字符不能为空Descriptionstring标签描述Colorstring标签颜色用于 UI 展示Levelstring标签级别s系统级或u用户级Scopestring标签范围g全局或p项目ProjectIDint64标签所属项目 ID全局标签为 0CreationTime/UpdateTimetime.Time创建 / 更新时间由 ORM 自动维护Deletedbool软删除标记其中Level与Scope的取值常量定义在 src/common/const.goLabelLevelSystem s系统级标签由 Harbor 内部逻辑使用LabelLevelUser u用户级标签即普通用户通过 UI/API 创建的标签LabelScopeGlobal g全局标签对所有项目可见仅系统管理员可管理LabelScopeProject p项目标签隶属于某个具体项目由项目成员按权限管理。本文讨论的全局级别标签即Scope g且Level u的用户级全局标签它与项目标签的本质区别在于全局标签不绑定任何项目ProjectID恒为 0创建后全 Harbor 实例内所有项目均可引用。模型上的Valid()校验方法见 model.go强制约束名称非空且不超过 128 字符Scope只能是g或p当Scope p时ProjectID必须大于 0——从侧面印证了全局标签ProjectID必须为 0 这一设计。测试用例 11-01 的验证目标测试用例 11-01-system-admin-manage-global-level-labels.md 属于 Harbor 测试用例集中的 Group11-Label 分组其核心目的是验证系统管理员可以对全局级标签执行完整的 CRUD创建、读取、更新、删除管理操作。该用例同时以用户指南作为参考文档并以必须有一个运行中且可访问的 Harbor 实例作为环境前提——这意味着整套验证既可以在真实部署环境中手工执行也可以作为功能回归测试的基准场景。测试步骤系统管理员管理全局标签步骤 1系统管理员登录 UI系统管理员admin 或具备系统管理员角色的用户登录 Harbor Web 门户。由于全局标签的增删改涉及系统级资源只有具备相应系统权限的账号才能执行后续操作——这一点在源码的权限校验中会得到印证详见下文源码级原理章节。步骤 2创建全局级标签登录后进入标签管理页面选择全局级别Global维度填写标签名称必填、描述与颜色后提交创建全局标签。对应的 REST 调用为POST /api/v2.0/labels请求体为LabelJSON 对象成功时返回201 Created并在响应头Location中给出新建资源的 URL见 swagger.yaml。一个可复制的curl示例curl -k -u admin:password -H Content-Type: application/json \ -X POST https://harbor-host/api/v2.0/labels \ -d { name: production-ready, description: 标识已验证可上生产的镜像, color: #00AA00, scope: g }请求体中scope取值为g表示创建全局标签。Level字段无需传参——服务端在CreateLabelHandler 中会强制将其置为LabelLevelUseru并把ProjectID归零。步骤 3编辑已创建的标签在标签列表中找到步骤 2 创建的标签点击编辑修改其名称、描述或颜色后保存。对应的 REST 调用为PUT /api/v2.0/labels/{label_id}见 swagger.yaml请求体仍为LabelJSON 对象curl -k -u admin:password -H Content-Type: application/json \ -X PUT https://harbor-host/api/v2.0/labels/1 \ -d { name: production-ready-v2, description: 标识已验证可上生产的镜像v2, color: #0088CC }需要注意编辑操作只允许修改Name、Description与Color三个属性Scope与ProjectID是不可变更的——这一限制直接由 Handler 实现决定详见下文。步骤 4删除已创建的标签在标签列表中选中该标签并执行删除。删除前请注意若该标签已被若干制品artifact引用Harbor 会先自动解除标签与所有制品之间的引用关系再删除标签本体。对应的 REST 调用为DELETE /api/v2.0/labels/{label_id}curl -k -u admin:password \ -X DELETE https://harbor-host/api/v2.0/labels/1预期结果测试用例对上述步骤给出了明确的预期步骤 2全局标签创建成功步骤 3全局标签更新成功步骤 4全局标签删除成功。可能存在的问题用例标注Possible Problems: None即该场景在标准部署下无已知阻塞性问题。实操中若遇到 401未认证/权限不足、404标签不存在或 409同名标签冲突均可从下述源码行为中找到根因。源码级原理一次标签 CRUD 的完整调用链围绕测试用例中的三步操作我们顺着Handler → Manager → DAO → 数据模型/数据库的分层结构逐一拆解底层实现。REST Handler 层权限校验与业务编排所有标签相关的 REST 端点由 src/server/v2.0/handler/label.go 中的labelAPI处理内部依赖label.Mgr标签管理器与project.Ctl项目控制器。创建CreateLabel见 label.go#L51-L73label.Level common.LabelLevelUser if label.Scope common.LabelScopeGlobal { label.ProjectID 0 } if err : lAPI.requireAccess(ctx, label, rbac.ActionCreate); err ! nil { ... } id, err : lAPI.labelMgr.Create(ctx, label)服务端强制把Level置为u用户级防止客户端伪造系统级标签全局标签Scope g的ProjectID被强制归零在入库前先执行requireAccess权限校验。权限校验requireAccess见 label.go#L192-L203是只有系统管理员能管理全局标签这一规则的具体落点switch label.Scope { case common.LabelScopeGlobal: return lAPI.RequireSystemAccess(ctx, action, rbac.ResourceLabel) case common.LabelScopeProject: return lAPI.RequireProjectAccess(ctx, label.ProjectID, action, subresources...) }即全局标签的任意操作Create/Read/Update/Delete都要求系统级ResourceLabel权限而项目标签则校验该项目内的标签资源权限。这正是测试用例中系统管理员这一角色的权限基础。更新UpdateLabel见 label.go#L140-L171label.Name labelData.Name label.Description labelData.Description label.Color labelData.Color if err : label.Valid(); err ! nil { ... } if err : lAPI.labelMgr.Update(ctx, label); err ! nil { ... }更新时仅将请求体中的Name、Description、Color回写到从数据库读取的原标签对象上随后重新执行Valid()校验并落库——Scope、ProjectID、Level等字段天然不可被修改。删除DeleteLabel见 label.go#L173-L190id : label.ID if err : lAPI.labelMgr.RemoveFromAllArtifacts(ctx, id); err ! nil { ... } if err : lAPI.labelMgr.Delete(ctx, id); err ! nil { ... }删除是两步走先调用RemoveFromAllArtifacts解除该标签与所有制品artifact的label_reference引用关系再调用Delete删除标签记录避免残留悬挂引用。列表查询ListLabels见 label.go#L91-L138scope参数必须是g或p否则返回 400查询条件固定携带Level u与Scope当scope p时必须携带project_id否则返回 400名称支持模糊匹配FuzzyMatchValue。这意味着通过 API 查询全局标签时请求形如curl -k -u admin:password \ https://harbor-host/api/v2.0/labels?scopegManager 层标签与引用的统一管理src/pkg/label/manager.go 定义Manager接口覆盖标签本身的生命周期Create/Get/Count/Update/Delete/List以及与制品的引用关系ListByArtifact/AddTo/RemoveFrom/RemoveAllFrom/RemoveFromAllArtifacts。其中RemoveFromAllArtifacts见 manager.go#L131-L138通过查询条件Keywords: {LabelID: labelID}批量删除label_reference表中的引用记录这正是删除标签时先清引用、再删本体的实现出处。该包通过全局实例var Mgr New()manager.go#L27-L28供 Handler 层直接注入使用。DAO 层ORM 持久化与唯一约束src/pkg/label/dao/dao.go 是数据访问实现Createdao.go#L76-L88ormer.Insert(label)插入记录若触发数据库唯一约束冲突则包装为label %s already exists错误——同名全局标签会被拒绝409Updatedao.go#L98-L112先刷新UpdateTime再更新同样处理重名冲突Deletedao.go#L114-L129按主键物理删除删除 0 行时报 404ListByArtifactdao.go#L143-L156通过harbor_label与label_reference联表查询某制品上的全部标签。数据模型与数据库表结构标签持久化涉及两张表均由 ORM 注册model.go#L26-L29harbor_label标签主表对应Label模型label_reference标签与制品的引用关系表对应Reference模型LabelIDArtifactID联合语义见 model.go#L67-L74。建表 SQL 位于 make/migrations/postgresql/0001_initial_schema.up.sql关键约束一目了然create table harbor_label ( id SERIAL NOT NULL, name varchar(128) NOT NULL, description text, color varchar(16), level char(1) NOT NULL, -- s 系统级 / u 用户级 scope char(1) NOT NULL, -- g 全局 / p 项目 project_id int, creation_time timestamp default CURRENT_TIMESTAMP, update_time timestamp default CURRENT_TIMESTAMP, deleted boolean DEFAULT false NOT NULL, PRIMARY KEY(id), CONSTRAINT unique_label UNIQUE (name, scope, project_id) );其中UNIQUE (name, scope, project_id)保证了同一作用域下标签名唯一因为全局标签的project_id恒为 0所以全局标签之间不允许重名——这与 DAO 层将唯一约束冲突包装为already exists错误的逻辑完全对应。表上还创建了harbor_label_update_time_at_modtime触发器在UPDATE时自动刷新update_time。harbor_resource_label表见同文件后续定义以及 2.0 版本迁移中引入的label_reference外键见 0030_2.0.0_schema.up.sql共同构成了标签—资源关联的演进基础新版本中以 artifact 为粒度的label_reference替代了早期的资源标签表。测试用例的价值从手工验证到自动化回归Group11-Label 目录下的测试用例如本文件编号 11-01是 Harbor 功能验证体系的一部分与仓库中的 Robot Framework 用例tests/robot-cases/及 API 测试tests/apitests/python/相互补充。11-01 这类单步 UI 操作 预期结果的结构非常适合手工验收升级 Harbor 版本后快速回归标签管理功能转化为自动化用例可直接对照 swagger.yaml 中的POST /labels、PUT /labels/{label_id}、DELETE /labels/{label_id}三个端点编写脚本化断言与本文给出的curl示例一一对应作为权限模型的验证锚点确认系统级ResourceLabel权限的校验链路label.go#L192-L203没有被后续改动破坏。小结通过测试用例 11-01我们验证了 Harbor 系统管理员对全局级标签的完整管理能力UI 上三步操作即可完成创建、编辑与删除对应 REST 层为POST /labels、PUT /labels/{label_id}、DELETE /labels/{label_id}。从源码角度Levels/u与Scopeg/p双维度模型、Handler 层的系统权限强制校验、scope g时ProjectID强制归零、更新仅允许修改名称/描述/颜色、删除前先解除制品引用等细节共同构成了全局标签仅系统管理员可管理、对所有项目可见、全局唯一命名的行为边界。理解这条Handler → Manager → DAO → 数据库的调用链不仅有助于排查标签相关的 400/404/409 错误也能为你基于 Harbor 二次开发或编写自动化回归脚本提供直接依据。【免费下载链接】harborAn open source trusted cloud native registry project that stores, signs, and scans content.项目地址: https://gitcode.com/GitHub_Trending/ha/harbor创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表