ImageStreamImage [image.openshift.io/v1]¶
- Description
-
ImageStreamImage represents an Image that is retrieved by image name from an ImageStream. User interfaces and regular users can use this resource to access the metadata details of a tagged image in the image stream history for viewing, since Image resources are not directly accessible to end users. A not found error will be returned if no such image is referenced by a tag within the ImageStream. Images are created when spec tags are set on an image stream that represent an image in an external registry, when pushing to the integrated registry, or when tagging an existing image from one image stream to another. The name of an image stream image is in the form "<STREAM>@<DIGEST>", where the digest is the content addressible identifier for the image (sha256:xxxxx...). You can use ImageStreamImages as the from.kind of an image stream spec tag to reference an image exactly. The only operations supported on the imagestreamimage endpoint are retrieving the image.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
`object`- Required
-
image
Specification¶
| Property | Type | Description |
|---|---|---|
apiVersion |
string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
image |
object |
Image is an immutable representation of a container image and its metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users, instead, access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). |
kind |
string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadata |
ObjectMeta |
metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
.image¶
- Description
-
Image is an immutable representation of a container image and its metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users, instead, access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
`object`
| Property | Type | Description |
|---|---|---|
apiVersion |
string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
dockerImageConfig |
string |
dockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2. Will not be set when the image represents a manifest list. |
dockerImageLayers |
array |
dockerImageLayers represents the layers in the image. May not be set if the image does not define that data or if the image represents a manifest list. |
dockerImageLayers[] |
object |
ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none. |
dockerImageManifest |
string |
dockerImageManifest is the raw JSON of the manifest |
dockerImageManifestMediaType |
string |
dockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. |
dockerImageManifests |
array |
dockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified. |
dockerImageManifests[] |
object |
ImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object. |
dockerImageMetadata |
RawExtension |
dockerImageMetadata contains metadata about this image |
dockerImageMetadataVersion |
string |
dockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0" |
dockerImageReference |
string |
dockerImageReference is the string that can be used to pull this image. |
dockerImageSignatures |
array (string) |
dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1. |
kind |
string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadata |
ObjectMeta |
metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
signatures |
array |
signatures holds all signatures of the image. |
signatures[] |
object |
ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature’s content by the server. They serve just an informative purpose. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). |
.image.dockerImageLayers¶
- Description
- dockerImageLayers represents the layers in the image. May not be set if the image does not define that data or if the image represents a manifest list.
- Type
`array`
.image.dockerImageLayers[]¶
- Description
- ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.
- Type
`object`- Required
-
namesizemediaType
| Property | Type | Description |
|---|---|---|
mediaType |
string |
mediaType of the referenced object. |
name |
string |
name of the layer as defined by the underlying store. |
size |
integer |
size of the layer in bytes as defined by the underlying store. |
.image.dockerImageManifests¶
- Description
- dockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.
- Type
`array`
.image.dockerImageManifests[]¶
- Description
- ImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.
- Type
`object`- Required
-
digestmediaTypemanifestSizearchitectureos
| Property | Type | Description |
|---|---|---|
architecture |
string |
architecture specifies the supported CPU architecture, for example amd64 or ppc64le. |
digest |
string |
digest is the unique identifier for the manifest. It refers to an Image object. |
manifestSize |
integer |
manifestSize represents the size of the raw object contents, in bytes. |
mediaType |
string |
mediaType defines the type of the manifest, possible values are application/vnd.oci.image.manifest.v1+json, application/vnd.docker.distribution.manifest.v2+json or application/vnd.docker.distribution.manifest.v1+json. |
os |
string |
os specifies the operating system, for example linux. |
variant |
string |
variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU. |
.image.signatures¶
- Description
- signatures holds all signatures of the image.
- Type
`array`
.image.signatures[]¶
- Description
-
ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature’s content by the server. They serve just an informative purpose.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
`object`- Required
-
typecontent
| Property | Type | Description |
|---|---|---|
apiVersion |
string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
conditions |
array |
conditions represent the latest available observations of a signature’s current state. |
conditions[] |
object |
SignatureCondition describes an image signature condition of particular kind at particular probe time. |
content |
string |
Required: An opaque binary string which is an image’s signature. |
created |
Time |
If specified, it is the time of signature’s creation. |
imageIdentity |
string |
A human readable string representing image’s identity. It could be a product name and version, or an image pull spec (e.g. "registry.access.redhat.com/rhel7/rhel:7.2"). |
issuedBy |
object |
SignatureIssuer holds information about an issuer of signing certificate or key. |
issuedTo |
object |
SignatureSubject holds information about a person or entity who created the signature. |
kind |
string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadata |
ObjectMeta |
metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
signedClaims |
object (string) |
Contains claims from the signature. |
type |
string |
Required: Describes a type of stored blob. |
.image.signatures[].conditions¶
- Description
- conditions represent the latest available observations of a signature’s current state.
- Type
`array`
.image.signatures[].conditions[]¶
- Description
- SignatureCondition describes an image signature condition of particular kind at particular probe time.
- Type
`object`- Required
-
typestatus
| Property | Type | Description |
|---|---|---|
lastProbeTime |
Time |
Last time the condition was checked. |
lastTransitionTime |
Time |
Last time the condition transit from one status to another. |
message |
string |
Human readable message indicating details about last transition. |
reason |
string |
(brief) reason for the condition’s last transition. |
status |
string |
status of the condition, one of True, False, Unknown. |
type |
string |
type of signature condition, Complete or Failed. |
.image.signatures[].issuedBy¶
- Description
- SignatureIssuer holds information about an issuer of signing certificate or key.
- Type
`object`
| Property | Type | Description |
|---|---|---|
commonName |
string |
Common name (e.g. openshift-signing-service). |
organization |
string |
organization name. |
.image.signatures[].issuedTo¶
- Description
- SignatureSubject holds information about a person or entity who created the signature.
- Type
`object`- Required
-
publicKeyID
| Property | Type | Description |
|---|---|---|
commonName |
string |
Common name (e.g. openshift-signing-service). |
organization |
string |
organization name. |
publicKeyID |
string |
If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key’s fingerprint (e.g. 0x685ebe62bf278440). |
API endpoints¶
The following API endpoints are available:
-
/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreamimages/{name}GET: read the specified ImageStreamImage
/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreamimages/{name}¶
Global path parameters
| Parameter | Type | Description |
|---|---|---|
name |
string |
name of the ImageStreamImage |
- HTTP method
`GET`- Description
read the specified ImageStreamImage
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | ImageStreamImage schema |
| 401 - Unauthorized | Empty |