From a422316d488e84c8e9e40787b60091941eaf0957 Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Thu, 8 Oct 2020 05:57:30 -0400 Subject: [PATCH] Update README.md Add commands section Add information about skopeo sync Signed-off-by: Daniel J Walsh --- README.md | 22 +++++++++++++++++++++- docs/skopeo-delete.1.md | 2 +- docs/skopeo-inspect.1.md | 2 +- docs/skopeo-list-tags.1.md | 2 +- docs/skopeo-login.1.md | 2 +- docs/skopeo-logout.1.md | 2 +- docs/skopeo-manifest-digest.1.md | 2 +- docs/skopeo-standalone-sign.1.md | 2 +- docs/skopeo-standalone-verify.1.md | 2 +- 9 files changed, 29 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d01981f5..2c02fad4 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ Skopeo works with API V2 container image registries such as [docker.io](https:// For example you can copy images from one registry to another, without requiring privilege. * Inspecting a remote image showing its properties including its layers, without requiring you to pull the image to the host. * Deleting an image from an image repository. + * Syncing an external image repository to an internal registy for air-gapped deployments. * When required by the repository, skopeo can pass the appropriate credentials and certificates for authentication. Skopeo operates on the following image and repository types: @@ -136,7 +137,7 @@ $ skopeo inspect docker://registry.fedoraproject.org/fedora:latest | jq '.Digest * Container Storage backends - - github.com/containers/storage (Backend for [Podman](https://podman.io), [CRI-O](https://cri-o.io), [Buildah](https://buildah.io) and friends) + - [github.com/containers/storage](https://github.com/containers/storage) (Backend for [Podman](https://podman.io), [CRI-O](https://cri-o.io), [Buildah](https://buildah.io) and friends) - Docker daemon storage @@ -154,6 +155,11 @@ $ skopeo copy oci:busybox_ocilayout:latest dir:existingemptydirectory $ skopeo delete docker://localhost:5000/imagename:latest ``` +## Syncing registries +```console +$ skopeo sync --src docker --dest dir registry.example.com/busybox /media/usb +``` + ## Authenticating to a registry #### Private registries with authentication @@ -189,6 +195,20 @@ Contributing Please read the [contribution guide](CONTRIBUTING.md) if you want to collaborate in the project. +## Commands +| Command | Description | +| -------------------------------------------------- | ---------------------------------------------------------------------------------------------| +| [skopeo-copy(1)](/docs/skopeo-copy.1.md) | Copy an image (manifest, filesystem layers, signatures) from one location to another. | +| [skopeo-delete(1)](/docs/skopeo-delete.1.md) | Mark the image-name for later deletion by the registry's garbage collector. | +| [skopeo-inspect(1)](/docs/skopeo-inspect.1.md) | Return low-level information about image-name in a registry. | +| [skopeo-list-tags(1)](/docs/skopeo-list-tags.1.md) | Return a list of tags for the transport-specific image repository. | +| [skopeo-login(1)](/docs/skopeo-login.1.md) | Login to a container registry. | +| [skopeo-logout(1)](/docs/skopeo-logout.1.md) | Logout of a container registry. | +| [skopeo-manifest-digest(1)](/docs/skopeo-manifest-digest.1.md) | Compute a manifest digest for a manifest-file and write it to standard output. | +| [skopeo-standalone-sign(1)](/docs/skopeo-standalone-sign.1.md) | Debugging tool - Publish and sign an image in one step. | +| [skopeo-standalone-verify(1)](/docs/skopeo-standalone-verify.1.md)| Verify an image signature. | +| [skopeo-sync(1)](/docs/skopeo-sync.1.md) | Synchronize images between container registries and local directories. | + License - skopeo is licensed under the Apache License, Version 2.0. See diff --git a/docs/skopeo-delete.1.md b/docs/skopeo-delete.1.md index 0b1dee03..577c756a 100644 --- a/docs/skopeo-delete.1.md +++ b/docs/skopeo-delete.1.md @@ -1,7 +1,7 @@ % skopeo-delete(1) ## NAME -skopeo\-delete - Mark _image-name_ for deletion. +skopeo\-delete - Mark the _image-name_ for later deletion by the registry's garbage collector. ## SYNOPSIS **skopeo delete** _image-name_ diff --git a/docs/skopeo-inspect.1.md b/docs/skopeo-inspect.1.md index 0d152e7f..0659849e 100644 --- a/docs/skopeo-inspect.1.md +++ b/docs/skopeo-inspect.1.md @@ -1,7 +1,7 @@ % skopeo-inspect(1) ## NAME -skopeo\-inspect - Return low-level information about _image-name_ in a registry +skopeo\-inspect - Return low-level information about _image-name_ in a registry. ## SYNOPSIS **skopeo inspect** [**--raw**] [**--config**] _image-name_ diff --git a/docs/skopeo-list-tags.1.md b/docs/skopeo-list-tags.1.md index 465c4ec0..37135251 100644 --- a/docs/skopeo-list-tags.1.md +++ b/docs/skopeo-list-tags.1.md @@ -1,7 +1,7 @@ % skopeo-list-tags(1) ## NAME -skopeo\-list\-tags - Return a list of tags the transport-specific image repository +skopeo\-list\-tags - Return a list of tags for the transport-specific image repository. ## SYNOPSIS **skopeo list-tags** _repository-name_ diff --git a/docs/skopeo-login.1.md b/docs/skopeo-login.1.md index fd49f4f2..92e298c0 100644 --- a/docs/skopeo-login.1.md +++ b/docs/skopeo-login.1.md @@ -1,7 +1,7 @@ % skopeo-login(1) ## NAME -skopeo\-login - Login to a container registry +skopeo\-login - Login to a container registry. ## SYNOPSIS **skopeo login** [*options*] *registry* diff --git a/docs/skopeo-logout.1.md b/docs/skopeo-logout.1.md index d7a72aff..7527adb6 100644 --- a/docs/skopeo-logout.1.md +++ b/docs/skopeo-logout.1.md @@ -1,7 +1,7 @@ % skopeo-logout(1) ## NAME -skopeo\-logout - Logout of a container registry +skopeo\-logout - Logout of a container registry. ## SYNOPSIS **skopeo logout** [*options*] *registry* diff --git a/docs/skopeo-manifest-digest.1.md b/docs/skopeo-manifest-digest.1.md index d3c2a669..a246a490 100644 --- a/docs/skopeo-manifest-digest.1.md +++ b/docs/skopeo-manifest-digest.1.md @@ -1,7 +1,7 @@ % skopeo-manifest-digest(1) ## NAME -skopeo\-manifest\-digest -Compute a manifest digest of manifest-file and write it to standard output. +skopeo\-manifest\-digest - Compute a manifest digest for a manifest-file and write it to standard output. ## SYNOPSIS **skopeo manifest-digest** _manifest-file_ diff --git a/docs/skopeo-standalone-sign.1.md b/docs/skopeo-standalone-sign.1.md index 2981da8c..dad70dce 100644 --- a/docs/skopeo-standalone-sign.1.md +++ b/docs/skopeo-standalone-sign.1.md @@ -1,7 +1,7 @@ % skopeo-standalone-sign(1) ## NAME -skopeo\-standalone-sign - Simple Sign an image +skopeo\-standalone-sign - Debugging tool - Publish and sign an image in one step. ## SYNOPSIS **skopeo standalone-sign** _manifest docker-reference key-fingerprint_ **--output**|**-o** _signature_ diff --git a/docs/skopeo-standalone-verify.1.md b/docs/skopeo-standalone-verify.1.md index f572f0a2..649f6406 100644 --- a/docs/skopeo-standalone-verify.1.md +++ b/docs/skopeo-standalone-verify.1.md @@ -1,7 +1,7 @@ % skopeo-standalone-verify(1) ## NAME -skopeo\-standalone\-verify - Verify an image signature +skopeo\-standalone\-verify - Verify an image signature. ## SYNOPSIS **skopeo standalone-verify** _manifest docker-reference key-fingerprint signature_