An image stream comprises any number of container images identified by tags. It presents a single virtual view of related images, similar to a Docker image repository.
By watching an image stream, builds and deployments can receive notifications when new images are added or modified and react by performing a build or deployment, respectively.
There are many ways you can interact with images and set up image streams, depending on where the images' registries are located, any authentication requirements around those registries, and how you want your builds and deployments to behave. The following sections cover a range of these topics.
Before working with {product-title} image streams and their tags, it helps to first understand image tags in the context of container images generally.
Container images can have names added to them that make it more intuitive to determine what they contain, called a tag. Using a tag to specify the version of what is contained in the image is a common use case. If you have an image named ruby, you could have a tag named 2.0 for 2.0 version of Ruby, and another named latest to indicate literally the latest built image in that repository overall.
When interacting directly with images using the docker CLI, the docker tag
command can add tags, which essentially adds an alias to an image that can
consist of several parts. Those parts can include:
<registry_server>/<user_name>/<image_name>:<tag>
The <user_name> part in the above could also refer to a
project or
namespace
if the image is being stored in an {product-title} environment with an internal
registry (the OpenShift Container Registry).
{product-title} provides the oc tag command, which is similar to the docker
tag command, but operates on image streams instead of directly on images.
|
Note
|
See Red Hat Enterprise Linux 7’s
Getting Started with Containers
documentation for more about tagging images directly using the |
Keeping in mind that an image stream in {product-title} comprises zero or more
container images identified by tags, you can add tags to an image stream using the
oc tag command:
$ oc tag <source> <destination>
For example, to configure the ruby image streams static-2.0 tag to always refer to the current image for the ruby image streams 2.0 tag:
$ oc tag ruby:2.0 ruby:static-2.0
This creates a new image stream tag named static-2.0 in the ruby image
stream. The new tag directly references the image id that the ruby:2.0
image stream tag pointed to at the time oc tag was run, and the image it points
to never changes.
There are different types of tags available. The default behavior uses a permanent tag, which points to a specific image in time; even when the source changes, the new (destination) tag does not change.
A tracking tag means the destination tag’s metadata is be updated during
the import of the source tag. To ensure the destination tag is updated whenever the
source tag changes, use the --alias=true flag:
$ oc tag --alias=true <source> <destination>
|
Note
|
Use a tracking tag for creating permanent aliases (for example, |
See Importing Tag and Image Metadata for more details.
The --reference flag creates an image stream tag that is not imported. The
tag points to the source location, permanently.
If you want to instruct Docker to always fetch the tagged image from the
integrated registry, use --reference-policy=local. The registry uses the
pull-through feature
to serve the image to the client. By default, the image blobs are
mirrored locally by the registry. As a result, they can be pulled more quickly
the next time they are needed. The flag also allows for pulling from
insecure registries without a need to supply --insecure-registry to the Docker
daemon as long as the image stream has an insecure annotation
or the tag has an insecure import policy.
Images evolve over time and their tags reflect this. An image tag always points to the latest image built.
If there is too much information embedded in a tag name (for example,
v2.0.1-may-2016), the tag points to just one revision of an image and is
never updated. Using default image pruning options, such an image is never
removed.
Instead, if the tag is named v2.0, more image revisions are more likely. This
results in longer
tag history and, therefore, the image pruner is more likely to remove old and unused images.
Although tag naming convention is up to you, here are a few examples in the
format <image_name>:<image_tag>:
| Description | Example |
|---|---|
Revision |
|
Architecture |
|
Base image |
|
Latest (potentially unstable) |
|
Latest stable |
|
If you require dates in tag names, periodically inspect old and unsupported
images and istags and remove them. Otherwise, you might experience increasing
resource usage caused by old images.
To remove a tag completely from an image stream run:
$ oc delete istag/ruby:latest
or:
$ oc tag -d ruby:latest
Images can be referenced in image streams using the following reference types:
-
An
ImageStreamTagis used to reference or retrieve an image for a given image stream and tag. It uses the following convention for its name:<image_stream_name>:<tag>
-
An
ImageStreamImageis used to reference or retrieve an image for a given image stream and image name. It uses the following convention for its name:<image_stream_name>@<id>
The
<id>is an immutable identifier for a specific image, also called a digest. -
A
DockerImageis used to reference or retrieve an image for a given external registry. It uses standard Docker pull specification for its name, e.g.:openshift/ruby-20-centos7:2.0
NoteWhen no tag is specified, it is assumed the latest tag is used.
You can also reference a third-party registry:
registry.access.redhat.com/rhel7:latest
Or an image with a digest:
centos/ruby-22-centos7@sha256:3a335d7d8a452970c5b4054ad7118ff134b3a6b50a2bb6d0c07c746e8986b28e
When viewing example image stream definitions, such as the
example
CentOS image streams, you may notice they contain definitions of
ImageStreamTag and references to DockerImage, but nothing related to
ImageStreamImage.
This is because the ImageStreamImage objects are automatically created in
{product-title} whenever you import or tag an image into the image stream. You
should never have to explicitly define an ImageStreamImage object in any
image stream definition that you use to create image streams.
You can view an image’s object definition by retrieving an ImageStreamImage
definition using the image stream name and ID:
$ oc export isimage <image_stream_name>@<id>
|
Note
|
You can find valid $ oc describe is <image_stream_name> |
For example, from the ruby image stream asking for the ImageStreamImage
with the name and ID of ruby@3a335d7:
ImageStreamImage$ oc export isimage ruby@3a335d7
apiVersion: v1
image:
dockerImageLayers:
- name: sha256:a3ed95caeb02ffe68cdd9fd84406680ae93d633cb16422d00e8a7c22955b46d4
size: 0
- name: sha256:ee1dd2cb6df21971f4af6de0f1d7782b81fb63156801cfde2bb47b4247c23c29
size: 196634330
- name: sha256:a3ed95caeb02ffe68cdd9fd84406680ae93d633cb16422d00e8a7c22955b46d4
size: 0
- name: sha256:a3ed95caeb02ffe68cdd9fd84406680ae93d633cb16422d00e8a7c22955b46d4
size: 0
- name: sha256:ca062656bff07f18bff46be00f40cfbb069687ec124ac0aa038fd676cfaea092
size: 177723024
- name: sha256:63d529c59c92843c395befd065de516ee9ed4995549f8218eac6ff088bfa6b6e
size: 55679776
dockerImageMetadata:
Architecture: amd64
Author: SoftwareCollections.org <[email protected]>
Config:
Cmd:
- /bin/sh
- -c
- $STI_SCRIPTS_PATH/usage
Entrypoint:
- container-entrypoint
Env:
- PATH=/opt/app-root/src/bin:/opt/app-root/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
- STI_SCRIPTS_URL=image:///usr/libexec/s2i
- STI_SCRIPTS_PATH=/usr/libexec/s2i
- HOME=/opt/app-root/src
- BASH_ENV=/opt/app-root/etc/scl_enable
- ENV=/opt/app-root/etc/scl_enable
- PROMPT_COMMAND=. /opt/app-root/etc/scl_enable
- RUBY_VERSION=2.2
ExposedPorts:
8080/tcp: {}
Image: d9c3abc5456a9461954ff0de8ae25e0e016aad35700594714d42b687564b1f51
Labels:
build-date: 2015-12-23
io.k8s.description: Platform for building and running Ruby 2.2 applications
io.k8s.display-name: Ruby 2.2
io.openshift.builder-base-version: 8d95148
io.openshift.builder-version: 8847438ba06307f86ac877465eadc835201241df
io.openshift.expose-services: 8080:http
io.openshift.s2i.scripts-url: image:///usr/libexec/s2i
io.openshift.tags: builder,ruby,ruby22
io.s2i.scripts-url: image:///usr/libexec/s2i
license: GPLv2
name: CentOS Base Image
vendor: CentOS
User: "1001"
WorkingDir: /opt/app-root/src
ContainerConfig: {}
Created: 2016-01-26T21:07:27Z
DockerVersion: 1.8.2-el7
Id: 57b08d979c86f4500dc8cad639c9518744c8dd39447c055a3517dc9c18d6fccd
Parent: d9c3abc5456a9461954ff0de8ae25e0e016aad35700594714d42b687564b1f51
Size: 430037130
apiVersion: "1.0"
kind: DockerImage
dockerImageMetadataVersion: "1.0"
dockerImageReference: centos/ruby-22-centos7@sha256:3a335d7d8a452970c5b4054ad7118ff134b3a6b50a2bb6d0c07c746e8986b28e
metadata:
creationTimestamp: 2016-01-29T13:17:45Z
name: sha256:3a335d7d8a452970c5b4054ad7118ff134b3a6b50a2bb6d0c07c746e8986b28e
resourceVersion: "352"
uid: af2e7a0c-c68a-11e5-8a99-525400f25e34
kind: ImageStreamImage
metadata:
creationTimestamp: null
name: ruby@3a335d7
namespace: openshift
selflink: /oapi/v1/namespaces/openshift/imagestreamimages/ruby@3a335d7
You can access {product-title}'s internal registry directly to push or pull
images. For example, this could be helpful if you wanted to
create an image
stream by manually pushing an image, or just to docker pull an image
directly.
The internal registry authenticates using the same
tokens
as the {product-title} API. To perform a docker login against the internal
registry, you can choose any user name and email, but the password must be a
valid {product-title} token.
To log into the internal registry:
-
Log in to {product-title}:
$ oc login
-
Get your access token:
$ oc whoami -t
-
Log in to the internal registry using the token. You must have docker installed on your system:
$ docker login -u <user_name> -e <email_address> \
NoteContact your cluster administrator if you do not know the registry IP or host name and port to use.
In order to pull an image, the authenticated user must have get rights on the
requested imagestreams/layers. In order to push an image, the authenticated
user must have update rights on the requested imagestreams/layers.
By default, all service accounts in a project have rights to pull any image in the same project, and the builder service account has rights to push any image in the same project.
A private registry can delegate authentication to a separate service. In these cases, image pull secrets must be defined for both the authentication and registry endpoints.
|
Note
|
Third-party images in the Red Hat Container Catalog are served from the Red Hat
Connect Partner Registry ( |
-
Create a secret for the delegated authentication server:
$ oc create secret docker-registry \ --docker-server=sso.redhat.com \ [email protected] \ --docker-password=******** \ --docker-email=unused \ redhat-connect-sso secret/redhat-connect-sso -
Create a secret for the private registry:
$ oc create secret docker-registry \ --docker-server=privateregistry.example.com \ [email protected] \ --docker-password=******** \ --docker-email=unused \ private-registry secret/private-registry
|
Note
|
The Red Hat Connect Partner Registry ( $ docker login registry.connect.redhat.com --username [email protected] Password: ************* Login Succeeded $ oc create secret generic redhat-connect --from-file=.dockerconfigjson=.docker/config.json $ oc secrets link default redhat-connect --for=pull |
An image stream can be configured to import tag and image metadata from an image repository in an external Docker image registry. You can do this using a few different methods.
-
You can manually import tag and image information with the
oc import-imagecommand using the--fromoption:$ oc import-image <image_stream_name>[:<tag>] --from=<docker_image_repo> --confirm
For example:
$ oc import-image my-ruby --from=docker.io/openshift/ruby-20-centos7 --confirm The import completed successfully. Name: my-ruby Created: Less than a second ago Labels: <none> Annotations: openshift.io/image.dockerRepositoryCheck=2016-05-06T20:59:30Z Docker Pull Spec: 172.30.94.234:5000/demo-project/my-ruby Tag Spec Created PullSpec Image latest docker.io/openshift/ruby-20-centos7 Less than a second ago docker.io/openshift/ruby-20-centos7@sha256:772c5bf9b2d1e8... <same>
You can also add the
--allflag to import all tags for the image instead of just latest. -
Like most objects in {product-title}, you can also write and save a JSON or YAML definition to a file then create the object using the CLI. Set the
spec.dockerImageRepositoryfield to the Docker pull spec for the image:apiVersion: "v1" kind: "ImageStream" metadata: name: "my-ruby" spec: dockerImageRepository: "docker.io/openshift/ruby-20-centos7"
Then create the object:
$ oc create -f <file>
When you create an image stream that references an image in an external Docker registry, {product-title} communicates with the external registry within a short amount of time to get up to date information about the image.
After the tag and image metadata is synchronized, the image stream object would look similar to the following:
apiVersion: v1
kind: ImageStream
metadata:
name: my-ruby
namespace: demo-project
selflink: /oapi/v1/namespaces/demo-project/imagestreams/my-ruby
uid: 5b9bd745-13d2-11e6-9a86-0ada84b8265d
resourceVersion: '4699413'
generation: 2
creationTimestamp: '2016-05-06T21:34:48Z'
annotations:
openshift.io/image.dockerRepositoryCheck: '2016-05-06T21:34:48Z'
spec:
dockerImageRepository: docker.io/openshift/ruby-20-centos7
tags:
-
name: latest
annotations: null
from:
kind: DockerImage
name: 'docker.io/openshift/ruby-20-centos7:latest'
generation: 2
importPolicy: { }
status:
dockerImageRepository: '172.30.94.234:5000/demo-project/my-ruby'
tags:
-
tag: latest
items:
-
created: '2016-05-06T21:34:48Z'
dockerImageReference: 'docker.io/openshift/ruby-20-centos7@sha256:772c5bf9b2d1e8e80742ed75aab05820419dc4532fa6d7ad8a1efddda5493dc3'
image: 'sha256:772c5bf9b2d1e8e80742ed75aab05820419dc4532fa6d7ad8a1efddda5493dc3'
generation: 2
You can set a tag to query external registries at a scheduled interval to
synchronize tag and image metadata by setting the --scheduled=true flag with
the oc tag command as mentioned in Adding Tags to Image
Streams.
Alternatively, you can set importPolicy.scheduled to true in the tag’s
definition:
apiVersion: v1
kind: ImageStream
metadata:
name: ruby
spec:
tags:
- from:
kind: DockerImage
name: openshift/ruby-20-centos7
name: latest
importPolicy:
scheduled: true
An image stream can be configured to import tag and image metadata from insecure image registries, such as those signed with a self-signed certificate or using plain HTTP instead of HTTPS.
To configure this, add the openshift.io/image.insecureRepository annotation
and set it to true. This setting bypasses certificate validation when
connecting to the registry:
kind: ImageStream
apiVersion: v1
metadata:
name: ruby
annotations:
openshift.io/image.insecureRepository: "true" (1)
spec:
dockerImageRepository: my.repo.com:5000/myimage-
Set the
openshift.io/image.insecureRepositoryannotation to true
|
Important
|
This option instructs integrated registry to fall back to an insecure transport
for any external image tagged in the image stream when serving it, which is
dangerous. If possible, avoid this risk by
marking just an |
The above annotation applies to all images and tags of a particular
ImageStream. For a finer-grained control, policies may be set on
istags.
Set importPolicy.insecure in the tag’s definition to true to allow a
fall-back to insecure transport just for images under this tag.
|
Note
|
The fall-back to insecure transport for an image under particular |
The Reference Policy allows you to specify from where resources that reference
this image stream tag pulls the image. It is only applicable to remote
images (those imported from external registries). There are two options to
choose from, Local and Source.
The Source policy instructs clients to pull directly from the source registry
of the image. The integrated registry is not involved unless the image is
managed by the cluster. (It is not an external image.) This is the default
policy.
The Local policy instructs clients to always pull from the integrated
registry. This is useful if you want to pull from external insecure registries
without modifying Docker daemon settings.
This policy only affects the use of the image stream tag. Components or operations that directly reference or pull the image using its external registry location is not redirected to the internal registry.
The pull-through feature of the registry serves the remote image to the client. This feature, which is on by default, must be enabled for the local reference policy to be used. Additionally, by default, all the blobs are mirrored for faster access later.
You can set the policy in a specification of image stream tag as
referencePolicy.type.
kind: ImageStream
apiVersion: v1
metadata:
name: ruby
tags:
- from:
kind: DockerImage
name: my.repo.com:5000/myimage
name: mytag
importPolicy:
insecure: true (1)
referencePolicy:
type: Local (2)-
Set tag
mytagto use an insecure connection to that registry. -
Set tag
mytagto use integrated registry for pulling external images. If the reference policy type is set toSource, clients fetch the image directly frommy.repo.com:5000/myimage.
An image stream can also be automatically created by manually pushing an image to the internal registry. This is only possible when using an {product-title} internal registry.
Before performing this procedure, the following must be satisfied:
-
The destination project you push to must already exist.
-
The user must be authorized to
{get, update} "imagestream/layers"in that project. In addition, since the image stream does not already exist, the user must be authorized to{create} "imagestream"in that project. If you are a project administrator, then you would have these permissions.
|
Note
|
The system:image-pusher role does not grant permission to create new image streams, only to push images to existing image streams, so it cannot be used to push images to image streams that do not yet exist unless additional permissions are also granted to the user. |
To create an image stream by manually pushing an image:
-
First, log in to the internal registry.
-
Then, tag your image using the appropriate internal registry location. For example, if you had already pulled the docker.io/centos:centos7 image locally:
-
Verify that the image stream was created:
When an image stream tag is updated to point to a new image, {product-title} can automatically take action to roll the new image out to resources that were using the old image. This is configured in different ways depending on the type of resource that is referencing the image stream tag.
OpenShift DeploymentConfigs and BuildConfigs can be automatically triggered by changes to ImageStreamTags. The triggered action can be run using the new value of the image referenced by the updated ImageStreamTag. For more details on using this capability see the documentation on BuildConfig triggers and DeploymentConfig triggers.
Unlike DeploymentConfigs and BuildConfigs, which include as part of their API definition a set of fields for controlling triggers, Kubernetes resources do not have fields for triggering. Instead, {product-title} uses annotations to allow users to request triggering. The annotation is defined as follows:
Key: image.openshift.io/triggers
Value: array of triggers, where each item has the schema:
[
{
"from" :{
"kind": "ImageStreamTag", // required, the resource to trigger from, must be ImageStreamTag
"name": "example:latest", // required, the name of an ImageStreamTag
"namespace": "myapp", // optional, defaults to the namespace of the object
},
// required, JSON path to change
// Note that this field is limited today, and only accepts a very specific set
// of inputs (a JSON path expression that precisely matches a container by ID or index).
// For pods this would be "spec.containers[?(@.name='web')].image".
"fieldPath": "spec.template.spec.containers[?(@.name='web')].image",
// optional, set to true to temporarily disable this trigger.
"paused": "false"
},
...
]
When {product-title} sees one of the core Kubernetes resources that contains both a pod template (i.e, only CronJobs, Deployments, StatefulSets, DaemonSets, Jobs, ReplicaSets, ReplicationControllers, and Pods) and this annotation, it attempts to update the object using the image currently associated with the ImageStreamTag referenced by trigger. The update is performed against the fieldPath specified.
In the following example the trigger fires when the example:latest imagestream tag is updated. Upon firing, the object’s pod template image reference for the web container is updated with a new image value. If the pod template is part of a Deployment definition, the change
to the pod template automatically triggers a deployment, effectively rolling out the new image.
image.openshift.io/triggers=[{"from":{"kind":"ImageStreamTag","name":"example:latest"},"fieldPath":"spec.template.spec.containers[?(@.name='web')].image"}]
When adding an Image Trigger to Deployments, you can also use the oc set triggers command. For example the following command adds an image change trigger to the Deployment named example such that when the example:latest image stream tag is updated, the web container inside the deployment updates with the new image value:
$ oc set triggers deploy/example --from-image=example:latest -c web
Unless the Deployment is paused, this pod template update automatically causes a deployment to occur with the new image value.
You can define image streams by writing the image stream definition for the entire image stream. This allows you to distribute
the definition to different clusters without running oc commands.
An image stream definition specifies information about the image stream and the specific tags to be imported.
apiVersion: v1
kind: ImageStream
metadata:
name: ruby
annotations:
openshift.io/display-name: Ruby (1)
spec:
tags:
- name: '2.0' (2)
annotations:
openshift.io/display-name: Ruby 2.0 (3)
description: >- (4)
Build and run Ruby 2.0 applications on CentOS 7. For more information
about using this builder image, including OpenShift considerations,
see
https://github.com/sclorg/s2i-ruby-container/tree/master/2.0/README.md.
iconClass: icon-ruby (5)
sampleRepo: 'https://github.com/openshift/ruby-ex.git' (6)
tags: 'builder,ruby' (7)
supports: 'ruby' (8)
version: '2.0' (9)
from:
kind: DockerImage (10)
name: 'docker.io/openshift/ruby-20-centos7:latest' (11)
-
A brief, user-friendly name for the whole image stream.
-
The tag is referred to as the version. Tags appear in a drop-down menu.
-
A user-friendly name for this tag within the image stream. This should be brief and include version information when appropriate.
-
A description of the tag, which includes enough detail for users to understand what the image is providing. It can include links to additional instructions. Limit the description to a few sentences.
-
The icon to show for this tag. Pick from our existing logo icons when possible. Icons from FontAwesome and Patternfly can also be used. Alternatively, provide icons through that can be added to an {product-title} cluster that uses your image stream. You must specify an icon class that exists, or it prevents falling back to the generic icon.
-
A URL to a source repository that works with this builder image tag and results in a sample running application.
-
Categories that the image stream tag is associated with. The builder tag is required for it to show up in the catalog. Add tags that associates it with one of the provided catalog categories. Refer to the
idandcategoryAliasesinCATALOG_CATEGORIESin the console’s constants file. The categories can also be for the whole cluster. -
Languages this image supports. This value is used during
oc new-appinvocations to try to match potential builder images to the provided source repository. -
Version information for this tag.
-
The type of object this image stream tag is referencing. Valid values are:
DockerImage,ImageStreamTag, andImageStreamImage. -
The object this image stream tag imports.
For more information on the fields that can be defined in an ImageStream, see the Imagestream API and the ImagestreamTag API.