summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-image-sign.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-08-16 07:35:18 -0600
committerEd Santiago <santiago@redhat.com>2022-08-16 09:13:38 -0600
commitf0e8640755569ba7da803f7c8f4589953939fad0 (patch)
tree30d31d6280c42c304184fb8224028e59be001361 /docs/source/markdown/podman-image-sign.1.md
parent3dace12777e27a7732acb25ae78f86ced8ae04da (diff)
downloadpodman-f0e8640755569ba7da803f7c8f4589953939fad0.tar.gz
podman-f0e8640755569ba7da803f7c8f4589953939fad0.tar.bz2
podman-f0e8640755569ba7da803f7c8f4589953939fad0.zip
Man pages: refactor common options: authfile
Refactor the --authfile option. My suggestion for review: 1) run hack/markdown-preprocess-review and immediately Ctrl-Q to quit out of diffuse, which is completely unusable for this many files; then 2) cd /tmp/markdown-preprocess-review.diffs/authfile - this is the directory created by the review script 3) rm podman-image-sign* podman-log* podman-search.1.md.in - because they're essentially identical to podman-create 4) rm podman-manifest-* podman-push.* - because they're 100% identical to podman-kube-play 5) rm podman-kube-play* - because it's apart-from-whitespace identical to podman-build (use "wdiff" to confirm) 6) rm podman-auto-update* - because that's the one I chose (hence == zzz-chosen.md) (You should obviously run your own diff/cmp before rm, to confirm my assertions about which files are identical). After all that, you have a manageable number of files which you can scan, read, diff against zzz-chosen.md, even run diffuse. This option is IMHO the poster child for why we need this kind of man page refactoring. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-image-sign.1.md')
-rw-r--r--docs/source/markdown/podman-image-sign.1.md76
1 files changed, 0 insertions, 76 deletions
diff --git a/docs/source/markdown/podman-image-sign.1.md b/docs/source/markdown/podman-image-sign.1.md
deleted file mode 100644
index 035e10743..000000000
--- a/docs/source/markdown/podman-image-sign.1.md
+++ /dev/null
@@ -1,76 +0,0 @@
-% podman-image-sign(1)
-
-## NAME
-podman-image-sign - Create a signature for an image
-
-## SYNOPSIS
-**podman image sign** [*options*] *image* [*image* ...]
-
-## DESCRIPTION
-**podman image sign** will create a local signature for one or more local images that have
-been pulled from a registry. The signature will be written to a directory
-derived from the registry configuration files in `$HOME/.config/containers/registries.d` if it exists,
-otherwise `/etc/containers/registries.d` (unless overridden at compile-time), see **containers-registries.d(5)** for more information.
-By default, the signature will be written into `/var/lib/containers/sigstore` for root and `$HOME/.local/share/containers/sigstore` for non-root users
-
-## OPTIONS
-
-#### **--all**, **-a**
-
-Sign all the manifests of the multi-architecture image (default false).
-
-#### **--authfile**=*path*
-
-Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json
-
-Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
-environment variable. `export REGISTRY_AUTH_FILE=path`
-
-#### **--cert-dir**=*path*
-
-Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. (Default: /etc/containers/certs.d)
-Please refer to containers-certs.d(5) for details. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
-
-#### **--directory**, **-d**=*dir*
-
-Store the signatures in the specified directory. Default: /var/lib/containers/sigstore
-
-#### **--help**, **-h**
-
-Print usage statement.
-
-#### **--sign-by**=*identity*
-
-Override the default identity of the signature.
-
-## EXAMPLES
-Sign the busybox image with the identity of foo@bar.com with a user's keyring and save the signature in /tmp/signatures/.
-
- sudo podman image sign --sign-by foo@bar.com --directory /tmp/signatures docker://privateregistry.example.com/foobar
-
- sudo podman image sign --authfile=/tmp/foobar.json --sign-by foo@bar.com --directory /tmp/signatures docker://privateregistry.example.com/foobar
-
-## RELATED CONFIGURATION
-
-The write (and read) location for signatures is defined in YAML-based
-configuration files in /etc/containers/registries.d/ for root,
-or $HOME/.config/containers/registries.d for non-root users. When you sign
-an image, Podman will use those configuration files to determine
-where to write the signature based on the name of the originating
-registry or a default storage value unless overridden with the --directory
-option. For example, consider the following configuration file.
-
-docker:
- privateregistry.example.com:
- sigstore: file:///var/lib/containers/sigstore
-
-When signing an image preceded with the registry name 'privateregistry.example.com',
-the signature will be written into sub-directories of
-/var/lib/containers/sigstore/privateregistry.example.com. The use of 'sigstore' also means
-the signature will be 'read' from that same location on a pull-related function.
-
-## SEE ALSO
-**[containers-certs.d(5)](https://github.com/containers/image/blob/main/docs/containers-certs.d.5.md)**, **[containers-registries.d(5)](https://github.com/containers/image/blob/main/docs/containers-registries.d.5.md)**
-
-## HISTORY
-November 2018, Originally compiled by Qi Wang (qiwan at redhat dot com)