ImageStreamImport [image.openshift.io/v1]
Esc
Start typing to search...
On this page

ImageStreamImport [image.openshift.io/v1]

Description

The image stream import resource provides an easy way for a user to find and import container images from other container image registries into the server. Individual images or an entire image repository may be imported, and users may choose to see the results of the import prior to tagging the resulting images into the specified image stream.

This API is intended for end-user tools that need to see the metadata of the image prior to import (for instance, to generate an application from it). Clients that know the desired image can continue to create spec.tags directly into their image streams.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
`object`
Required
  • spec
  • status

Specification

PropertyTypeDescription
apiVersionstringAPIVersion 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
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specobjectImageStreamImportSpec defines what images should be imported.
statusobjectImageStreamImportStatus contains information about the status of an image stream import.

.spec

Description

ImageStreamImportSpec defines what images should be imported.

Type
`object`
Required
  • import
PropertyTypeDescription
imagesarrayimages are a list of individual images to import.
images[]objectImageImportSpec describes a request to import a specific image.
importbooleanimport indicates whether to perform an import - if so, the specified tags are set on the spec and status of the image stream defined by the type meta.
repositoryobjectRepositoryImportSpec describes a request to import images from a container image repository.

.spec.images

Description

images are a list of individual images to import.

Type
`array`

.spec.images[]

Description

ImageImportSpec describes a request to import a specific image.

Type
`object`
Required
  • from
PropertyTypeDescription
fromObjectReferencefrom is the source of an image to import; only kind DockerImage is allowed
importPolicyobjectTagImportPolicy controls how images related to this tag will be imported.
includeManifestbooleanincludeManifest determines if the manifest for each image is returned in the response
referencePolicyobjectTagReferencePolicy 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.
toLocalObjectReferenceTo is a tag in the current image stream to assign the imported image to, if name is not specified the default tag from from.name will be used

.spec.images[].importPolicy

Description

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

Type
`object`
PropertyTypeDescription
importModestringimportMode describes how to import an image manifest.
insecurebooleaninsecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.
scheduledbooleanscheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported

.spec.images[].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
PropertyTypeDescription
typestringtype 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.

.spec.repository

Description

RepositoryImportSpec describes a request to import images from a container image repository.

Type
`object`
Required
  • from
PropertyTypeDescription
fromObjectReferencefrom is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed
importPolicyobjectTagImportPolicy controls how images related to this tag will be imported.
includeManifestbooleanincludeManifest determines if the manifest for each image is returned in the response
referencePolicyobjectTagReferencePolicy 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.repository.importPolicy

Description

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

Type
`object`
PropertyTypeDescription
importModestringimportMode describes how to import an image manifest.
insecurebooleaninsecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.
scheduledbooleanscheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported

.spec.repository.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
PropertyTypeDescription
typestringtype 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.

.status

Description

ImageStreamImportStatus contains information about the status of an image stream import.

Type
`object`
PropertyTypeDescription
imagesarrayimages is set with the result of importing spec.images
images[]objectImageImportStatus describes the result of an image import.
importobjectAn ImageStream stores a mapping of tags to images, metadata overrides that are applied when images are tagged in a stream, and an optional reference to a container image repository on a registry. Users typically update the spec.tags field to point to external images which are imported from container registries using credentials in your namespace with the pull secret type, or to existing image stream tags and images which are immediately accessible for tagging or pulling. The history of images applied to a tag is visible in the status.tags field and any user who can view an image stream is allowed to tag that image into their own image streams. Access to pull images from the integrated registry is granted by having the "get imagestreams/layers" permission on a given image stream. Users may remove a tag by deleting the imagestreamtag resource, which causes both spec and status for that tag to be removed. Image stream history is retained until an administrator runs the prune operation, which removes references that are no longer in use. To preserve a historical image, ensure there is a tag in spec pointing to that image by its digest.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
repositoryobjectRepositoryImportStatus describes the result of an image repository import

.status.images

Description

images is set with the result of importing spec.images

Type
`array`

.status.images[]

Description

ImageImportStatus describes the result of an image import.

Type
`object`
Required
  • status
