1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Files
openshift-docs/modules/builds-image-source.adoc
Janelle Neczypor a92c18d4c2 OSDOCS-14492
2025-09-17 17:50:39 +00:00

70 lines
3.2 KiB
Plaintext

// Module included in the following assemblies:
//
// * builds/creating-build-inputs.adoc
:_mod-docs-content-type: CONCEPT
[id="builds-image-source_{context}"]
= Image source
You can add additional files to the build process with images. Input images are referenced in the same way the `From` and `To` image targets are defined. This means both container images and image stream tags can be referenced. In conjunction with the image, you must provide one or more path pairs to indicate the path of the files or directories to copy the image and the destination to place them in the build context.
The source path can be any absolute path within the image specified. The destination must be a relative directory path. At build time, the image is loaded and the indicated files and directories are copied into the context directory of the build process. This is the same directory into which the source repository content is cloned. If the source path ends in `/.` then the content of the directory is copied, but the directory itself is not created at the destination.
Image inputs are specified in the `source` definition of the `BuildConfig`:
[source,yaml]
----
source:
git:
uri: https://github.com/openshift/ruby-hello-world.git
ref: "master"
images: <1>
- from: <2>
kind: ImageStreamTag
name: myinputimage:latest
namespace: mynamespace
paths: <3>
- destinationDir: injected/dir <4>
sourcePath: /usr/lib/somefile.jar <5>
- from:
kind: ImageStreamTag
name: myotherinputimage:latest
namespace: myothernamespace
pullSecret: mysecret <6>
paths:
- destinationDir: injected/dir
sourcePath: /usr/lib/somefile.jar
----
<1> An array of one or more input images and files.
<2> A reference to the image containing the files to be copied.
<3> An array of source/destination paths.
<4> The directory relative to the build root where the build process can access the file.
<5> The location of the file to be copied out of the referenced image.
<6> An optional secret provided if credentials are needed to access the input image.
+
include::snippets/idms-global-pull-secret.adoc[]
.Images that require pull secrets
When using an input image that requires a pull secret, you can link the pull secret to the service account used by the build. By default, builds use the `builder` service account. The pull secret is automatically added to the build if the secret contains a credential that matches the repository hosting the input image. To link a pull secret to the service account used by the build, run:
[source,terminal]
----
$ oc secrets link builder dockerhub
----
ifndef::openshift-online[]
[NOTE]
====
This feature is not supported for builds using the custom strategy.
====
endif::[]
.Images on mirrored registries that require pull secrets
When using an input image from a mirrored registry, if you get a `build error: failed to pull image` message, you can resolve the error by using either of the following methods:
* Create an input secret that contains the authentication credentials for the builder image's repository and all known mirrors. In this case, create a pull secret for credentials to the image registry and its mirrors.
* Use the input secret as the pull secret on the `BuildConfig` object.