Red Hat Summit Red Hat SummitSupportoConsoleSviluppatoriInizia una provaContatti

Questo contenuto non è disponibile nella lingua selezionata.

Work with Builds

builds for Red Hat OpenShift 1.3

Using Builds

Red Hat OpenShift Documentation Team

Abstract

This document provides procedural examples for using Builds.

Chapter 1. Running Builds
Copia collegamento

After installing Builds, you can create a buildah or source-to-image build for use. You can also delete custom resources that are not required for a build.

1.1. Creating a buildah build
Copia collegamento

You can create a buildah build and push the created image to the target registry.

Prerequisites

  • You have installed the Builds for Red Hat OpenShift Operator on the OpenShift Container Platform cluster.
  • You have installed the oc CLI.
  • Optional: You have installed the shp CLI.

Procedure

  1. Create a Build resource and apply it to the OpenShift Container Platform cluster by using one of the CLIs:

    Example: Using oc CLI

    $ oc apply -f - <<EOF
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
  name: buildah-golang-build
spec:
  source:
    1 
    
    type: Git
    git:
      url: https://github.com/shipwright-io/sample-go
    contextDir: docker-build
  strategy:
    2 
    
    name: buildah
    kind: ClusterBuildStrategy
  paramValues:
    3 
    
  - name: dockerfile
    value: Dockerfile
  output:
    4 
    
    image: image-registry.openshift-image-registry.svc:5000/buildah-example/sample-go-app
EOF
    Copy to Clipboard Toggle word wrap

    1
    The location where the source code is placed.
    2
    The build strategy that you use to build the container.
    3
    The parameter defined in the build strategy. To set the value of the dockerfile strategy parameter, specify the Dockerfile location required to build the output image.
    4
    The location where the built image is pushed. In this procedural example, the built image is pushed to the OpenShift Container Platform cluster internal registry. buildah-example is the name of the current project. Ensure that the specified project exists to allow the image push.

    Example: Using shp CLI

    $ shp build create buildah-golang-build \
--source-url="https://github.com/redhat-openshift-builds/samples" --source-context-dir="buildah-build" \
    1 
    
--strategy-name="buildah" \
    2 
    
--dockerfile="Dockerfile" \
    3 
    
--output-image="image-registry.openshift-image-registry.svc:5000/buildah-example/go-app"
    4
    Copy to Clipboard Toggle word wrap

    1
    The location where the source code is placed.
    2
    The build strategy that you use to build the container.
    3
    The parameter defined in the build strategy. To set the value of the dockerfile strategy parameter, specify the Dockerfile location required to build the output image.
    4
    The location where the built image is pushed. In this procedural example, the built image is pushed to the OpenShift Container Platform cluster internal registry. buildah-example is the name of the current project. Ensure that the specified project exists to allow the image push.

  2. Check if the Build resource is created by using one of the CLIs:

    Example: Using oc CLI

    $ oc get builds.shipwright.io buildah-golang-build
    Copy to Clipboard Toggle word wrap

    Example: Using shp CLI

    $ shp build list
    Copy to Clipboard Toggle word wrap

  3. Create a BuildRun resource and apply it to the OpenShift Container Platform cluster by using one of the CLIs:

    Example: Using oc CLI

    $ oc apply -f - <<EOF
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
  name: buildah-golang-buildrun
spec:
  build:
    name: buildah-golang-build
    1 
    
EOF
    Copy to Clipboard Toggle word wrap

    1
    The spec.build.name field denotes the respective build to run, which is expected to be available in the same namespace.

    Example: Using shp CLI

    $ shp build run buildah-golang-build --follow
    1
    Copy to Clipboard Toggle word wrap

    1
    Optional: By using the --follow flag, you can view the build logs in the output result.

  4. Check if the BuildRun resource is created by running one of the following commands:

    Example: Using oc CLI

    $ oc get buildrun buildah-golang-buildrun
    Copy to Clipboard Toggle word wrap

    Example: Using shp CLI

    $ shp buildrun list
    Copy to Clipboard Toggle word wrap

    The BuildRun resource creates a TaskRun resource, which then creates the pods to execute build strategy steps.

