Builds の操作

手順

1. Build リソースを作成し、次のいずれかの CLI を使用して OpenShift Container Platform クラスターに適用します。

   例: 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

   ソースコードが配置される場所。

   2

   コンテナーの構築に使用するビルドストラテジー。

   3

   ビルドストラテジーで定義されるパラメーター。dockerfile ストラテジーパラメーターの値を設定するには、出力イメージの構築に必要な Dockerfile の場所を指定します。

   4

   ビルドイメージがプッシュされる場所。この手順例では、ビルドされたイメージが OpenShift Container Platform クラスターの内部レジストリーにプッシュされます。buildah-example は現在のプロジェクトの名前です。イメージのプッシュを許可するために、指定されたプロジェクトが存在することを確認します。

   例: 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

   ソースコードが配置される場所。

   2

   コンテナーの構築に使用するビルドストラテジー。

   3

   ビルドストラテジーで定義されるパラメーター。dockerfile ストラテジーパラメーターの値を設定するには、出力イメージの構築に必要な Dockerfile の場所を指定します。

   4

   ビルドイメージがプッシュされる場所。この手順例では、ビルドされたイメージが OpenShift Container Platform クラスターの内部レジストリーにプッシュされます。buildah-example は現在のプロジェクトの名前です。イメージのプッシュを許可するために、指定されたプロジェクトが存在することを確認します。

2. Build リソースが CLI のいずれかを使用して作成されていることを確認します。

   例: oc CLI の使用

   $ oc get builds.shipwright.io buildah-golang-build

   Copy to Clipboard Toggle word wrap

   例: shp CLI の使用

   $ shp build list

   Copy to Clipboard Toggle word wrap

3. BuildRun リソースを作成し、次のいずれかの CLI を使用して OpenShift Container Platform クラスターに適用します。

   例: 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

   spec.build.name フィールドは、実行するそれぞれのビルドを示し、同じ namespace で使用できる必要があります。

   例: shp CLI の使用

   $ shp build run buildah-golang-build --follow 

   1

   Copy to Clipboard Toggle word wrap

   1

   オプション: --follow オプションのフラグを使用すると、出力結果のビルドログを表示できます。

4. 次のいずれかのコマンドを実行して、BuildRun リソースが作成されているかどうかを確認します。

   例: oc CLI の使用

   $ oc get buildrun buildah-golang-buildrun

   Copy to Clipboard Toggle word wrap

   例: shp CLI の使用

   $ shp buildrun list

   Copy to Clipboard Toggle word wrap

   BuildRun リソースは TaskRun リソースを作成し、その後ビルドストラテジーの手順を実行する Pod を作成します。

検証

1. すべてのコンテナーがタスクを完了したら、以下を確認します。

   • Pod で STATUS フィールドが Completed として表示されるかどうかを確認します。

     $ oc get pods -w

     Copy to Clipboard Toggle word wrap

     出力例

     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

   • それぞれの TaskRun リソースに SUCCEEDED フィールドが True と表示されているかどうかを確認します。

     $ oc get tr

     Copy to Clipboard Toggle word wrap

     出力例

     NAME                           SUCCEEDED  REASON     STARTTIME   COMPLETIONTIME
     buildah-golang-buildrun-dtrg2  True       Succeeded  11m         8m51s

     Copy to Clipboard Toggle word wrap

   • それぞれの BuildRun リソースに SUCCEEDED フィールドが True と表示されているかどうかを確認します。

     $ oc get br

     Copy to Clipboard Toggle word wrap

     出力例

     NAME                     SUCCEEDED   REASON       STARTTIME     COMPLETIONTIME
     buildah-golang-buildrun  True        Succeeded    13m           11m

     Copy to Clipboard Toggle word wrap

     検証中にビルドの実行が失敗した場合は、BuildRun リソースの status.failureDetails フィールドをチェックして、Pod またはコンテナー内で失敗が発生した正確なポイントを特定できます。

     注記

     コンテナーの 1 つがタスクを完了したため、Pod が NotReady 状態に切り替わる可能性があります。これは想定される動作です。

