Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/google/containerregistry

A set of Python libraries and tools for interacting with a Docker Registry.
https://github.com/google/containerregistry

docker docker-image docker-images docker-registry gcloud gcloud-sdk google-containers

Last synced: 3 months ago
JSON representation

A set of Python libraries and tools for interacting with a Docker Registry.

Host: GitHub
URL: https://github.com/google/containerregistry
Owner: google
License: apache-2.0
Archived: true
Created: 2017-03-09T17:22:40.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2021-02-08T20:17:40.000Z (over 3 years ago)
Last Synced: 2024-01-17T03:34:15.780Z (5 months ago)
Topics: docker, docker-image, docker-images, docker-registry, gcloud, gcloud-sdk, google-containers
Language: Python
Homepage: https://gcr.io
Size: 323 KB
Stars: 200
Watchers: 17
Forks: 130
Open Issues: 25
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Lists

awesome-stars - google/containerregistry
awesome-projects - containerregistry - A set of Python libraries and tools for interacting with a Docker Registry. (Python)

README

# `containerregistry`
[![Build Status](https://travis-ci.org/google/containerregistry.svg?branch=master)](https://travis-ci.org/google/containerregistry)

A set of Python libraries and tools for interacting with a Docker Registry.

Bazel users see
rules_docker, which relies heavily on these tools.

## puller.par

```sh
$ bazel run @containerregistry//:puller.par -- --help
```

```
usage: puller.par [-h] --name NAME --directory DIRECTORY [--os OS]
[--os-version OS_VERSION]
[--os-features [OS_FEATURES [OS_FEATURES ...]]]
[--architecture ARCHITECTURE] [--variant VARIANT]
[--features [FEATURES [FEATURES ...]]]
[--client-config-dir CLIENT_CONFIG_DIR]
[--stderrthreshold STDERRTHRESHOLD]

Pull images from a Docker Registry, faaaaast.

optional arguments:
-h, --help show this help message and exit
--name NAME The name of the docker image to pull and save.
Supports fully-qualified tag or digest references.
--directory DIRECTORY
Where to save the image's files.
--os OS For multi-platform manifest lists, specifies the
operating system.
--os-version OS_VERSION
For multi-platform manifest lists, specifies the
operating system version.
--os-features [OS_FEATURES [OS_FEATURES ...]]
For multi-platform manifest lists, specifies operating
system features.
--architecture ARCHITECTURE
For multi-platform manifest lists, specifies the CPU
architecture.
--variant VARIANT For multi-platform manifest lists, specifies the CPU
variant.
--features [FEATURES [FEATURES ...]]
For multi-platform manifest lists, specifies CPU
features.
--client-config-dir CLIENT_CONFIG_DIR
The path to the directory where the client
configuration files are located. Overiddes the value
from DOCKER_CONFIG
--stderrthreshold STDERRTHRESHOLD
Write log events at or above this level to stderr.
```

## pusher.par

```sh
$ bazel run @containerregistry//:pusher.par -- --help
```

```
usage: pusher.par [-h] --name NAME [--tarball TARBALL] [--config CONFIG]
[--manifest MANIFEST] [--digest DIGEST] [--layer LAYER]
[--stamp-info-file STAMP_INFO_FILE] [--oci]
[--client-config-dir CLIENT_CONFIG_DIR]
[--stderrthreshold STDERRTHRESHOLD]

Push images to a Docker Registry, faaaaaast.

optional arguments:
-h, --help show this help message and exit
--name NAME The name of the docker image to push.
--tarball TARBALL An optional legacy base image tarball.
--config CONFIG The path to the file storing the image config.
--manifest MANIFEST The path to the file storing the image manifest.
--digest DIGEST The list of layer digest filenames in order.
--layer LAYER The list of layer filenames in order.
--stamp-info-file STAMP_INFO_FILE
A list of files from which to read substitutions to
make in the provided --name, e.g. {BUILD_USER}
--oci Push the image with an OCI Manifest.
--client-config-dir CLIENT_CONFIG_DIR
The path to the directory where the client
configuration files are located. Overiddes the value
from DOCKER_CONFIG
--stderrthreshold STDERRTHRESHOLD
Write log events at or above this level to stderr.
```

## importer.par

```
$ bazel run @containerregistry//:importer.par -- --help
```

```
usage: importer.par [-h] --tarball TARBALL [--format {tar,tar.gz}] --directory
DIRECTORY [--stderrthreshold STDERRTHRESHOLD]

Import images from a tarball into our faaaaaast format.

optional arguments:
-h, --help show this help message and exit
--tarball TARBALL The tarball containing the docker image to rewrite
into our fast on-disk format.
--format {tar,tar.gz}
The form in which to save layers.
--directory DIRECTORY
Where to save the image's files.
--stderrthreshold STDERRTHRESHOLD
Write log events at or above this level to stderr.
```

## flatten.par

```sh
$ bazel run @containerregistry//:flatten.par -- --help
```

```
usage: flatten.par [-h] [--tarball TARBALL] [--config CONFIG]
[--digest DIGEST] [--layer LAYER]
[--uncompressed_layer UNCOMPRESSED_LAYER]
[--diff_id DIFF_ID] [--filesystem FILESYSTEM]
[--metadata METADATA] [--stderrthreshold STDERRTHRESHOLD]

Flatten container images.

optional arguments:
-h, --help show this help message and exit
--tarball TARBALL An optional legacy base image tarball.
--config CONFIG The path to the file storing the image config.
--digest DIGEST The list of layer digest filenames in order.
--layer LAYER The list of compressed layer filenames in order.
--uncompressed_layer UNCOMPRESSED_LAYER
The list of uncompressed layer filenames in order.
--diff_id DIFF_ID The list of diff_ids in order.
--filesystem FILESYSTEM
The name of where to write the filesystem tarball.
--metadata METADATA The name of where to write the container startup
metadata.
--stderrthreshold STDERRTHRESHOLD
Write log events at or above this level to stderr.
```

## appender.par

```sh
$ bazel run @containerregistry//:appender.par -- --help
```

```
usage: appender.par [-h] --src-image SRC_IMAGE --tarball TARBALL --dst-image
DST_IMAGE [--stderrthreshold STDERRTHRESHOLD]

Append tarballs to an image in a Docker Registry.

optional arguments:
-h, --help show this help message and exit
--src-image SRC_IMAGE
The name of the docker image to append to.
--tarball TARBALL The tarball to append.
--dst-image DST_IMAGE
The name of the new image.
--stderrthreshold STDERRTHRESHOLD
Write log events at or above this level to stderr.
```

## digester.par

```sh
$ bazel run @containerregistry//:digester.par -- --help
```

```
usage: digester.par [-h] [--tarball TARBALL] --output-digest OUTPUT_DIGEST
[--config CONFIG] [--manifest MANIFEST] [--digest DIGEST]
[--layer LAYER] [--oci]
[--stderrthreshold STDERRTHRESHOLD]

Calculate digest for a container image.

optional arguments:
-h, --help show this help message and exit
--tarball TARBALL An optional legacy base image tarball.
--output-digest OUTPUT_DIGEST
Filename to store digest in.
--config CONFIG The path to the file storing the image config.
--manifest MANIFEST The path to the file storing the image manifest.
--digest DIGEST The list of layer digest filenames in order.
--layer LAYER The list of layer filenames in order.
--oci Image has an OCI Manifest.
--stderrthreshold STDERRTHRESHOLD
Write log events at or above this level to stderr.
```