Verification

  1. After all the containers complete their tasks, verify the following:

    • Check whether the pod shows the STATUS field as Completed: 

      $ oc get pods -w
      Copy to Clipboard Toggle word wrap

      Example output

      NAME                                READY   STATUS    RESTARTS   AGE
buildah-golang-buildrun-dtrg2-pod   2/2     Running   0          4s
buildah-golang-buildrun-dtrg2-pod   1/2     NotReady  0          7s
buildah-golang-buildrun-dtrg2-pod   0/2     Completed 0          55s
      Copy to Clipboard Toggle word wrap

    • Check whether the respective TaskRun resource shows the SUCCEEDED field as True: 

      $ oc get tr
      Copy to Clipboard Toggle word wrap

      Example output

      NAME                           SUCCEEDED  REASON     STARTTIME   COMPLETIONTIME
buildah-golang-buildrun-dtrg2  True       Succeeded  11m         8m51s
      Copy to Clipboard Toggle word wrap

    • Check whether the respective BuildRun resource shows the SUCCEEDED field as True: 

      $ oc get br
      Copy to Clipboard Toggle word wrap

      Example output

      NAME                     SUCCEEDED   REASON       STARTTIME     COMPLETIONTIME
buildah-golang-buildrun  True        Succeeded    13m           11m
      Copy to Clipboard Toggle word wrap

      During verification, if a build run fails, you can check the status.failureDetails field in your BuildRun resource to identify the exact point where the failure happened in the pod or container.

      Note

      The pod might switch to a NotReady state because one of the containers has completed its task. This is an expected behavior.

  2. Validate whether the image has been pushed to the registry that is specified in the build.spec.output.image field. You can try to pull the image by running the following command from a node that can access the internal registry: 

    $ podman pull image-registry.openshift-image-registry.svc:5000/<project>/<image>
    1
    Copy to Clipboard Toggle word wrap
    1
    The project name and image name used when creating the Build resource. For example, you can use buildah-example as the project name and sample-go-app as the image name.

1.1.1. Creating buildah build in a network-restricted environment
Copia collegamento

You can create a buildah build in a network-restricted environment by mirroring the images required by the buildah build strategy.

Prerequisites

  • Your cluster can connect and interact with the git source that you can use to create the buildah build.

Procedure

  1. Run the following command to mirror the images required by the buildah build strategy: 

    $ oc image mirror --insecure -a <registry_authentication> registry.redhat.io/ubi8/buildah@sha256:1c89cc3cab0ac0fc7387c1fe5e63443468219aab6fd531c8dad6d22fd999819e <mirror_registry>/<repo>/ubi8_buildah
    Copy to Clipboard Toggle word wrap
  2. Perform the steps mentioned in the "Creating a buildah build" section.

1.2. Creating a source-to-image build
Copia collegamento

You can create a source-to-image build and push the created image to a custom Quay repository.

Prerequisites

  • You have installed the Builds for Red Hat OpenShift Operator on the OpenShift Container Platform cluster.
  • You have installed the oc CLI.
  • Optional: You have installed the shp CLI.

Procedure

  1. Create a Build resource and apply it to the OpenShift Container Platform cluster by using one of the CLIs:

    Example: Using oc CLI

    $ oc apply -f - <<EOF
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
  name: s2i-nodejs-build
spec:
  source:
    1 
    
    type: Git
    git:
      url: https://github.com/redhat-openshift-builds/samples
    contextDir: s2i-build/nodejs
  strategy:
    2 
    
    name: source-to-image
    kind: ClusterBuildStrategy
  paramValues:
    3 
    
  - name: builder-image
    value: quay.io/centos7/nodejs-12-centos7:master
  output:
    image: quay.io/<repo>/s2i-nodejs-example
    4 
    
    pushSecret: registry-credential
    5 
    
