Red Hat SummitThis documentation is for a release that is no longer maintained
See documentation for the latest supported version 3 or the latest supported version 4.Este contenido no está disponible en el idioma seleccionado.
Chapter 3. Builds and Images
3.1. BuildConfigs
3.1.1. Description of Resource
Build configurations define a build process for new Docker images. There are three types of builds possible - a Docker build using a Dockerfile, a Source-to-Image build that uses a specially prepared base image that accepts source code that it can make runnable, and a custom build that can run arbitrary Docker images as a base and accept the build parameters. Builds run on the cluster and on completion are pushed to the Docker registry specified in the "output" section. A build can be triggered via a webhook, when the base image changes, or when a user manually requests a new build be created.
Each build created by a build configuration is numbered and refers back to its parent configuration. Multiple builds can be triggered at once. Builds that do not have "output" set can be used to test code or run a verification build.
3.1.2. Creating a New BuildConfig
3.1.2.1. Request Breakdown
Creating a new buildconfig requires one request:
-
A POST request to the
buildconfigssubresource of the namespace.
The POST request uses a BuildConfig configuration in the request body. The following example uses a BuildConfig for the Jboss Developer kitchensink quickstart found at https://github.com/jboss-developer/jboss-eap-quickstarts.
3.1.2.2. POST Request to Create a New BuildConfig
Request Header
Request Body
3.1.3. Listing All BuildConfigs in an Environment
3.1.3.1. Request Breakdown
Listing all the buildconfigs in an environment requires one request:
-
A GET request to the
buildconfigsresource.
The GET request returns the BuildConfigList, listing the details of all buildconfigs in the environment.
3.1.3.2. GET Request to Return All BuildConfigs in an Environment
Request Header
3.1.4. Listing all BuildConfigs in a Namespace
3.1.4.1. Request Breakdown
Listing all the buildconfigs in a namespace requires one request:
-
A GET request to the
buildconfigssubresource of the namespace.
The GET request returns the BuildConfigList, listing the details of all buildconfigs in the namespace.
3.1.4.2. GET Request to Return BuildConfigs in Namespace
Request Header
3.1.5. Listing a Specific BuildConfig Configuration
3.1.5.1. Request Breakdown
Listing a specific buildconfig configuration requires one request:
-
A GET request to the buildconfig name in the
buildconfigssubresource of the namespace.
The GET request returns the BuildConfig configuration for the specified build.
3.1.5.2. GET Request to Return Specific BuildConfig Configuration
Request Header
3.1.6. Deleting a BuildConfig
3.1.6.1. Request Breakdown
Deleting a buildconfig requires one request:
-
A DELETE request to the buildconfig name in the
buildconfigssubresource of the namespace.
The DELETE request returns a code: 200 and the buildconfig is deleted.
3.1.6.2. DELETE Request to Delete BuildConfig
Request Header
3.2. Builds
3.2.1. Description of Resource
A build is the process of transforming input parameters into a resulting object. Most often, the process is used to transform input parameters or source code into a runnable image. A BuildConfig object is the definition of the entire build process.
3.2.2. Listing All Builds in an Environment
3.2.2.1. Request Breakdown
Listing all the builds in an environment requires one request:
-
A GET request to the
buildsresource.
The GET request returns the BuildList, listing the details of all builds in the environment.
3.2.2.2. GET Request to Return All Builds in an Environment
Request Header
3.2.3. Listing all Builds in a Namespace
3.2.3.1. Request Breakdown
Listing all the builds in a namespace requires one request:
-
A GET request to the
buildssubresource of the namespace.
The GET request returns the BuildList, listing the details of all builds in the namespace.
3.2.3.2. GET Request to Return Builds in Namespace
Request Header
3.2.4. Listing a Specific Build Configuration
3.2.4.1. Request Breakdown
Listing a specific build configuration requires one request:
-
A GET request to the build name in the
buildssubresource of the namespace.
The GET request returns the Build configuration for the specified build.
3.2.4.2. GET Request to Return Specific Build Configuration
Request Header
3.2.5. Starting a Build
3.2.5.1. Request Breakdown
Starting a build requires one request:
-
A POST request to the
instantiatesubresource of theBuildConfigname.
The POST request returns a BuildConfig configuration.
3.2.5.2. POST Request to Start a Build
Request Header
Request Body
3.2.6. Cancelling a Build
3.2.6.1. Request Breakdown
Cancelling a build consists of two requests:
-
A GET request to the build name in the
buildssubresource of the namespace. -
A PUT request with an added
cancelledfield to the build name in thebuildssubresource of the namespace.
The GET request returns a Build configuration.
The GET request is optional if an updated Build configuration can otherwise be provided for the PUT request.
Include a spec: status: cancelled parameter with value true in the Build configuration. Send the updated configuration as the request body in a PUT request to the build name.
3.2.6.2. GET Request to Return Build Configuration
Request Header
3.2.6.3. PUT Request to Cancel a Build
Request Header
Request Body Snippet
...
spec:
status:
cancelled: "true"
...
...
spec:
status:
cancelled: "true"
...3.2.7. Deleting a Build
3.2.7.1. Request Breakdown
Deleting a build requires one request:
-
A DELETE request to the build name in the
buildssubresource of the namespace.
The DELETE request returns a code: 200 and the build is deleted.
3.2.7.2. DELETE Request to Delete Build
Request Header
3.3. Images
3.3.1. Description of Resource
An image is a binary that includes all of the requirements for running a single container, as well as metadata describing its needs and capabilities.
3.3.2. Creating an Image
3.3.2.1. Request Breakdown
Creating a new image requires one request:
-
A POST request to the
imagessubresource of the namespace.
The POST request uses an Image configuration in the request body.
3.3.2.2. POST Request to Create a New Image
Request Header
Request Body
apiVersion: v1
kind: Image
metadata:
name: {$IMAGE}
dockerImageReference: registry.access.redhat.com/openshift3/jenkins-1-rhel7@sha256:9a370e38aca93da91bda03107f74fc245b169a8c642daf431a93289f44e187a0
apiVersion: v1
kind: Image
metadata:
name: {$IMAGE}
dockerImageReference: registry.access.redhat.com/openshift3/jenkins-1-rhel7@sha256:9a370e38aca93da91bda03107f74fc245b169a8c642daf431a93289f44e187a03.3.3. Listing All Images in a Cluster
3.3.3.1. Request Breakdown
Listing all the images in a cluster requires one request:
-
A GET request to the
imagesresource.
The GET request returns the ImageList, listing the details of all images in the cluster.
3.3.3.2. GET Request to Return All Images in a Cluster
Request Header
3.3.4. Listing a Specific Image Configuration
3.3.4.1. Request Breakdown
Listing a specific image configuration in a cluster requires one request:
-
A GET request to the
sha256:-prefixed image hash in theimagesresource.
The GET request returns the Image configuration for the specified image.
3.3.4.2. GET Request to Return Specific Image Configuration
Request Header
3.3.5. Deleting an Image
3.3.5.1. Request Breakdown
Deleting an Image requires one request:
-
A DELETE request to the
sha256:-prefixed image hash in theimagesresource.
The DELETE request returns a code: 200 and the Image is deleted.
3.3.5.2. DELETE Request to Delete Image
Request Header
3.4. Image Streams
3.4.1. Description of Resource
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 Docker image repository on a registry.
3.4.2. Creating a New Image Stream
3.4.2.1. Request Breakdown
Creating a new image stream requires one request:
-
A POST request to the
imagestreamssubresource of the namespace.
The POST request uses an ImageStream configuration in the request body.
3.4.2.2. POST Request to Create a New Image Stream
Request Header
Request Body
3.4.3. Importing an Image Stream
3.4.3.1. Request Breakdown
Importing an image stream requires one request:
-
A POST request to the
imagestreamimportssubresource of the namespace.
The POST request uses an ImageStreamImport configuration in the request body.
The following example imports the ruby-23-rhel7:latest image into a namespace as a custom imagestream.
3.4.3.2. POST Request to Create a New Image Stream
Request Header
Request Body
3.4.4. Listing All Image Streams in a Cluster
3.4.4.1. Request Breakdown
Listing all the image streams in a cluster requires one request:
-
A GET request to the
imagestreamsresource.
The GET request returns the ImageStreamList, listing the details of all image streams in the cluster.
3.4.4.2. GET Request to Return All Image Streams in a Cluster
Request Header
3.4.5. Listing all Image Streams in a Namespace
3.4.5.1. Request Breakdown
Listing all the image streams in a namespace requires one request:
-
A GET request to the
imagestreamssubresource of the namespace.
The GET request returns the ImageStreamList, listing the details of all image streams in the namespace.
3.4.5.2. GET Request to Return Image Streams in Namespace
Request Header
3.4.6. Listing a Specific Image Stream Configuration
3.4.6.1. Request Breakdown
Listing a specific image stream configuration requires one request:
-
A GET request to the image stream name in the
imagestreamssubresource of the namespace.
The GET request returns the ImageStream configuration for the specified image stream.
3.4.6.2. GET Request to Return Specific Image Stream Configuration
Request Header
3.4.7. Deleting an Image Stream
3.4.7.1. Request Breakdown
Deleting a image stream requires one request:
-
A DELETE request to the image stream name in the
imagestreamssubresource of the namespace.
The DELETE request returns a code: 200 and the image stream is deleted.
3.4.7.2. DELETE Request to Delete Image Stream
Request Header
3.5. Image Stream Tags
3.5.1. Description of Resource
An ImageStreamTag represents an Image that is retrieved by tag name from an ImageStream.
3.5.2. Adding an Image Stream Tag
3.5.2.1. Request Breakdown
Adding a tag to an image stream requires one request:
-
A PUT request to the image stream tag name in the
imagestreamtagssubresource of the namespace.
The PUT request uses an ImageStreamTag configuration in the request body.
The following example adds an image stream tag to the default ruby image stream in the openshift namespace.
3.5.2.2. PUT Request to Add an Image Stream Tag
Request Header
Request Body
3.5.3. Deleting an Image Stream Tag
3.5.3.1. Request Breakdown
Deleting an image stream tag requires one request:
-
A DELETE request to the image stream tag name in the
imagestreamtagssubresource of the namespace.
The DELETE request returns a code: 200 and the image stream tag is deleted.
The following example deletes the image stream tag, added in the previous example, from the default ruby image stream in the openshift namespace.
3.5.3.2. DELETE Request to Delete Image Stream Tag
Request Header
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}