This is a package for querying the size of repositories in a GitLab registry.
Project description
Introduction
GitLab-Registry-Usage is a package for querying the sizes of Docker repositories stored in a GitLab registry. The package has been created because it is not possible to monitor sizes of GitLab registry repositories with GitLab web monitoring tools (GitLab version <= 10.5.4).
Installation
The latest version is available from PyPI:
pip install gitlab-registry-usage
Usage
Command Line Interface
After installing with pip, a gitlab-registry-usage command is available:
$ gitlab-registry-usage --help
usage: gitlab-registry-usage [-h] [-g GITLAB_SERVER] [-r REGISTRY_SERVER]
[-s {name,size,disksize}] [-c CREDENTIALS_FILE]
[-u USERNAME] [-V]
gitlab-registry-usage is a utility for querying the memory usage of repositories in a GitLab registry.
optional arguments:
-h, --help show this help message and exit
-g GITLAB_SERVER, --gitlab-server GITLAB_SERVER
GitLab server hostname (for example `mygitlab.com`)
-r REGISTRY_SERVER, --registry-server REGISTRY_SERVER
GitLab registry server hostname (for example
`registry.mygitlab.com`)
-s {name,size,disksize}, --sort {name,size,disksize}
sorting order (default: name)
-c CREDENTIALS_FILE, --credentials-file CREDENTIALS_FILE
path to a file containing username and password/access
token (on two separate lines)
-u USERNAME, --user USERNAME
user account for querying the GitLab API (default:
root)
-V, --version print the version number and exit
You should specify a GitLab server hostname (-g), a GitLab registry server hostname (-r) and either a credentials file (-c) or username (-u) and password (read from stdin).
API
The module offers a high level GitLabRegistry class to query the repository catalog and repository sizes. This example prints all repositories, tags and their sizes:
from gitlab_registry_usage import GitLabRegistry
# TODO: set these values!
gitlab_base_url = ''
registry_base_url = ''
username = 'root'
access_token = '0000000000'
gitlab_registry = GitLabRegistry(
gitlab_base_url, registry_base_url, username, access_token
)
for repository in gitlab_registry.repository_tags.keys():
repository_tags = gitlab_registry.repository_tags[repository]
repository_size = gitlab_registry.repository_sizes[repository]
repository_disk_size = gitlab_registry.repository_disk_sizes[repository]
tag_sizes = gitlab_registry.tag_sizes[repository]
tag_disk_sizes = gitlab_registry.tag_disk_sizes[repository]
if (
repository_tags is not None and repository_size is not None
and repository_disk_size is not None and tag_sizes is not None
and tag_disk_sizes is not None
):
print(
'{}: repository size: {}, repository disk size: {}'.format(
repository, repository_size, repository_disk_size
)
)
for tag in repository_tags:
print(
'{}: tag size: {}, tag disk size: {}'.format(
tag, tag_sizes[tag], tag_disk_sizes[tag]
)
)
else:
print('{}: no further information available'.format(repository))
print()
print(
('total size: {}, total disk size: {}').format(
gitlab_registry.total_size, gitlab_registry.total_disk_size
)
)
The method delete_image can be used to delete a particular image if the corresponding SHA256 hash is known.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gitlab-registry-usage-0.2.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56fab62d24c5793cd81a4d15ca6bb33163aec41a47acc6f46c1aa249dbd54892 |
|
MD5 | f345135c354d8533c9d1bd9b31ab2620 |
|
BLAKE2b-256 | 6c2fde517d859037d73711b43edbd1af936cdb36b58ee520d2340fd8dc6b890a |
Hashes for gitlab_registry_usage-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b68d86019a92c0cb15c1128aae15fb408a5852b5813d5e33473cd97f8ac051a |
|
MD5 | 72cbf9c380807c32c95e1125c41d94ce |
|
BLAKE2b-256 | ccdca6cfe5816e506e771f0a03e7e596d60a557f94943e4ab202e94f03e79d5d |