Skip to main content

Pubtools-quay

Project description

Set of scripts used for operating with Quay service

Requirements

  • Python 2.6+

  • Python 3.5+

  • Skopeo is required for the tagging operation

Features

  • pubtools-quay-tag-image - Copy a quay image from source to destination(s)

  • pubtools-quay-merge-manifest-list - Merge manifest lists of new and old images. The architectures of new (source) image overwrite destination’s archs. Archs missing from the source image will still remain in the merged manifest list. Destination image’s manifest list is overwritten by the merged manifest list.

  • pubtools-quay-untag - Remove tags from quay repositories. Tags to remove are specified by image references. In addition to Docker credentials, Quay API OAuth token has to be specified. Script will not perform the untagging operation if some image in a repo will lose its last tag. In this scenario, untagging can be forced by using the –remove-last argument.

Setup

$ pip install -r requirements.txt
$ pip install .
or
$ python setup.py install

Usage

Locally copy an image from source to destination. Quay password is injected from the environment variable.

$ export QUAY_PASSWORD=token
$ pubtools-quay-tag-image \
  --source-ref quay.io/source/image:34 \
  --dest-ref quay.io/target/image:34 \
  --quay-user quay+username \

Connect to a remote host via ssh (using password) and perform the copying to multiple destinations.

$ export QUAY_PASSWORD=token
$ export SSH_PASSWORD=123456
$ pubtools-quay-tag-image \
  --source-ref quay.io/source/image:34 \
  --dest-ref quay.io/target/image:34 \
  --dest-ref quay.io/target/image2:34 \
  --quay-user quay+username \
  --remote-exec \
  --ssh-remote-host 127.0.0.1 \
  --ssh-remote-host-port 2222 \
  --ssh-username user

Connect to a remote host via ssh (using private key), perform the copying, and send a UMB message.

$ export QUAY_PASSWORD=token
$ export SSH_PASSWORD=123456
$ pubtools-quay-tag-image \
  --source-ref quay.io/source/image:34 \
  --dest-ref quay.io/target/image:34 \
  --quay-user quay+username \
  --remote-exec \
  --ssh-remote-host 127.0.0.1 \
  --ssh-remote-host-port 2222 \
  --ssh-username user \
  --ssh-key-filename /path/to/file.key \
  --send-umb-msg \
  --umb-url amqps://url:5671 \
  --umb-url amqps://url2:5671 \
  --umb-cert /path/to/file.crt \
  --umb-topic VirtualTopic.eng.pub.some_topic

Merge manifest lists of source-ref and dest-ref and overwrite dest-ref with the result.

$ export QUAY_PASSWORD=token
$ pubtools-quay-merge-manifest-list \
  --source-ref quay.io/src/image:1 \
  --dest-ref quay.io/dest/image:1 \
  --quay-user quay+username

Untag multiple images and send a UMB message.

$ export QUAY_PASSWORD=token
$ export QUAY_API_TOKEN=oauth_token
$ pubtools-quay-tag-image \
  --reference quay.io/src/image:1 \
  --reference quay.io/src/image:2 \
  --quay-user quay+username \
  --remote-exec \
  --ssh-remote-host 127.0.0.1 \
  --ssh-remote-host-port 2222 \
  --ssh-username user \
  --ssh-key-filename /path/to/file.key \
  --send-umb-msg \
  --umb-url amqps://url:5671 \
  --umb-url amqps://url2:5671 \
  --umb-cert /path/to/file.crt \
  --umb-topic VirtualTopic.eng.pub.some_topic

Untag an image and force the operation in case the tag is a last reference of some digest.

$ export QUAY_PASSWORD=token
$ export QUAY_API_TOKEN=oauth_token
$ pubtools-quay-tag-image \
  --reference quay.io/src/image:1 \
  --remove-last \
  --quay-user quay+username \

ChangeLog

0.4.0 (2021-5-4)

  • Implement push-docker prototype

  • Change signing order to happen before pushing

  • Use intermediate index image for signing

0.3.0 (2021-2-11)

  • Fix the versioning constraint of pyrsistent dependency

0.2.0 (2021-2-9)

  • Fix the definition of requirements.txt, allowing installation on Python 2.6

0.1.0 (2021-2-9)

  • Initial release.

  • Added tag image entrypoint

  • Added merge manifest list entrypoint

  • Added push docker code skeleton

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pubtools-quay-0.4.0.tar.gz (52.1 kB view details)

Uploaded Source

Built Distribution

pubtools_quay-0.4.0-py2.py3-none-any.whl (58.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pubtools-quay-0.4.0.tar.gz.

File metadata

  • Download URL: pubtools-quay-0.4.0.tar.gz
  • Upload date:
  • Size: 52.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for pubtools-quay-0.4.0.tar.gz
Algorithm Hash digest
SHA256 bc26ec265c1d4acfa1065b0b816c4ba7f092bd502e6e8be6e75be1f8ddd594ec
MD5 8f270c01dba19ffd1abd2bbde8815069
BLAKE2b-256 5d1fa257ffb1300daa0d0589698b276520914fa7e22277a5ff459484cbad5238

See more details on using hashes here.

File details

Details for the file pubtools_quay-0.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: pubtools_quay-0.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 58.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for pubtools_quay-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c1f70103ad180ef41bd4f6b45519a4ae84014427907bf744657259d3f2926f69
MD5 d0bc861a9a9e3d15cffe00428f4b1f80
BLAKE2b-256 452759de755b571772cc5c44ac39677bd66203fb4ff22bdce874de7ebb364883

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page