This is a package for querying the size of repositories in a GitLab registry.
Project description
GitLab-Registry-Usage
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
If you use Arch Linux or one of its derivatives, you can also install gitlab-registry-usage
from the
AUR:
yay -S python-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] [-v | --debug]
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
-v, --verbose be verbose
--debug print debug messages
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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15c53364d800080f0fb7ecdcf74f083157557cf4599d7a6a3be5d497a48ebc9f |
|
MD5 | 7a1946d548f12bdda8d27009aa02d898 |
|
BLAKE2b-256 | e06813061eb3be10dc2122fbfea294417ec12b3f8a4a2bbc16682dbe88115b6e |
Hashes for gitlab_registry_usage-0.2.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed70b2dccb3b81f415eef2c7695b41eab8fec9f290e4dc1272f9b98404dd9a3b |
|
MD5 | e054087f21d4d9a6839c7f1ab71812ee |
|
BLAKE2b-256 | 8250b7a54cac3531df167d09cff88e8ca5d3c0c3148473e7d4fe3f82f3fc8ce9 |