Skip to content

Latest commit

 

History

History
138 lines (103 loc) · 3.93 KB

building_with_buildpacks.md

File metadata and controls

138 lines (103 loc) · 3.93 KB
Raw

Building with Paketo

Before starting, make sure you have Tekton and Shipwright Build installed.

See the Try It! section for more information.

Getting Started

Registry Authentication

For this tutorial, we will require to create a tutorial-secret Kubernetes secret to access a DockerHub registry, as follows:

$ REGISTRY_SERVER=https://index.docker.io/v1/ REGISTRY_USER=<your_registry_user> REGISTRY_PASSWORD=<your_registry_password>
$ kubectl create secret docker-registry tutorial-secret --docker-server=$REGISTRY_SERVER --docker-username=$REGISTRY_USER --docker-password=$REGISTRY_PASSWORD  [email protected]

Note: For more information about authentication, please refer to the related docs.

Create the strategy

Ensure all strategies are in place, see the Try It! section for more information.

$ kubectl get cbs
NAME              AGE
buildah           2m
buildpacks-v3     2m
kaniko            2m
ko                2m
source-to-image   2m

Verify that the strategy exists in the cluster:

$ kubectl get cbs
NAME            AGE
buildpacks-v3   23m

Note: For more information about strategies, please refer to the related docs.

Creating a Build

For the Build definition, we will require the following:

  • A GitHub repository containing a Ruby application.
  • The tutorial-secret we just created.
  • The buildpacks-v3 ClusterBuildStrategy.

Let's apply our Build and wait for it to be ready:

$ export REGISTRY_ORG=<your_registry_org>
$ cat <<EOF | kubectl apply -f -
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
  name: ruby-tutorial
spec:
  source:
    type: Git
    git:
      url: https://github.com/shipwright-io/sample-ruby
    contextDir: source-build
  strategy:
    name: buildpacks-v3
    kind: ClusterBuildStrategy
  output:
    image: docker.io/${REGISTRY_ORG}/ruby-tutorial:latest
    pushSecret: tutorial-secret
EOF

Verify that the go-tutorial Build was created successfully:

kubectl get build
NAME            REGISTERED   REASON      BUILDSTRATEGYKIND      BUILDSTRATEGYNAME   CREATIONTIME
ruby-tutorial   True         Succeeded   ClusterBuildStrategy   buildpacks-v3       22s

Note: For more information about Build resources, please refer to the related docs.

Creating a BuildRun

Second, we will create a BuildRun resource that references our previous go-tutorial Build:

$ cat <<EOF | kubectl create -f -
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
  name: ruby-tutorial-buildrun
spec:
  build:
    name: ruby-tutorial
EOF

Wait until your go-tutorial-buildrun buildrun is completed:

$ kubectl get buildrun
NAME                     SUCCEEDED   REASON      STARTTIME   COMPLETIONTIME
ruby-tutorial-buildrun   True        Succeeded   115s        51s

To know more about the state of the BuildRun, the .status.conditions fields provide more data:

$ kubectl get buildrun ruby-tutorial-buildrun -o json | jq '.status.conditions[]'
{
  "lastTransitionTime": "2021-03-24T15:02:38Z",
  "message": "All Steps have completed executing",
  "reason": "Succeeded",
  "status": "True",
  "type": "Succeeded"
}

Note: A BuildRun is a resource that runs to completion. The REASON column reflects the state of the resource. If the BuildRun ran to completion successfully, a Succeeded REASON is expected.

Note: For more information about BuildRun resources, please refer to the related docs.

Closing

Congratulations! You just created a container image from https://github.com/shipwright-io/sample-ruby using Paketo Buildpacks.

The new container image should now be available in your container registry.