PropertyTypeDescription
imageobjectImage 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).
manifestsarraymanifests holds sub-manifests metadata when importing a manifest list
manifests[]objectImage 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).
statusStatus_v2status is the status of the image import, including errors encountered while retrieving the image
tagstringtag is the tag this image was located under, if any

.status.images[].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`
PropertyTypeDescription
apiVersionstringAPIVersion 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
dockerImageConfigstringdockerImageConfig 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.
dockerImageLayersarraydockerImageLayers 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[]objectImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.
dockerImageManifeststringdockerImageManifest is the raw JSON of the manifest
dockerImageManifestMediaTypestringdockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.
dockerImageManifestsarraydockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.
dockerImageManifests[]objectImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.
dockerImageMetadataRawExtensiondockerImageMetadata contains metadata about this image
dockerImageMetadataVersionstringdockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"
dockerImageReferencestringdockerImageReference is the string that can be used to pull this image.
dockerImageSignaturesarray (string)dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
signaturesarraysignatures holds all signatures of the image.
signatures[]objectImageSignature 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).

.status.images[].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`

.status.images[].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
PropertyTypeDescription
mediaTypestringmediaType of the referenced object.
namestringname of the layer as defined by the underlying store.
sizeintegersize of the layer in bytes as defined by the underlying store.

.status.images[].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`

.status.images[].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
PropertyTypeDescription
architecturestringarchitecture specifies the supported CPU architecture, for example amd64 or ppc64le.
digeststringdigest is the unique identifier for the manifest. It refers to an Image object.
manifestSizeintegermanifestSize represents the size of the raw object contents, in bytes.
mediaTypestringmediaType 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.
osstringos specifies the operating system, for example linux.
variantstringvariant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU.

.status.images[].image.signatures

Description

signatures holds all signatures of the image.

Type
`array`

.status.images[].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
PropertyTypeDescription
apiVersionstringAPIVersion 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
conditionsarrayconditions represent the latest available observations of a signature’s current state.
conditions[]objectSignatureCondition describes an image signature condition of particular kind at particular probe time.
contentstringRequired: An opaque binary string which is an image’s signature.
createdTimeIf specified, it is the time of signature’s creation.
imageIdentitystringA 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").
issuedByobjectSignatureIssuer holds information about an issuer of signing certificate or key.
issuedToobjectSignatureSubject holds information about a person or entity who created the signature.
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
signedClaimsobject (string)Contains claims from the signature.
typestringRequired: Describes a type of stored blob.

.status.images[].image.signatures[].conditions

Description

conditions represent the latest available observations of a signature’s current state.

Type
`array`

.status.images[].image.signatures[].conditions[]

Description

SignatureCondition describes an image signature condition of particular kind at particular probe time.

Type
`object`
Required
  • type
  • status
PropertyTypeDescription
lastProbeTimeTimeLast time the condition was checked.
lastTransitionTimeTimeLast time the condition transit from one status to another.
messagestringHuman readable message indicating details about last transition.
reasonstring(brief) reason for the condition’s last transition.
statusstringstatus of the condition, one of True, False, Unknown.
typestringtype of signature condition, Complete or Failed.

.status.images[].image.signatures[].issuedBy

Description

SignatureIssuer holds information about an issuer of signing certificate or key.

Type
`object`
PropertyTypeDescription
commonNamestringCommon name (e.g. openshift-signing-service).
organizationstringorganization name.

.status.images[].image.signatures[].issuedTo

Description

SignatureSubject holds information about a person or entity who created the signature.

Type
`object`
Required
  • publicKeyID
PropertyTypeDescription
commonNamestringCommon name (e.g. openshift-signing-service).
organizationstringorganization name.
publicKeyIDstringIf 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).

.status.images[].manifests

Description

manifests holds sub-manifests metadata when importing a manifest list

Type
`array`

.status.images[].manifests[]

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`
PropertyTypeDescription
apiVersionstringAPIVersion 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
dockerImageConfigstringdockerImageConfig 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.
dockerImageLayersarraydockerImageLayers 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[]objectImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.
dockerImageManifeststringdockerImageManifest is the raw JSON of the manifest
dockerImageManifestMediaTypestringdockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.
dockerImageManifestsarraydockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.
dockerImageManifests[]objectImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.
dockerImageMetadataRawExtensiondockerImageMetadata contains metadata about this image
dockerImageMetadataVersionstringdockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"
dockerImageReferencestringdockerImageReference is the string that can be used to pull this image.
dockerImageSignaturesarray (string)dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
signaturesarraysignatures holds all signatures of the image.
signatures[]objectImageSignature 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).

