- ImageTag [image.openshift.io/v1]
- Specification
- .image
- .image.dockerImageLayers
- .image.dockerImageLayers[]
- .image.signatures
- .image.signatures[]
- .image.signatures[].conditions
- .image.signatures[].conditions[]
- .image.signatures[].issuedBy
- .image.signatures[].issuedTo
- .spec
- .spec.importPolicy
- .spec.referencePolicy
- .status
- .status.conditions
- .status.conditions[]
- .status.items
- .status.items[]
- API endpoints
- Specification
ImageTag [image.openshift.io/v1]
Description
ImageTag represents a single tag within an image stream and includes the spec, the status history, and the currently referenced image (if any) of the provided tag. This type replaces the ImageStreamTag by providing a full view of the tag. ImageTags are returned for every spec or status tag present on the image stream. If no tag exists in either form a not found error will be returned by the API. A create operation will succeed if no spec tag has already been defined and the spec field is set. Delete will remove both spec and status elements from the image stream.
Type
object
Required
spec
status
image
Specification
Property | Type | Description |
---|---|---|
|
| 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 is an immutable representation of a container image and 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. |
|
| 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 |
| ||
|
| TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track. |
|
| NamedTagEventList relates a tag to its image history. |
.image
Description
Image is an immutable representation of a container image and 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.
Type
object
Required
dockerImageLayers
Property | Type | Description |
---|---|---|
|
| 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 is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2. |
|
| DockerImageLayers represents the layers in the image. May not be set if the image does not define that data. |
|
| ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none. |
|
| DockerImageManifest is the raw JSON of the manifest |
|
| DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. |
| DockerImageMetadata contains metadata about this image | |
|
| DockerImageMetadataVersion conveys the version of the object, which if empty defaults to “1.0” |
|
| DockerImageReference is the string that can be used to pull this image. |
|
| DockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1. |
|
| 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 |
| ||
|
| Signatures holds all signatures of the image. |
|
| 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. |
.image.dockerImageLayers
Description
DockerImageLayers represents the layers in the image. May not be set if the image does not define that data.
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 of the referenced object. |
|
| Name of the layer as defined by the underlying store. |
|
| Size of the layer in bytes as defined by the underlying store. |
.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.
Type
object
Required
type
content
Property | Type | Description |
---|---|---|
|
| 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 represent the latest available observations of a signature’s current state. |
|
| SignatureCondition describes an image signature condition of particular kind at particular probe time. |
|
| Required: An opaque binary string which is an image’s signature. |
| If specified, it is the time of signature’s creation. | |
|
| 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”). |
|
| SignatureIssuer holds information about an issuer of signing certificate or key. |
|
| SignatureSubject holds information about a person or entity who created the signature. |
|
| 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 |
| ||
|
| Contains claims from the signature. |
|
| 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 |
---|---|---|
| Last time the condition was checked. | |
| Last time the condition transit from one status to another. | |
|
| Human readable message indicating details about last transition. |
|
| (brief) reason for the condition’s last transition. |
|
| Status of the condition, one of True, False, Unknown. |
|
| 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 |
---|---|---|
|
| Common name (e.g. openshift-signing-service). |
|
| 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 |
---|---|---|
|
| Common name (e.g. openshift-signing-service). |
|
| Organization name. |
|
| 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). |
.spec
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 |
---|---|---|
|
| Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags. |
| 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 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. |
|
| TagImportPolicy controls how images related to this tag will be imported. |
|
| Name of the tag |
|
| Reference states if the tag will be imported. Default value is false, which means the tag will be imported. |
|
| 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. |
.spec.importPolicy
Description
TagImportPolicy controls how images related to this tag will be imported.
Type
object
Property | Type | Description |
---|---|---|
|
| Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import. |
|
| Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported |
.spec.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 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 |
.status
Description
NamedTagEventList relates a tag to its image history.
Type
object
Required
tag
items
Property | Type | Description |
---|---|---|
|
| Conditions is an array of conditions that apply to the tag event list. |
|
| TagEventCondition contains condition information for a tag event. |
|
| Standard object’s metadata. |
|
| TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag. |
|
| Tag is the tag for which the history is recorded |
.status.conditions
Description
Conditions is an array of conditions that apply to the tag event list.
Type
array
.status.conditions[]
Description
TagEventCondition contains condition information for a tag event.
Type
object
Required
type
status
generation
Property | Type | Description |
---|---|---|
|
| Generation is the spec tag generation that this status corresponds to |
| LastTransitionTIme is the time the condition transitioned from one status to another. | |
|
| Message is a human readable description of the details about last transition, complementing reason. |
|
| Reason is a brief machine readable explanation for the condition’s last transition. |
|
| Status of the condition, one of True, False, Unknown. |
|
| Type of tag event condition, currently only ImportSuccess |
.status.items
Description
Standard object’s metadata.
Type
array
.status.items[]
Description
TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag.
Type
object
Required
created
dockerImageReference
image
generation
Property | Type | Description |
---|---|---|
| Created holds the time the TagEvent was created | |
|
| DockerImageReference is the string that can be used to pull this image |
|
| Generation is the spec tag generation that resulted in this tag being updated |
|
| Image is the image |
API endpoints
The following API endpoints are available:
/apis/image.openshift.io/v1/imagetags
GET
: list objects of kind ImageTag
/apis/image.openshift.io/v1/namespaces/{namespace}/imagetags
GET
: list objects of kind ImageTagPOST
: create an ImageTag
/apis/image.openshift.io/v1/namespaces/{namespace}/imagetags/{name}
DELETE
: delete an ImageTagGET
: read the specified ImageTagPATCH
: partially update the specified ImageTagPUT
: replace the specified ImageTag
/apis/image.openshift.io/v1/imagetags
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
| If ‘true’, then the output is pretty printed. |
|
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP method
GET
Description
list objects of kind ImageTag
HTTP code | Reponse body |
---|---|
200 - OK | ImageTagList schema |
401 - Unauthorized | Empty |
/apis/image.openshift.io/v1/namespaces/{namespace}/imagetags
Parameter | Type | Description |
---|---|---|
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
GET
Description
list objects of kind ImageTag
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK | ImageTagList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create an ImageTag
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
| ImageTag schema |
HTTP code | Reponse body |
---|---|
200 - OK | ImageTag schema |
201 - Created | ImageTag schema |
202 - Accepted | ImageTag schema |
401 - Unauthorized | Empty |
/apis/image.openshift.io/v1/namespaces/{namespace}/imagetags/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the ImageTag |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete an ImageTag
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
|
| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
|
| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground. |
Parameter | Type | Description |
---|---|---|
| DeleteOptions schema |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified ImageTag
HTTP code | Reponse body |
---|---|
200 - OK | ImageTag schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified ImageTag
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
|
| Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
Parameter | Type | Description |
---|---|---|
| Patch schema |
HTTP code | Reponse body |
---|---|
200 - OK | ImageTag schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified ImageTag
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
| ImageTag schema |
HTTP code | Reponse body |
---|---|
200 - OK | ImageTag schema |
201 - Created | ImageTag schema |
401 - Unauthorized | Empty |