EOF
    Copy to Clipboard Toggle word wrap

    1
    The location where the source code is placed.
    2
    The build strategy that you use to build the container.
    3
    The parameter defined in the build strategy. To set the value of the builder-image strategy parameter, specify the builder image location required to build the output image.
    4
    The location where the built image is pushed. You can push the built image to a custom Quay.io repository. Replace repo with a valid Quay.io organization or your Quay user name.
    5
    The secret name that stores the credentials for pushing container images. To generate a secret of the type docker-registry for authentication, see "Authentication to container registries".

    Example: Using shp CLI

    $ shp build create s2i-nodejs-build \
--source-url="https://github.com/redhat-openshift-builds/samples" --source-context-dir="s2i-build/nodejs" \
    1 
    
--strategy-name="source-to-image" \
    2 
    
--builder-image="quay.io/centos7/nodejs-12-centos7" \
    3 
    
--output-image="quay.io/<repo>/s2i-nodejs-example" \
    4 
    
--output-credentials-secret="registry-credential"
    5
    Copy to Clipboard Toggle word wrap

    1
    The location where the source code is placed.
    2
    The build strategy that you use to build the container.
    3
    The parameter defined in the build strategy. To set the value of the builder-image strategy parameter, specify the builder image location required to build the output image.
    4
    The location where the built image is pushed. You can push the built image to a custom Quay.io repository. Replace repo with a valid Quay.io organization or your Quay user name.
    5
    The secret name that stores the credentials for pushing container images. To generate a secret of the type docker-registry for authentication, see "Authentication to container registries".

  2. Check if the Build resource is created by using one of the CLIs:

    Example: Using oc CLI

    $ oc get builds.shipwright.io s2i-nodejs-build
    Copy to Clipboard Toggle word wrap

    Example: Using shp CLI

    $ shp build list
    Copy to Clipboard Toggle word wrap

  3. Create a BuildRun resource and apply it to the OpenShift Container Platform cluster by using one of the CLIs:

    Example: Using oc CLI

    $ oc apply -f - <<EOF
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
  name: s2i-nodejs-buildrun
spec:
  build:
    name: s2i-nodejs-build
    1 
    
EOF
    Copy to Clipboard Toggle word wrap

    1
    The spec.build.name field denotes the respective build to run, which is expected to be available in the same namespace.

    Example: Using shp CLI

    $ shp build run s2i-nodejs-build --follow
    1
    Copy to Clipboard Toggle word wrap

    1
    Optional: By using the --follow flag, you can view the build logs in the output result.

  4. Check if the BuildRun resource is created by running one of the following commands:

    Example: Using oc CLI

    $ oc get buildrun s2i-nodejs-buildrun
    Copy to Clipboard Toggle word wrap

    Example: Using shp CLI

    $ shp buildrun list
    Copy to Clipboard Toggle word wrap

    The BuildRun resource creates a TaskRun resource, which then creates the pods to execute build strategy steps.

Verification

  1. After all the containers complete their tasks, verify the following:

    • Check whether the pod shows the STATUS field as Completed: 

      $ oc get pods -w
      Copy to Clipboard Toggle word wrap

      Example output

      NAME                                READY   STATUS     RESTARTS   AGE
s2i-nodejs-buildrun-phxxm-pod       2/2     Running    0          10s
s2i-nodejs-buildrun-phxxm-pod       1/2     NotReady   0          14s
s2i-nodejs-buildrun-phxxm-pod       0/2     Completed  0          2m
      Copy to Clipboard Toggle word wrap

    • Check whether the respective TaskRun resource shows the SUCCEEDED field as True: 

      $ oc get tr
      Copy to Clipboard Toggle word wrap

      Example output

      NAME                           SUCCEEDED  REASON     STARTTIME   COMPLETIONTIME
