用于查询gitlab注册表的存储库大小的restful web服务。
gitlab-registry-usage-rest的Python项目详细描述
简介
gitlab registry usage rest是一个定期收集 gitlab注册表服务器的存储库信息(名称、标记、大小) 并通过安全的RESTful HALapi提供数据。最初 身份验证需要LDAP服务器。后续查询是安全的 通过json web令牌(jwt)。
安装
最新版本可从pypi获得:
pip install gitlab-registry-usage-rest gitlab-registry-usage-rest --help
或来自DockerHub:
docker run sciapp/gitlab-registry-usage-rest:latest --help
用法
gitlab注册表用法rest需要配置文件才能运行。 默认路径是/etc/gitlab_registry_usage_rest.conf,但可以是 使用-c命令行开关更改。要开始,您可以运行
gitlab-registry-usage-rest --print-default-config
并编辑此默认配置以适应您的环境。
如果您想使用Docker存储库,可以绑定 使用-v开关的本地配置文件:
docker run -v "$(pwd)/gitlab_registry_usage_rest.conf:/etc/gitlab_registry_usage_rest.conf" sciapp/gitlab-registry-usage-rest:latest
注意:Docker需要本地配置的绝对路径 文件。
服务器提供这些api端点:
/auth_token:接受具有基本身份验证(和有效LDAP)的请求 并返回用于进一步使用API的身份验证令牌。全部 其他终结点只接受具有有效^{tt5}的请求$ 授权标题:
Authorization: Bearer <token>
/repositories:列出repositories集合的属性。 目前,只包含上次数据刷新的时间戳:
{"timestamp":1521796487.7021387}
/repositories/<repository_name>:查询特定 存储库:
{"name":"scientific-it-systems/administration/gitlab-registry-usage-rest","size":39899199,"disk_size":39898911}
/repositories/<repository_name>/tags:集合的终结点 存储库标记,当前没有任何内容。
/repositories/<repository_name>/tags/<tag_name>:列出属性 存储在存储库中的标记图像:
{"name":"latest","size":39899199,"disk_size":39898911}
此外,所有api端点(除了/auth_token)都提供 _embedded和一个_links属性(如果与查询一起请求) 字符串:
?embed=true&links=true
嵌入键也可以采用整数,而不是布尔值 只请求特定级别的嵌入式资源的数字。
链接可用于在相关资源之间轻松导航。嵌入的 使用 一个得到请求。因此,请求
/repositories?embed=true
一次返回所有资源。