ImageStreamTag [image.openshift.io/v1]

Description

ImageStreamTag represents an Image that is retrieved by tag name from an ImageStream. Use this resource to interact with the tags and images in an image stream by tag, or to see the image details for a particular tag. The image associated with this resource is the most recently successfully tagged, imported, or pushed image (as described in the image stream status.tags.items list for this tag). If an import is in progress or has failed the previous image will be shown. Deleting an image stream tag clears both the status and spec fields of an image stream. If no image can be retrieved for a given tag, a not found error will be returned. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

`object`

Required

• tag
• generation
• lookupPolicy
• 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
conditions	array	conditions is an array of conditions that apply to the image stream tag.
conditions[]	object	TagEventCondition contains condition information for a tag event.
generation	integer	generation is the current generation of the tagged image - if tag is provided and this value is not equal to the tag generation, a user has requested an import that has not completed, or conditions will be filled out indicating any error.
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
lookupPolicy	object	ImageLookupPolicy describes how an image stream can be used to override the image references used by pods, builds, and other resources in a namespace.
metadata	ObjectMeta	metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
tag	object	TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.

.conditions

Description

conditions is an array of conditions that apply to the image stream tag.

Type

`array`

.conditions[]

Description

TagEventCondition contains condition information for a tag event.

Type

`object`

Required

• type
• status
• generation

Property	Type	Description
generation	integer	generation is the spec tag generation that this status corresponds to
lastTransitionTime	Time	lastTransitionTime is the time the condition transitioned from one status to another.
message	string	message is a human readable description of the details about last transition, complementing reason.
reason	string	reason is a brief machine readable explanation for the condition’s last transition.
status	string	status of the condition, one of True, False, Unknown.
type	string	type of tag event condition, currently only ImportSuccess

.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

• name
• size
• mediaType

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

• digest
• mediaType
• manifestSize
• architecture
• os

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

• type
• content

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

• type
• status

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).

.lookupPolicy

Description

ImageLookupPolicy describes how an image stream can be used to override the image references used by pods, builds, and other resources in a namespace.

Type

`object`

Required

• local

Property	Type	Description
local	boolean	local will change the docker short image references (like "mysql" or "php:latest") on objects in this namespace to the image ID whenever they match this image stream, instead of reaching out to a remote registry. The name will be fully qualified to an image ID if found. The tag’s referencePolicy is taken into account on the replaced value. Only works within the current namespace.

.tag

Description

TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.

Type

`object`

Required

• name

Property	Type	Description
annotations	object (string)	Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags.
from	ObjectReference	Optional; if specified, a reference to another image that this tag should point to. Valid values are ImageStreamTag, ImageStreamImage, and DockerImage. ImageStreamTag references can only reference a tag within this same ImageStream.
generation	integer	generation is a counter that tracks mutations to the spec tag (user intent). When a tag reference is changed the generation is set to match the current stream generation (which is incremented every time spec is changed). Other processes in the system like the image importer observe that the generation of spec tag is newer than the generation recorded in the status and use that as a trigger to import the newest remote tag. To trigger a new import, clients may set this value to zero which will reset the generation to the latest stream generation. Legacy clients will send this value as nil which will be merged with the current tag generation.
importPolicy	object	TagImportPolicy controls how images related to this tag will be imported.
name	string	name of the tag
reference	boolean	reference states if the tag will be imported. Default value is false, which means the tag will be imported.
referencePolicy	object	TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed.

.tag.importPolicy

Description

TagImportPolicy controls how images related to this tag will be imported.

Type

`object`

Property	Type	Description
importMode	string	importMode describes how to import an image manifest.
insecure	boolean	insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.
scheduled	boolean	scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported

.tag.referencePolicy

Description

TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed.

Type

`object`

Required

• type

Property	Type	Description
type	string	type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is Source, indicating the original location of the image should be used (if imported). The user may also specify Local, indicating that the pull spec should point to the integrated container image registry and leverage the registry’s ability to proxy the pull to an upstream registry. Local allows the credentials used to pull this image to be managed from the image stream’s namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable.

API endpoints

The following API endpoints are available:

• /apis/image.openshift.io/v1/imagestreamtags
  • GET: list objects of kind ImageStreamTag
• /apis/image.openshift.io/v1/namespaces/{namespace}/imagestreamtags
  • GET: list objects of kind ImageStreamTag
  • POST: create an ImageStreamTag
• /apis/image.openshift.io/v1/namespaces/{namespace}/imagestreamtags/{name}
  • DELETE: delete an ImageStreamTag
  • GET: read the specified ImageStreamTag
  • PATCH: partially update the specified ImageStreamTag
  • PUT: replace the specified ImageStreamTag

/apis/image.openshift.io/v1/imagestreamtags

HTTP method

`GET`

Description

list objects of kind ImageStreamTag

HTTP responses

HTTP code	Reponse body
200 - OK	ImageStreamTagList schema
401 - Unauthorized	Empty

/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreamtags

HTTP method

`GET`

Description

list objects of kind ImageStreamTag

HTTP responses

HTTP code	Reponse body
200 - OK	ImageStreamTagList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create an ImageStreamTag

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	ImageStreamTag schema

HTTP responses

HTTP code	Reponse body
200 - OK	ImageStreamTag schema
201 - Created	ImageStreamTag schema
202 - Accepted	ImageStreamTag schema
401 - Unauthorized	Empty

/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreamtags/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the ImageStreamTag

HTTP method

`DELETE`

Description

delete an ImageStreamTag

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Reponse body
200 - OK	Status_v2 schema
202 - Accepted	Status_v2 schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified ImageStreamTag

HTTP responses

HTTP code	Reponse body
200 - OK	ImageStreamTag schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified ImageStreamTag

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	ImageStreamTag schema
201 - Created	ImageStreamTag schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified ImageStreamTag

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	ImageStreamTag schema

HTTP responses

HTTP code	Reponse body
200 - OK	ImageStreamTag schema
201 - Created	ImageStreamTag schema
401 - Unauthorized	Empty