mirror of
https://github.com/containers/podman.git
synced 2025-05-20 00:27:03 +08:00
Add man page content for artifacts
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
This commit is contained in:
Daniel J Walsh
committed by
Nalin Dahyabhai
Nalin Dahyabhai
parent
d8bb637050
commit
2bbed8f200
@ -4,4 +4,4 @@
|
||||
####> are applicable to all of those.
|
||||
#### **--annotation**=*annotation=value*
|
||||
|
||||
Set an annotation on the entry for the image.
|
||||
Set an annotation on the entry for the specified image or artifact.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
####> podman manifest add, manifest annotate
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--features**
|
||||
#### **--features**=*feature*
|
||||
|
||||
Specify the features list which the list or index records as requirements for
|
||||
the image. This option is rarely used.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
####> podman manifest add, manifest annotate
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--os-version**
|
||||
#### **--os-version**=*version*
|
||||
|
||||
Specify the OS version which the list or index records as a requirement for the
|
||||
image. This option is rarely used.
|
||||
|
||||
@ -1,16 +1,18 @@
|
||||
% podman-manifest-add 1
|
||||
|
||||
## NAME
|
||||
podman\-manifest\-add - Add an image to a manifest list or image index
|
||||
podman\-manifest\-add - Add an image or artifact to a manifest list or image index
|
||||
|
||||
## SYNOPSIS
|
||||
**podman manifest add** [*options*] *listnameorindexname* [*transport*]:*imagename*
|
||||
**podman manifest add** [*options*] *listnameorindexname* [*transport*]:*imagename* *imageorartifactname* [...]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Adds the specified image to the specified manifest list or image index.
|
||||
Adds the specified image to the specified manifest list or image index, or
|
||||
creates an artifact manifest and adds it to the specified image index.
|
||||
|
||||
## RETURN VALUE
|
||||
|
||||
The list image's ID.
|
||||
|
||||
## OPTIONS
|
||||
@ -24,13 +26,62 @@ from such a list or index is added to the list or index. Combining
|
||||
|
||||
@@option annotation.manifest
|
||||
|
||||
#### **--arch**
|
||||
#### **--arch**=*architecture*
|
||||
|
||||
Override the architecture which the list or index records as a requirement for
|
||||
the image. If *imageName* refers to a manifest list or image index, the
|
||||
architecture information is retrieved from it. Otherwise, it is
|
||||
retrieved from the image's configuration information.
|
||||
|
||||
#### **--artifact**
|
||||
|
||||
Create an artifact manifest and add it to the image index. Arguments after the
|
||||
index name will be interpreted as file names rather than as image references.
|
||||
In most scenarios, the **--artifact-type** option should also be specified.
|
||||
|
||||
#### **--artifact-config**=*path*
|
||||
|
||||
When creating an artifact manifest and adding it to the image index, use the
|
||||
specified file's contents as the configuration blob in the artifact manifest.
|
||||
In most scenarios, leaving the default value, which signifies an empty
|
||||
configuration, unchanged, is the preferred option.
|
||||
|
||||
#### **--artifact-config-type**=*type*
|
||||
|
||||
When creating an artifact manifest and adding it to the image index, use the
|
||||
specified MIME type as the `mediaType` associated with the configuration blob
|
||||
in the artifact manifest. In most scenarios, leaving the default value, which
|
||||
signifies either an empty configuration or the standard OCI configuration type,
|
||||
unchanged, is the preferred option.
|
||||
|
||||
#### **--artifact-exclude-titles**
|
||||
|
||||
When creating an artifact manifest and adding it to the image index, do not
|
||||
set "org.opencontainers.image.title" annotations equal to the file's basename
|
||||
for each file added to the artifact manifest. Tools which retrieve artifacts
|
||||
from a registry may use these values to choose names for files when saving
|
||||
artifacts to disk, so this option is not recommended unless it is required
|
||||
for interoperability with a particular registry.
|
||||
|
||||
#### **--artifact-layer-type**=*type*
|
||||
|
||||
When creating an artifact manifest and adding it to the image index, use the
|
||||
specified MIME type as the `mediaType` associated with the files' contents. If
|
||||
not specified, guesses based on either the files names or their contents will
|
||||
be made and used, but the option should be specified if certainty is needed.
|
||||
|
||||
#### **--artifact-subject**=*imageName*
|
||||
|
||||
When creating an artifact manifest and adding it to the image index, set the
|
||||
*subject* field in the artifact manifest to mark the artifact manifest as being
|
||||
associated with the specified image in some way. An artifact manifest can only
|
||||
be associated with, at most, one subject.
|
||||
|
||||
#### **--artifact-type**=*type*
|
||||
|
||||
When creating an artifact manifest, use the specified MIME type as the
|
||||
manifest's `artifactType` value instead of the less informative default value.
|
||||
|
||||
@@option authfile
|
||||
|
||||
@@option cert-dir
|
||||
@ -39,7 +90,7 @@ retrieved from the image's configuration information.
|
||||
|
||||
@@option features
|
||||
|
||||
#### **--os**
|
||||
#### **--os**=*OS*
|
||||
|
||||
Override the OS which the list or index records as a requirement for the image.
|
||||
If *imagename* refers to a manifest list or image index, the OS information
|
||||
|
||||
@ -1,41 +1,53 @@
|
||||
% podman-manifest-annotate 1
|
||||
|
||||
## NAME
|
||||
podman\-manifest\-annotate - Add or update information about an entry in a manifest list or image index
|
||||
podman\-manifest\-annotate - Add and update information about an image or artifact in a manifest list or image index
|
||||
|
||||
## SYNOPSIS
|
||||
**podman manifest annotate** [*options*] *listnameorindexname* *imagemanifestdigest*
|
||||
**podman manifest annotate** [*options*] *listnameorindexname* *imagemanifestdigestorimageorartifactname*
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Adds or updates information about an image included in a manifest list or image index.
|
||||
Adds or updates information about an image or artifact included in a manifest list or image index.
|
||||
|
||||
## OPTIONS
|
||||
|
||||
@@option annotation.manifest
|
||||
If **--index** is also specified, sets the annotation on the entire image index.
|
||||
|
||||
#### **--arch**
|
||||
#### **--arch**=*architecture*
|
||||
|
||||
Override the architecture which the list or index records as a requirement for
|
||||
the image. This is usually automatically retrieved from the image's
|
||||
configuration information, so it is rarely necessary to use this option.
|
||||
|
||||
|
||||
@@option features
|
||||
|
||||
#### **--os**
|
||||
#### **--index**
|
||||
|
||||
Treats arguments to the **--annotation** option as annotation values to be set
|
||||
on the image index itself rather than on an entry in the image index. Implied
|
||||
for **--subject**.
|
||||
|
||||
#### **--os**=*OS*
|
||||
|
||||
Override the OS which the list or index records as a requirement for the image.
|
||||
This is usually automatically retrieved from the image's configuration
|
||||
information, so it is rarely necessary to use this option.
|
||||
|
||||
#### **--os-features**
|
||||
#### **--os-features**=*feature*
|
||||
|
||||
Specify the OS features list which the list or index records as requirements
|
||||
for the image. This option is rarely used.
|
||||
|
||||
@@option os-version
|
||||
|
||||
#### **--subject**=*imageName*
|
||||
|
||||
Set the *subject* field in the image index to mark the image index as being
|
||||
associated with the specified image in some way. An image index can only be
|
||||
associated with, at most, one subject.
|
||||
|
||||
@@option variant.manifest
|
||||
|
||||
## EXAMPLE
|
||||
|
||||
@ -28,6 +28,10 @@ If a manifest list named *listnameorindexname* already exists, modify the
|
||||
preexisting list instead of exiting with an error. The contents of
|
||||
*listnameorindexname* are not modified if no *imagename*s are given.
|
||||
|
||||
#### **--annotation**=*value*
|
||||
|
||||
Set an annotation on the newly-created image index.
|
||||
|
||||
@@option tls-verify
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
@ -13,16 +13,16 @@ The `podman manifest` command provides subcommands which can be used to:
|
||||
|
||||
## SUBCOMMANDS
|
||||
|
||||
| Command | Man Page | Description |
|
||||
| -------- | ------------------------------------------------------------ | --------------------------------------------------------------------------- |
|
||||
| add | [podman-manifest-add(1)](podman-manifest-add.1.md) | Add an image to a manifest list or image index. |
|
||||
| annotate | [podman-manifest-annotate(1)](podman-manifest-annotate.1.md) | Add or update information about an entry in a manifest list or image index. |
|
||||
| create | [podman-manifest-create(1)](podman-manifest-create.1.md) | Create a manifest list or image index. |
|
||||
| exists | [podman-manifest-exists(1)](podman-manifest-exists.1.md) | Check if the given manifest list exists in local storage |
|
||||
| inspect | [podman-manifest-inspect(1)](podman-manifest-inspect.1.md) | Display a manifest list or image index. |
|
||||
| push | [podman-manifest-push(1)](podman-manifest-push.1.md) | Push a manifest list or image index to a registry. |
|
||||
| remove | [podman-manifest-remove(1)](podman-manifest-remove.1.md) | Remove an image from a manifest list or image index. |
|
||||
| rm | [podman-manifest-rm(1)](podman-manifest-rm.1.md) | Remove manifest list or image index from local storage. |
|
||||
| Command | Man Page | Description |
|
||||
| -------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
|
||||
| add | [podman-manifest-add(1)](podman-manifest-add.1.md) | Add an image or artifact to a manifest list or image index. |
|
||||
| annotate | [podman-manifest-annotate(1)](podman-manifest-annotate.1.md) | Add and update information about an image or artifact in a manifest list or image index. |
|
||||
| create | [podman-manifest-create(1)](podman-manifest-create.1.md) | Create a manifest list or image index. |
|
||||
| exists | [podman-manifest-exists(1)](podman-manifest-exists.1.md) | Check if the given manifest list exists in local storage |
|
||||
| inspect | [podman-manifest-inspect(1)](podman-manifest-inspect.1.md) | Display a manifest list or image index. |
|
||||
| push | [podman-manifest-push(1)](podman-manifest-push.1.md) | Push a manifest list or image index to a registry. |
|
||||
| remove | [podman-manifest-remove(1)](podman-manifest-remove.1.md) | Remove an image from a manifest list or image index. |
|
||||
| rm | [podman-manifest-rm(1)](podman-manifest-rm.1.md) | Remove manifest list or image index from local storage. |
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
|
||||
Reference in New Issue
Block a user