2. build.spec.output.image フィールドで指定されたレジストリーにイメージがプッシュされたかどうかを検証します。内部レジストリーにアクセスできるノードから次のコマンドを実行して、イメージのプルを試みることができます。

   $ podman pull image-registry.openshift-image-registry.svc:5000/<project>/<image> 

   1

   Copy to Clipboard Toggle word wrap

   1

   Build リソースの作成時に使用されるプロジェクト名とイメージ名。たとえば、buildah-example をプロジェクト名として、sample-go-app をイメージ名として使用できます。

手順

1. Build リソースを作成し、次のいずれかの CLI を使用して OpenShift Container Platform クラスターに適用します。

   例: 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

   ソースコードが配置される場所。

   2

   コンテナーの構築に使用するビルドストラテジー。

   3

   ビルドストラテジーで定義されるパラメーター。builder-image ストラテジーパラメーターの値を設定するには、出力イメージのビルドに必要なビルダーイメージの場所を指定します。

   4

   ビルドイメージがプッシュされる場所。ビルドされたイメージをカスタム Quay.io リポジトリーにプッシュできます。repo は、有効な Quay.io 組織または Quay ユーザー名に置き換えます。

   5

   コンテナーイメージをプッシュするための認証情報を保存するシークレット名。認証用に docker-registry タイプのシークレットを生成するには、「コンテナーレジストリーへの認証」を参照してください。

   例: 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

   ソースコードが配置される場所。

   2

   コンテナーの構築に使用するビルドストラテジー。

   3

   ビルドストラテジーで定義されるパラメーター。builder-image ストラテジーパラメーターの値を設定するには、出力イメージのビルドに必要なビルダーイメージの場所を指定します。

   4

   ビルドイメージがプッシュされる場所。ビルドされたイメージをカスタム Quay.io リポジトリーにプッシュできます。repo は、有効な Quay.io 組織または Quay ユーザー名に置き換えます。

   5

   コンテナーイメージをプッシュするための認証情報を保存するシークレット名。認証用に docker-registry タイプのシークレットを生成するには、「コンテナーレジストリーへの認証」を参照してください。

2. Build リソースが CLI のいずれかを使用して作成されていることを確認します。

   例: oc CLI の使用

   $ oc get builds.shipwright.io s2i-nodejs-build

   Copy to Clipboard Toggle word wrap

   例: shp CLI の使用

   $ shp build list

   Copy to Clipboard Toggle word wrap

3. BuildRun リソースを作成し、次のいずれかの CLI を使用して OpenShift Container Platform クラスターに適用します。

   例: 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

   spec.build.name フィールドは、実行するそれぞれのビルドを示し、同じ namespace で使用できる必要があります。

   例: shp CLI の使用

   $ shp build run s2i-nodejs-build --follow 

   1

   Copy to Clipboard Toggle word wrap

   1

   オプション: --follow オプションのフラグを使用すると、出力結果のビルドログを表示できます。

4. 次のいずれかのコマンドを実行して、BuildRun リソースが作成されているかどうかを確認します。

   例: oc CLI の使用

   $ oc get buildrun s2i-nodejs-buildrun

   Copy to Clipboard Toggle word wrap

   例: shp CLI の使用

   $ shp buildrun list

   Copy to Clipboard Toggle word wrap

   BuildRun リソースは TaskRun リソースを作成し、その後ビルドストラテジーの手順を実行する Pod を作成します。

検証

