Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add commands section
Add information about skopeo sync

Signed-off-by: Daniel J Walsh <[email protected]>
  • Loading branch information
rhatdan committed Oct 8, 2020
1 parent 4cc72b9 commit a422316
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 9 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-delete.1.md
Original file line number Diff line number Diff line change
@@ -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_
Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-inspect.1.md
Original file line number Diff line number Diff line change
@@ -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_
Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-list-tags.1.md
Original file line number Diff line number Diff line change
@@ -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_
Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-login.1.md
Original file line number Diff line number Diff line change
@@ -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*
Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-logout.1.md
Original file line number Diff line number Diff line change
@@ -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*
Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-manifest-digest.1.md
Original file line number Diff line number Diff line change
@@ -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_
Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-standalone-sign.1.md
Original file line number Diff line number Diff line change
@@ -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_
Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-standalone-verify.1.md
Original file line number Diff line number Diff line change
@@ -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_
Expand Down

0 comments on commit a422316

Please sign in to comment.