.status.images[].manifests[].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`

.status.images[].manifests[].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
PropertyTypeDescription
mediaTypestringmediaType of the referenced object.
namestringname of the layer as defined by the underlying store.
sizeintegersize of the layer in bytes as defined by the underlying store.

.status.images[].manifests[].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`

.status.images[].manifests[].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
PropertyTypeDescription
architecturestringarchitecture specifies the supported CPU architecture, for example amd64 or ppc64le.
digeststringdigest is the unique identifier for the manifest. It refers to an Image object.
manifestSizeintegermanifestSize represents the size of the raw object contents, in bytes.
mediaTypestringmediaType 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.
osstringos specifies the operating system, for example linux.
variantstringvariant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU.

.status.images[].manifests[].signatures

Description

signatures holds all signatures of the image.

Type
`array`

.status.images[].manifests[].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
PropertyTypeDescription
apiVersionstringAPIVersion 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
conditionsarrayconditions represent the latest available observations of a signature’s current state.
conditions[]objectSignatureCondition describes an image signature condition of particular kind at particular probe time.
contentstringRequired: An opaque binary string which is an image’s signature.
createdTimeIf specified, it is the time of signature’s creation.
imageIdentitystringA 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").
issuedByobjectSignatureIssuer holds information about an issuer of signing certificate or key.
issuedToobjectSignatureSubject holds information about a person or entity who created the signature.
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
signedClaimsobject (string)Contains claims from the signature.
typestringRequired: Describes a type of stored blob.

.status.images[].manifests[].signatures[].conditions

Description

conditions represent the latest available observations of a signature’s current state.

Type
`array`

.status.images[].manifests[].signatures[].conditions[]

Description

SignatureCondition describes an image signature condition of particular kind at particular probe time.

Type
`object`
Required
  • type
  • status
PropertyTypeDescription
lastProbeTimeTimeLast time the condition was checked.
lastTransitionTimeTimeLast time the condition transit from one status to another.
messagestringHuman readable message indicating details about last transition.
reasonstring(brief) reason for the condition’s last transition.
statusstringstatus of the condition, one of True, False, Unknown.
typestringtype of signature condition, Complete or Failed.

.status.images[].manifests[].signatures[].issuedBy

Description

SignatureIssuer holds information about an issuer of signing certificate or key.

Type
`object`
PropertyTypeDescription
commonNamestringCommon name (e.g. openshift-signing-service).
organizationstringorganization name.

.status.images[].manifests[].signatures[].issuedTo

Description

SignatureSubject holds information about a person or entity who created the signature.

Type
`object`
Required
  • publicKeyID
PropertyTypeDescription
commonNamestringCommon name (e.g. openshift-signing-service).
organizationstringorganization name.
publicKeyIDstringIf 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).

.status.import

Description

An ImageStream stores a mapping of tags to images, metadata overrides that are applied when images are tagged in a stream, and an optional reference to a container image repository on a registry. Users typically update the spec.tags field to point to external images which are imported from container registries using credentials in your namespace with the pull secret type, or to existing image stream tags and images which are immediately accessible for tagging or pulling. The history of images applied to a tag is visible in the status.tags field and any user who can view an image stream is allowed to tag that image into their own image streams. Access to pull images from the integrated registry is granted by having the "get imagestreams/layers" permission on a given image stream. Users may remove a tag by deleting the imagestreamtag resource, which causes both spec and status for that tag to be removed. Image stream history is retained until an administrator runs the prune operation, which removes references that are no longer in use. To preserve a historical image, ensure there is a tag in spec pointing to that image by its digest.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
`object`
PropertyTypeDescription
apiVersionstringAPIVersion 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
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specobjectImageStreamSpec represents options for ImageStreams.
statusobjectImageStreamStatus contains information about the state of this image stream.