1. すべてのコンテナーがタスクを完了したら、以下を確認します。

   • Pod で STATUS フィールドが Completed として表示されるかどうかを確認します。

     $ oc get pods -w

     Copy to Clipboard Toggle word wrap

     出力例

     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

   • それぞれの TaskRun リソースに SUCCEEDED フィールドが True と表示されているかどうかを確認します。

     $ oc get tr

     Copy to Clipboard Toggle word wrap

     出力例

     NAME                           SUCCEEDED  REASON     STARTTIME   COMPLETIONTIME
     s2i-nodejs-buildrun-phxxm      True       Succeeded  2m39s        13s

     Copy to Clipboard Toggle word wrap

   • それぞれの BuildRun リソースに SUCCEEDED フィールドが True と表示されているかどうかを確認します。

     $ oc get br

     Copy to Clipboard Toggle word wrap

     出力例

     NAME                     SUCCEEDED   REASON       STARTTIME     COMPLETIONTIME
     s2i-nodejs-buildrun      True        Succeeded    2m41s           15s

     Copy to Clipboard Toggle word wrap

     検証中にビルドの実行が失敗した場合は、BuildRun リソースの status.failureDetails フィールドをチェックして、Pod またはコンテナー内で失敗が発生した正確なポイントを特定できます。

     注記

     コンテナーの 1 つがタスクを完了したため、Pod が NotReady 状態に切り替わる可能性があります。これは想定される動作です。

2. build.spec.output.image フィールドで指定されたレジストリーにイメージがプッシュされたかどうかを検証します。レジストリーにログインした後、以下のコマンドを実行してイメージをプルできます。

   $ podman pull quay.io/<repo>/<image> 

   1

   Copy to Clipboard Toggle word wrap

   1

   Build リソースの作成時に使用されるリポジトリー名とイメージ名。たとえば、イメージ名として s2i-nodejs-example を使用できます。

手順

1. オプション: buildpacks で shp CLI を使用するには、まず次の 2 つのコマンドを使用して、pipeline サービスアカウントに buildpacks-example プロジェクトのイメージレジストリーにアクセスする権限を付与する必要があります。

   $ oc policy add-role-to-user system:image-puller system:serviceaccount:default:pipeline --namespace=buildpacks-example

   Copy to Clipboard Toggle word wrap

   $ oc policy add-role-to-user system:image-pusher system:serviceaccount:default:pipeline --namespace=buildpacks-example

   Copy to Clipboard Toggle word wrap

2. オプション: プライマリー作業プロジェクトに戻って、shp CLI での作業を続行します。

   $ oc project default

   Copy to Clipboard Toggle word wrap

3. オプション: 権限を適用して shp CLI のセットアップを終了します。

   $ oc create rolebinding allow-builds-to-push \
   
     --clusterrole=edit \
   
    --serviceaccount=default:pipeline \
   
   --namespace=buildpacks-example

   Copy to Clipboard Toggle word wrap

4. 次のいずれかの CLI を使用して Build リソースを作成し、OpenShift Container Platform クラスターに適用します。

   • oc CLI の使用

     $ oc apply -f - <<EOF
     apiVersion: shipwright.io/v1beta1
     
     kind: Build
     
     metadata:
     
       name: buildpack-nodejs-build
     
     spec:
     
       source: 

     1

     
     
         type: Git
     
         git:
     
           url: https://github.com/redhat-openshift-builds/samples.git
     
       strategy: 

     2

     
     
         name: buildpacks
     
         kind: ClusterBuildStrategy
     
       retention:
     
         atBuildDeletion: true
     
       paramValues: 

     3

     
     
         - name: run-image 

     4

     
     
           value: paketobuildpacks/run-ubi8-base:latest
     
         - name: cnb-builder-image 

     5

     
     
           value: paketobuildpacks/builder-jammy-tiny:0.0.344
     
         - name: source-subpath 

     6

     
     
           value: "buildpacks/nodejs"
     
       output: 

     7

     
         image: image-registry.openshift-image-registry.svc:5000/buildpacks-example/taxi-app
     EOF

     Copy to Clipboard Toggle word wrap

     1

     アプリケーションのソースコードを含む Git リポジトリーを定義します。

     2

     コンテナーをビルドするためのビルドストラテジーを定義します。

     3

     buildpacks ストラテジーに設定するパラメーターを定義します。

     4

     アプリケーションが実行されるベースイメージを指定します。

     5

     Cloud Native Buildpacks (CNB) がアプリケーションを検出してビルドするために使用するビルダーイメージを指定します。

     6

     アプリケーションのソースコードが配置されている Git リポジトリー内のサブディレクトリーを指定します。

     7

     ビルドしたイメージをプッシュする場所を指定します。

   • shp CLI の使用:

     $ shp build create buildpack-nodejs-build \
     
     --source-git-url="https://github.com/redhat-openshift-builds/samples.git" \
     
     --strategy-name="buildpacks" \
     
     --output-image="image-registry.openshift-image-registry.svc:5000/buildpacks-example/taxi-app" \
     
     --param-value="source-subpath=buildpacks/nodejs" \
     
     --param-value="cnb-builder-image=paketobuildpacks/builder-jammy-tiny:0.0.344" \
     --param-value="run-image=paketobuildpacks/run-ubi8-base:latest"

     Copy to Clipboard Toggle word wrap