s2i-nodejs-buildrun-phxxm      True       Succeeded  2m39s        13s
      Copy to Clipboard Toggle word wrap

    • Check whether the respective BuildRun resource shows the SUCCEEDED field as True: 

      $ oc get br
      Copy to Clipboard Toggle word wrap

      Example output

      NAME                     SUCCEEDED   REASON       STARTTIME     COMPLETIONTIME
s2i-nodejs-buildrun      True        Succeeded    2m41s           15s
      Copy to Clipboard Toggle word wrap

      During verification, if a build run fails, you can check the status.failureDetails field in your BuildRun resource to identify the exact point where the failure happened in the pod or container.

      Note

      The pod might switch to a NotReady state because one of the containers has completed its task. This is an expected behavior.

  2. Validate whether the image has been pushed to the registry that is specified in the build.spec.output.image field. You can try to pull the image by running the following command after logging in to the registry: 

    $ podman pull quay.io/<repo>/<image>
    1
    Copy to Clipboard Toggle word wrap
    1
    The repository name and image name used when creating the Build resource. For example, you can use s2i-nodejs-example as the image name.

1.2.1. Creating source-to-image build in a network-restricted environment
Copia collegamento

You can create a source-to-image build in a network-restricted environment by mirroring the images required by the source-to-image build strategy.

Prerequisites

  • Your cluster can connect and interact with the git source that you can use to create the source-to-image build.
  • You have the builder-image required to create the source-to-image build in your local registry. If you do not have the builder-image in the local registry, mirror the source image.

Procedure

  1. Run the following command to mirror the images required by the source-to-image build strategy: 

    $ oc image mirror --insecure -a <registry_authentication> registry.redhat.io/source-to-image/source-to-image-rhel8@sha256:d041c1bbe503d152d0759598f79802e257816d674b342670ef61c6f9e6d401c5 <mirror_registry>/<repo>/source-to-image-source-to-image-rhel8
    Copy to Clipboard Toggle word wrap
  2. Perform the steps mentioned in the "Creating a source-to-image build" section.

1.3. Viewing logs
Copia collegamento

You can view the logs of a build run to identify any runtime errors and to resolve them.

Prerequisites

  • You have installed the oc CLI.
  • Optional: You have installed the shp CLI.

Procedure

  • View logs of a build run by using one of the CLIs:

    Using oc CLI

    $ oc logs <buildrun_resource_name>
    Copy to Clipboard Toggle word wrap

    Using shp CLI

    $ shp buildrun logs <buildrun_resource_name>
    Copy to Clipboard Toggle word wrap

1.4. Deleting a resource
Copia collegamento

You can delete a Build, BuildRun, or BuildStrategy resource if it is not required in your project.

Prerequisites

  • You have installed the oc CLI.
  • Optional: You have installed the shp CLI.

Procedure

  • Delete a Build resource by using one of the CLIs:

    Using oc CLI

    $ oc delete builds.shipwright.io <build_resource_name>
    Copy to Clipboard Toggle word wrap

    Using shp CLI

    $ shp build delete <build_resource_name>
    Copy to Clipboard Toggle word wrap

  • Delete a BuildRun resource by using one of the CLIs:

    Using oc CLI

    $ oc delete buildrun <buildrun_resource_name>
    Copy to Clipboard Toggle word wrap

    Using shp CLI

    $ shp buildrun delete <buildrun_resource_name>
    Copy to Clipboard Toggle word wrap

  • Delete a BuildStrategy resource by running the following command:

    Using oc CLI

    $ oc delete buildstrategies <buildstartegy_resource_name>
    Copy to Clipboard Toggle word wrap

1.5. Creating a build with OCI artifacts
Copia collegamento