.status.import.spec

Description

ImageStreamSpec represents options for ImageStreams.

Type
`object`
PropertyTypeDescription
dockerImageRepositorystringdockerImageRepository is optional, if specified this stream is backed by a container repository on this server Deprecated: This field is deprecated as of v3.7 and will be removed in a future release. Specify the source for the tags to be imported in each tag via the spec.tags.from reference instead.
lookupPolicyobjectImageLookupPolicy describes how an image stream can be used to override the image references used by pods, builds, and other resources in a namespace.
tagsarraytags map arbitrary string values to specific image locators
tags[]objectTagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.

.status.import.spec.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
PropertyTypeDescription
localbooleanlocal 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.

.status.import.spec.tags

Description

tags map arbitrary string values to specific image locators

Type
`array`

.status.import.spec.tags[]

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
PropertyTypeDescription
annotationsobject (string)Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags.
fromObjectReferenceOptional; 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.
generationintegergeneration 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.
importPolicyobjectTagImportPolicy controls how images related to this tag will be imported.
namestringname of the tag
referencebooleanreference states if the tag will be imported. Default value is false, which means the tag will be imported.
referencePolicyobjectTagReferencePolicy 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.

.status.import.spec.tags[].importPolicy

Description

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

Type
`object`
PropertyTypeDescription
importModestringimportMode describes how to import an image manifest.
insecurebooleaninsecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.
scheduledbooleanscheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported

.status.import.spec.tags[].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
PropertyTypeDescription
typestringtype 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.

.status.import.status

Description

ImageStreamStatus contains information about the state of this image stream.

Type
`object`
PropertyTypeDescription
dockerImageRepositorystringdockerImageRepository represents the effective location this stream may be accessed at. May be empty until the server determines where the repository is located
publicDockerImageRepositorystringpublicDockerImageRepository represents the public location from where the image can be pulled outside the cluster. This field may be empty if the administrator has not exposed the integrated registry externally.
tagsarraytags are a historical record of images associated with each tag. The first entry in the TagEvent array is the currently tagged image.
tags[]objectNamedTagEventList relates a tag to its image history.

.status.import.status.tags

Description

tags are a historical record of images associated with each tag. The first entry in the TagEvent array is the currently tagged image.

Type
`array`

.status.import.status.tags[]

Description

NamedTagEventList relates a tag to its image history.

Type
`object`
Required
  • tag
  • items
PropertyTypeDescription
conditionsarrayconditions is an array of conditions that apply to the tag event list.
conditions[]objectTagEventCondition contains condition information for a tag event.
itemsarrayStandard object’s metadata.
items[]objectTagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag.
tagstringtag is the tag for which the history is recorded

.status.import.status.tags[].conditions

Description

conditions is an array of conditions that apply to the tag event list.

Type
`array`

.status.import.status.tags[].conditions[]

Description

TagEventCondition contains condition information for a tag event.

Type
`object`
Required
  • type
  • status
  • generation
PropertyTypeDescription
generationintegergeneration is the spec tag generation that this status corresponds to
lastTransitionTimeTimelastTransitionTime is the time the condition transitioned from one status to another.
messagestringmessage is a human readable description of the details about last transition, complementing reason.
reasonstringreason is a brief machine readable explanation for the condition’s last transition.
statusstringstatus of the condition, one of True, False, Unknown.
typestringtype of tag event condition, currently only ImportSuccess

.status.import.status.tags[].items

Description

Standard object’s metadata.

Type
`array`

.status.import.status.tags[].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
PropertyTypeDescription
createdTimecreated holds the time the TagEvent was created
dockerImageReferencestringdockerImageReference is the string that can be used to pull this image
generationintegergeneration is the spec tag generation that resulted in this tag being updated
imagestringimage is the image

.status.repository

Description

RepositoryImportStatus describes the result of an image repository import

Type
`object`
PropertyTypeDescription
additionalTagsarray (string)additionalTags are tags that exist in the repository but were not imported because a maximum limit of automatic imports was applied.
imagesarrayimages is a list of images successfully retrieved by the import of the repository.
images[]objectImageImportStatus describes the result of an image import.
statusStatus_v2status reflects whether any failure occurred during import