5. 次のいずれかの CLI を使用して Build リソースが作成されたかどうかを確認します。

   • oc CLI の使用:

     $ oc get builds.shipwright.io buildpack-nodejs-build

     Copy to Clipboard Toggle word wrap

   • shp CLI の使用:

     $ shp build list

     Copy to Clipboard Toggle word wrap

6. 次のいずれかの CLI を使用して BuildRun リソースを作成し、OpenShift Container Platform クラスターに適用します。

   • oc CLI の使用:

     $ oc apply -f - <<EOF
     apiVersion: shipwright.io/v1beta1
     kind: BuildRun
     metadata:
       name: buildpack-nodejs-buildrun
       namespace: builds-test
     spec:
       build:
         name: buildpack-nodejs-build 

     1

     
     EOF

     Copy to Clipboard Toggle word wrap

     1

     実行される buildpack-nodejs-build リソースを指定します。

   • shp CLI の使用:

     …​

1. 次のいずれかの CLI を使用して、BuildRun リソースが作成されたかどうかを確認します。

   • oc CLI の使用:

     $ oc get buildrun buildpack-nodejs-buildrun

     Copy to Clipboard Toggle word wrap

   • shp CLI の使用:

     $ shp buildrun list

     Copy to Clipboard Toggle word wrap
     注記

     BuildRun リソースは TaskRun リソースを作成し、その後ビルドストラテジーの手順を実行する Pod を作成します。

検証

1. すべてのコンテナーがタスクを完了するまで待ちます。

2. Pod の STATUS フィールドに Completed と表示されているかどうかを確認します。

   $ oc get pods -w

   Copy to Clipboard Toggle word wrap

   出力例

   NAME                                 READY   STATUS     RESTARTS   AGE
   buildpack-go-build-ttwkl-d8x97-pod   2/8     NotReady   0          63s
   buildpack-go-build-ttwkl-d8x97-pod   0/8     Completed   0          72s
   buildpack-go-build-ttwkl-d8x97-pod   0/8     Completed   0          73s

   Copy to Clipboard Toggle word wrap

3. TaskRun リソースの SUCCESS フィールドに True が表示されているかどうかを確認します。

   $ oc get tr

   Copy to Clipboard Toggle word wrap

   出力例

   NAME                             SUCCEEDED   REASON      STARTTIME   COMPLETIONTIME
   buildpack-go-build-ttwkl-d8x97   True        Succeeded   112s        38s

   Copy to Clipboard Toggle word wrap

