Important

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


Description

ImageStreamImage represents an Image that is retrieved by image name from an ImageStream.

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/api-conventions.md#resources

.image

object

Image is an immutable representation of a Docker image and metadata at a point in time.

.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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata.

.image
Description

Image is an immutable representation of a Docker image and metadata at a point in time.

Type

object

Required
  • dockerImageLayers

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

dockerImageLayers

array

DockerImageLayers represents the layers in the image. May not be set if the image does not define that data.

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.

dockerImageMetadata

RawExtension pkg/runtime

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/api-conventions.md#types-kinds

metadata

ObjectMeta meta/v1

Standard object’s 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.

.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

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

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/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 meta/v1

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/api-conventions.md#types-kinds

metadata

ObjectMeta meta/v1

Standard object’s 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 meta/v1

Last time the condition was checked.

lastTransitionTime

Time meta/v1

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}

Table 1. Global path parameters
Parameter Type Description

name

string

name of the ImageStreamImage

namespace

string

object name and auth scope, such as for teams and projects

Table 2. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

GET

Description

read the specified ImageStreamImage

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

ImageStreamImage image.openshift.io/v1

401 - Unauthorized

Empty