.status.repository.images

Description

images is a list of images successfully retrieved by the import of the repository.

Type
`array`

.status.repository.images[]

Description

ImageImportStatus describes the result of an image import.

Type
`object`
Required
  • status
PropertyTypeDescription
imageobjectImage 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).
manifestsarraymanifests holds sub-manifests metadata when importing a manifest list
manifests[]objectImage 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).
statusStatus_v2status is the status of the image import, including errors encountered while retrieving the image
tagstringtag is the tag this image was located under, if any

.status.repository.images[].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`
PropertyTypeDescription
apiVersionstringAPIVersion 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
dockerImageConfigstringdockerImageConfig 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.
dockerImageLayersarraydockerImageLayers 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[]objectImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.
dockerImageManifeststringdockerImageManifest is the raw JSON of the manifest
dockerImageManifestMediaTypestringdockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.
dockerImageManifestsarraydockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.
dockerImageManifests[]objectImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.
dockerImageMetadataRawExtensiondockerImageMetadata contains metadata about this image
dockerImageMetadataVersionstringdockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"
dockerImageReferencestringdockerImageReference is the string that can be used to pull this image.
dockerImageSignaturesarray (string)dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
signaturesarraysignatures holds all signatures of the image.
signatures[]objectImageSignature 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).

.status.repository.images[].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`

.status.repository.images[].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
PropertyTypeDescription
mediaTypestringmediaType of the referenced object.
namestringname of the layer as defined by the underlying store.
sizeintegersize of the layer in bytes as defined by the underlying store.

.status.repository.images[].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`

.status.repository.images[].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
PropertyTypeDescription
architecturestringarchitecture specifies the supported CPU architecture, for example amd64 or ppc64le.
digeststringdigest is the unique identifier for the manifest. It refers to an Image object.
manifestSizeintegermanifestSize represents the size of the raw object contents, in bytes.
mediaTypestringmediaType 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.
osstringos specifies the operating system, for example linux.
variantstringvariant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU.

.status.repository.images[].image.signatures

Description

signatures holds all signatures of the image.

Type
`array`

.status.repository.images[].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
PropertyTypeDescription
apiVersionstringAPIVersion 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
conditionsarrayconditions represent the latest available observations of a signature’s current state.
conditions[]objectSignatureCondition describes an image signature condition of particular kind at particular probe time.
contentstringRequired: An opaque binary string which is an image’s signature.
createdTimeIf specified, it is the time of signature’s creation.
imageIdentitystringA 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").
issuedByobjectSignatureIssuer holds information about an issuer of signing certificate or key.
issuedToobjectSignatureSubject holds information about a person or entity who created the signature.
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
signedClaimsobject (string)Contains claims from the signature.
typestringRequired: Describes a type of stored blob.

.status.repository.images[].image.signatures[].conditions

Description

conditions represent the latest available observations of a signature’s current state.

Type
`array`

.status.repository.images[].image.signatures[].conditions[]

Description

SignatureCondition describes an image signature condition of particular kind at particular probe time.

Type
`object`
Required
  • type
  • status
PropertyTypeDescription
lastProbeTimeTimeLast time the condition was checked.
lastTransitionTimeTimeLast time the condition transit from one status to another.
messagestringHuman readable message indicating details about last transition.
reasonstring(brief) reason for the condition’s last transition.
statusstringstatus of the condition, one of True, False, Unknown.
typestringtype of signature condition, Complete or Failed.

.status.repository.images[].image.signatures[].issuedBy

Description

SignatureIssuer holds information about an issuer of signing certificate or key.

Type
`object`
PropertyTypeDescription
commonNamestringCommon name (e.g. openshift-signing-service).
organizationstringorganization name.

.status.repository.images[].image.signatures[].issuedTo

Description

SignatureSubject holds information about a person or entity who created the signature.

Type
`object`
Required
  • publicKeyID
PropertyTypeDescription
commonNamestringCommon name (e.g. openshift-signing-service).
organizationstringorganization name.
publicKeyIDstringIf 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).

.status.repository.images[].manifests

Description

manifests holds sub-manifests metadata when importing a manifest list

Type
`array`

.status.repository.images[].manifests[]

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`
PropertyTypeDescription
apiVersionstringAPIVersion 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
dockerImageConfigstringdockerImageConfig 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.
dockerImageLayersarraydockerImageLayers 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[]objectImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.
dockerImageManifeststringdockerImageManifest is the raw JSON of the manifest
dockerImageManifestMediaTypestringdockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.
dockerImageManifestsarraydockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.
dockerImageManifests[]objectImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.
dockerImageMetadataRawExtensiondockerImageMetadata contains metadata about this image
dockerImageMetadataVersionstringdockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"
dockerImageReferencestringdockerImageReference is the string that can be used to pull this image.
dockerImageSignaturesarray (string)dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
signaturesarraysignatures holds all signatures of the image.
signatures[]objectImageSignature 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).

