Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.
Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us
ImageStreamTag represents an Image that is retrieved by tag name from an ImageStream.
object
tag
generation
lookupPolicy
image
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/api-conventions.md#resources |
|
|
conditions is an array of conditions that apply to the image stream tag. |
|
|
TagEventCondition contains condition information for a tag event. |
|
|
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 is an immutable representation of a Docker image and metadata at a point in time. |
|
|
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/api-conventions.md#types-kinds |
|
|
ImageLookupPolicy describes how an image stream can be used to override the image references used by pods, builds, and other resources in a namespace. |
|
Standard object’s metadata. |
|
|
|
TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track. |
conditions is an array of conditions that apply to the image stream tag.
array
TagEventCondition contains condition information for a tag event.
object
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 |
Image is an immutable representation of a Docker image and metadata at a point in time.
object
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/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/api-conventions.md#types-kinds |
|
Standard object’s metadata. |
|
|
|
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. |
DockerImageLayers represents the layers in the image. May not be set if the image does not define that data.
array
ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.
object
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. |
Signatures holds all signatures of the image.
array
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.
object
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/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/api-conventions.md#types-kinds |
|
Standard object’s metadata. |
|
|
|
Contains claims from the signature. |
|
|
Required: Describes a type of stored blob. |
Conditions represent the latest available observations of a signature’s current state.
array
SignatureCondition describes an image signature condition of particular kind at particular probe time.
object
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. |
SignatureIssuer holds information about an issuer of signing certificate or key.
object
Property | Type | Description |
---|---|---|
|
|
Common name (e.g. openshift-signing-service). |
|
|
Organization name. |
SignatureSubject holds information about a person or entity who created the signature.
object
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). |
ImageLookupPolicy describes how an image stream can be used to override the image references used by pods, builds, and other resources in a namespace.
object
local
Property | Type | Description |
---|---|---|
|
|
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. |
TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.
object
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. |
TagImportPolicy controls how images related to this tag will be imported.
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 |
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.
object
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 |
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
Parameter | Type | Description |
---|---|---|
|
|
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 indicating the client must restart their list without the continue field. 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. |
|
|
If true, partially initialized resources are included in the response. |
|
|
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 `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
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. |
GET
list objects of kind ImageStreamTag
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
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. |
GET
list objects of kind ImageStreamTag
Parameter | Type | Description |
---|---|---|
|
|
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 indicating the client must restart their list without the continue field. 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. |
|
|
If true, partially initialized resources are included in the response. |
|
|
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 `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
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 |
|
401 - Unauthorized |
Empty |
POST
create an ImageStreamTag
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the ImageStreamTag |
|
|
object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
DELETE
delete an ImageStreamTag
Parameter | Type | Description |
---|---|---|
|
|
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 |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
read the specified ImageStreamTag
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified ImageStreamTag
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace the specified ImageStreamTag
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |