Chapter 6. ImageStreamLayers [image.openshift.io/v1]


Description

ImageStreamLayers describes information about the layers referenced by images in this image stream.

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

Type
object
Required
  • blobs
  • images

6.1. Specification

PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

blobs

object

blobs is a map of blob name to metadata about the blob.

blobs{}

object

ImageLayerData contains metadata about an image layer.

images

object

images is a map between an image name and the names of the blobs and config that comprise the image.

images{}

object

ImageBlobReferences describes the blob references within an image.

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

6.1.1. .blobs

Description
blobs is a map of blob name to metadata about the blob.
Type
object

6.1.2. .blobs{}

Description
ImageLayerData contains metadata about an image layer.
Type
object
Required
  • size
  • mediaType
PropertyTypeDescription

mediaType

string

MediaType of the referenced object.

size

integer

Size of the layer in bytes as defined by the underlying store. This field is optional if the necessary information about size is not available.

6.1.3. .images

Description
images is a map between an image name and the names of the blobs and config that comprise the image.
Type
object

6.1.4. .images{}

Description
ImageBlobReferences describes the blob references within an image.
Type
object
PropertyTypeDescription

config

string

config, if set, is the blob that contains the image config. Some images do not have separate config blobs and this field will be set to nil if so.

imageMissing

boolean

imageMissing is true if the image is referenced by the image stream but the image object has been deleted from the API by an administrator. When this field is set, layers and config fields may be empty and callers that depend on the image metadata should consider the image to be unavailable for download or viewing.

layers

array (string)

layers is the list of blobs that compose this image, from base layer to top layer. All layers referenced by this array will be defined in the blobs map. Some images may have zero layers.

manifests

array (string)

manifests is the list of other image names that this image points to. For a single architecture image, it is empty. For a multi-arch image, it consists of the digests of single architecture images, such images shouldn’t have layers nor config.

6.2. API endpoints

The following API endpoints are available:

  • /apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/layers

    • GET: read layers of the specified ImageStream

6.2.1. /apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/layers

Table 6.1. Global path parameters
ParameterTypeDescription

name

string

name of the ImageStreamLayers

HTTP method
GET
Description
read layers of the specified ImageStream
Table 6.2. HTTP responses
HTTP codeReponse body

200 - OK

ImageStreamLayers schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.