.status.repository.images[].manifests[].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`

.status.repository.images[].manifests[].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
PropertyTypeDescription
mediaTypestringmediaType of the referenced object.
namestringname of the layer as defined by the underlying store.
sizeintegersize of the layer in bytes as defined by the underlying store.

.status.repository.images[].manifests[].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`

.status.repository.images[].manifests[].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
PropertyTypeDescription
architecturestringarchitecture specifies the supported CPU architecture, for example amd64 or ppc64le.
digeststringdigest is the unique identifier for the manifest. It refers to an Image object.
manifestSizeintegermanifestSize represents the size of the raw object contents, in bytes.
mediaTypestringmediaType 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.
osstringos specifies the operating system, for example linux.
variantstringvariant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU.

.status.repository.images[].manifests[].signatures

Description

signatures holds all signatures of the image.

Type
`array`

.status.repository.images[].manifests[].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
PropertyTypeDescription
apiVersionstringAPIVersion 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
conditionsarrayconditions represent the latest available observations of a signature’s current state.
conditions[]objectSignatureCondition describes an image signature condition of particular kind at particular probe time.
contentstringRequired: An opaque binary string which is an image’s signature.
createdTimeIf specified, it is the time of signature’s creation.
imageIdentitystringA 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").
issuedByobjectSignatureIssuer holds information about an issuer of signing certificate or key.
issuedToobjectSignatureSubject holds information about a person or entity who created the signature.
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
signedClaimsobject (string)Contains claims from the signature.
typestringRequired: Describes a type of stored blob.

.status.repository.images[].manifests[].signatures[].conditions

Description

conditions represent the latest available observations of a signature’s current state.

Type
`array`

.status.repository.images[].manifests[].signatures[].conditions[]

Description

SignatureCondition describes an image signature condition of particular kind at particular probe time.

Type
`object`
Required
  • type
  • status
PropertyTypeDescription
lastProbeTimeTimeLast time the condition was checked.
lastTransitionTimeTimeLast time the condition transit from one status to another.
messagestringHuman readable message indicating details about last transition.
reasonstring(brief) reason for the condition’s last transition.
statusstringstatus of the condition, one of True, False, Unknown.
typestringtype of signature condition, Complete or Failed.

.status.repository.images[].manifests[].signatures[].issuedBy

Description

SignatureIssuer holds information about an issuer of signing certificate or key.

Type
`object`
PropertyTypeDescription
commonNamestringCommon name (e.g. openshift-signing-service).
organizationstringorganization name.

.status.repository.images[].manifests[].signatures[].issuedTo

Description

SignatureSubject holds information about a person or entity who created the signature.

Type
`object`
Required
  • publicKeyID
PropertyTypeDescription
commonNamestringCommon name (e.g. openshift-signing-service).
organizationstringorganization name.
publicKeyIDstringIf 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}/imagestreamimports
    • POST: create an ImageStreamImport

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

Global query parameters

ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 method
`POST`
Description
create an ImageStreamImport

Body parameters

ParameterTypeDescription
bodyImageStreamImport schema

HTTP responses

HTTP codeReponse body
200 - OKImageStreamImport schema
201 - CreatedImageStreamImport schema
202 - AcceptedImageStreamImport schema
401 - UnauthorizedEmpty