You can create a build using an Open Container Initiative(OCI) artifact as your source code. An OCI artifact, also known as a scratch image, contains only the source code and is not intended to run as a container. You can pull the OCI artifact from a container registry and extract its contents to use as source code to run the build.

Prerequisites

  • You have installed the Builds for Red Hat OpenShift Operator on the OpenShift Container Platform cluster.
  • You have installed the oc command-line interface (CLI).
  • You have installed the shp CLI.

Procedure

  1. Create a Build resource and apply it to the OpenShift Container Platform cluster. See the following example configuration: 

    $ oc apply -f - <<EOF
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
  name: my-oci-build
    1 
    
spec:
  source:
    type: OCI
    ociArtifact:
      image: <quay.io/org/image:tag>
    2 
    
  strategy:
    name: <strategy-name>
    3 
    
    kind: ClusterBuildStrategy
  output:
    image: <target-image-registry/repository/image:tag>
    4 
    
    pushSecret: <secret-name-for-credentials>
    5 
    
EOF
    Copy to Clipboard Toggle word wrap
    1
    Defines the name of the Build resource.
    2
    Replace <quay.io/org/image:tag> with the location of the OCI artifact source image.
    3
    Replace <strategy-name> with the name of the build strategy to build the container (buildah or source-to-image).
    4
    Replace <target-image-registry/repository/image:tag> with the location where you want to push the built image.
    5
    Optional: Replace <secret-name-for-credentials> with the secret name that stores the credentials for pushing container images. To generate a secret for a private registry for authentication, see Authentication to container registries

  2. Choose one of the following methods to upload your source code to the required registry and run the build:

    1. Use the shp CLI
    2. Manually upload the OCI artifact

1.5.1. Uploading the OCI artifact by using the CLI
Copia collegamento

You can upload your source code to the required registry by using the CLI.

  1. Run the following command in the directory containing the local source code. It packages your source code into a scratch container image, pushes it to the required registry and runs the build: 

    $ shp build upload my-oci-build
    1
    Copy to Clipboard Toggle word wrap
    1
    Defines the name of the Build resource.

1.5.2. Uploading the OCI artifact manually
Copia collegamento

You can upload your source code manually to the required registry and run the build.

  1. Create a Containerfile in the root directory of your source code and add the following content: 

    FROM scratch
COPY . /
    Copy to Clipboard Toggle word wrap

  2. Run the following command in the root directory of your source code to build the container image using Podman: 

    $ podman build -t <registry-path>/<image-name>:<tag>
    1
    Copy to Clipboard Toggle word wrap
    1
    Replace <registry-path>/<image-name>:<tag> with the build location for the container image.

  3. Push the container image to the required location using the following command: 

    $ podman push <registry-path>/<image-name>:<tag>
    1
    Copy to Clipboard Toggle word wrap
    1
    Replace <registry-path>/<image-name>:<tag> with the location where you want to push the built image.

  4. Run the build using the following command: 

    $ shp build run my-oci-build
    1
    Copy to Clipboard Toggle word wrap
    1
    Defines the name of the Build resource.

Legal Notice
Copia collegamento

Copyright © 2025 Red Hat

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Torna in cima
Red Hat logoGithubredditYoutubeTwitter

Formazione

Prova, acquista e vendi

Community

Informazioni sulla documentazione di Red Hat

Aiutiamo gli utenti Red Hat a innovarsi e raggiungere i propri obiettivi con i nostri prodotti e servizi grazie a contenuti di cui possono fidarsi. Esplora i nostri ultimi aggiornamenti.

Rendiamo l’open source più inclusivo

Red Hat si impegna a sostituire il linguaggio problematico nel codice, nella documentazione e nelle proprietà web. Per maggiori dettagli, visita il Blog di Red Hat.

Informazioni su Red Hat

Forniamo soluzioni consolidate che rendono più semplice per le aziende lavorare su piattaforme e ambienti diversi, dal datacenter centrale all'edge della rete.

Theme

© 2025 Red Hat