4. BuildRun リソースの SUCCESS フィールドに True が表示されているかどうかを確認します。

   $ oc get br

   Copy to Clipboard Toggle word wrap

   出力例

   NAME                       SUCCEEDED   REASON      STARTTIME   COMPLETIONTIME
   buildpack-go-build-ttwkl   True        Succeeded   107s        33s

   Copy to Clipboard Toggle word wrap
   注記

   ビルド実行が失敗した場合は、BuildRun リソースの status.failureDetails フィールドをチェックして、Pod またはコンテナーで失敗した正確なポイントを特定できます。

   コンテナーの 1 つがタスクを完了したため、Pod が NotReady 状態に切り替わる可能性があります。これは想定される動作です。

5. 内部レジストリーにアクセスしてイメージをプルできるノードから次のコマンドを実行して、build.spec.output.image フィールドで指定したレジストリーにイメージがプッシュされているかどうかを確認します。

   $ podman pull

   Copy to Clipboard Toggle word wrap

   出力例

   $ image-registry.openshift-image-registry.svc:5000/buildpacks-example/taxi-app

   Copy to Clipboard Toggle word wrap

   この例のプロジェクト名は buildpacks-example、イメージ名は taxi-app です。

手順

1. Build リソースを作成して OpenShift Container Platform クラスターに適用します。次の設定例を参照してください。

   $ 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

   Build リソースの名前を定義します。

   2

   <quay.io/org/image:tag> は、OCI アーティファクトソースイメージの場所に置き換えます。

   3

   <strategy-name> は、コンテナーをビルドするためのビルドストラテジーの名前 (buildah または source-to-image) に置き換えます。

   4

   <target-image-registry/repository/image:tag> は、ビルドしたイメージをプッシュする場所に置き換えます。

   5

   オプション: <secret-name-for-credentials> は、コンテナーイメージをプッシュするための認証情報を保存するシークレット名に置き換えます。認証のためにプライベートレジストリー用のシークレットを生成するには、コンテナーレジストリーへの認証 を参照してください。

2. 次のいずれかの方法を選択して、ソースコードを必要なレジストリーにアップロードし、ビルドを実行します。

   • shp CLI を使用します。

     • ローカルソースコードを含むディレクトリーで次のコマンドを実行します。ソースコードをスクラッチコンテナーイメージにパッケージ化し、必要なレジストリーにプッシュして、ビルドを実行します。

       $ shp build upload my-oci-build 

       1

       Copy to Clipboard Toggle word wrap

       1

       Build リソースの名前を定義します。

   • OCI アーティファクトを手動でアップロードします。

     1. ソースコードのルートディレクトリーに Containerfile を作成し、次の設定を追加します。

        FROM scratch
        COPY . /

        Copy to Clipboard Toggle word wrap

     2. ソースコードのルートディレクトリーで次のコマンドを実行し、Podman を使用してコンテナーイメージをビルドします。

        $ podman build -t <registry-path>/<image-name>:<tag> 

        1

        Copy to Clipboard Toggle word wrap

        1

        <registry-path>/<image-name>:<tag> は、コンテナーイメージのビルド場所に置き換えます。

     3. 次のコマンドを使用して、コンテナーイメージを必要な場所にプッシュします。

        $ podman push <registry-path>/<image-name>:<tag>  

        1

        Copy to Clipboard Toggle word wrap

        1

        <registry-path>/<image-name>:<tag> は、ビルドしたイメージをプッシュする場所に置き換えます。

     4. 次のコマンドを使用してビルドを実行します。

        $ shp build run my-oci-build 

        1

        Copy to Clipboard Toggle word wrap

        1

        Build リソースの名前を定義します。

手順

1. 次のコマンドを実行して、デフォルトのエディターで YAML 定義を開きます。

   $ oc edit <resource-name> <build_resource-name> 

   1

   Copy to Clipboard Toggle word wrap

   1

   <resource-name> は、リソースの名前 (build、buildrun、または buildstrategy) に置き換えます。<build_resource-name> は、編集するビルドリソースの名前に置き換えます。

2. YAML 定義を編集し、ファイルを保存します。