README.md

Ansible Skopeo Collection

This repository contains an Ansible collection that allows to perform interactive Skopeo actions within Ansible playbooks or roles. This module requires a working installation of Skopeo on the target hosts.

This may be handy when setting up private container registries, transfering images to and from airgapped environments, or obtaining OCI information about specific images.

Installation

Make sure you have the ansible-galaxy CLI installed, then run the following command:

ansible-galaxy collection install --force https://github.com/antoniogrv/ansible-skopeo-collection/releases/download/0.1.0/local-skopeo-0.1.0.tar.gz

Usage

Run ansible-doc -l local.skopeo in order to list availalbe modules, roles and plugins. Afterwards, run ansible-doc -l local.skopeo.<plugin_name> to access the documentation of the selected module.

Module	Description
skopeo_login	Perform an authentication attemp against a target registry
skopeo_inspect	Inspect a container image, returning a JSON object
skopeo_copy	Copy a container image from one registry to another

Examples

- name: Attemp to authenticate against the quay.dev private container registry
  local.skopeo.skopeo_login:
    registry: quay.dev
    username: my_username
    password: my_password

- name: Inspect a remote container image on a quay.dev private registry
  local.skopeo.skopeo_inspect:
    image_name: quay.dev/my/image:tag
    username: my_username
    password: my_password

- name: Copy a busybox image from docker.io to a quay.dev private registry
  local.skopeo.skopeo_copy:
    src_image: "docker://docker.io/busybox:1.37"
    dest_image: "docker://quay.dev/misc/busybox:1.37"
    dest_username: "my_username"
    dest_password: "my_password"