Chapter 5. Using build strategies

Procedure

1. Create the Jenkins master:

     $ oc project <project_name>

   Copy to Clipboard Toggle word wrap

   Select the project that you want to use or create a new project with oc new-project <project_name>.

     $ oc new-app jenkins-ephemeral 

   1

   Copy to Clipboard Toggle word wrap

   If you want to use persistent storage, use jenkins-persistent instead.

2. Create a file named nodejs-sample-pipeline.yaml with the following content:

   Note

   This creates a BuildConfig object that employs the Jenkins pipeline strategy to build, deploy, and scale the Node.js/MongoDB example application.

   kind: "BuildConfig"
   apiVersion: "v1"
   metadata:
     name: "nodejs-sample-pipeline"
   spec:
     strategy:
       jenkinsPipelineStrategy:
         jenkinsfile: <pipeline content from below>
       type: JenkinsPipeline

   Copy to Clipboard Toggle word wrap

3. After you create a BuildConfig object with a jenkinsPipelineStrategy, tell the pipeline what to do by using an inline jenkinsfile:

   Note

   This example does not set up a Git repository for the application.

   The following jenkinsfile content is written in Groovy using the OpenShift Dedicated DSL. For this example, include inline content in the BuildConfig object using the YAML Literal Style, though including a jenkinsfile in your source repository is the preferred method.

   def templatePath = 'https://raw.githubusercontent.com/openshift/nodejs-ex/master/openshift/templates/nodejs-mongodb.json' 

   1

   
   def templateName = 'nodejs-mongodb-example' 

   2

   
   pipeline {
     agent {
       node {
         label 'nodejs' 

   3

   
       }
     }
     options {
       timeout(time: 20, unit: 'MINUTES') 

   4

   
     }
     stages {
       stage('preamble') {
           steps {
               script {
                   openshift.withCluster() {
                       openshift.withProject() {
                           echo "Using project: ${openshift.project()}"
                       }
                   }
               }
           }
       }
       stage('cleanup') {
         steps {
           script {
               openshift.withCluster() {
                   openshift.withProject() {
                     openshift.selector("all", [ template : templateName ]).delete() 

   5

   
                     if (openshift.selector("secrets", templateName).exists()) { 

   6

   
                       openshift.selector("secrets", templateName).delete()
                     }
                   }
               }
           }
         }
       }
       stage('create') {
         steps {
           script {
               openshift.withCluster() {
                   openshift.withProject() {
                     openshift.newApp(templatePath) 

   7

   
                   }
               }
           }
         }
       }
       stage('build') {
         steps {
           script {
               openshift.withCluster() {
                   openshift.withProject() {
                     def builds = openshift.selector("bc", templateName).related('builds')
                     timeout(5) { 

   8

   
                       builds.untilEach(1) {
                         return (it.object().status.phase == "Complete")
                       }
                     }
                   }
               }
           }
         }
       }
       stage('deploy') {
         steps {
           script {
               openshift.withCluster() {
                   openshift.withProject() {
                     def rm = openshift.selector("dc", templateName).rollout()
                     timeout(5) { 

   9

   
                       openshift.selector("dc", templateName).related('pods').untilEach(1) {
                         return (it.object().status.phase == "Running")
                       }
                     }
                   }
               }
           }
         }
       }
       stage('tag') {
         steps {
           script {
               openshift.withCluster() {
                   openshift.withProject() {
                     openshift.tag("${templateName}:latest", "${templateName}-staging:latest") 

   10

   
                   }
               }
           }
         }
       }
     }
   }

   Copy to Clipboard Toggle word wrap

   1

   Path of the template to use.

   1 2

   Name of the template that will be created.

   3

   Spin up a node.js agent pod on which to run this build.

   4

   Set a timeout of 20 minutes for this pipeline.

   5

   Delete everything with this template label.

   6

   Delete any secrets with this template label.

   7

   Create a new application from the templatePath.

   8

   Wait up to five minutes for the build to complete.

   9

   Wait up to five minutes for the deployment to complete.

   10

   If everything else succeeded, tag the $ {templateName}:latest image as $ {templateName}-staging:latest. A pipeline build configuration for the staging environment can watch for the $ {templateName}-staging:latest image to change and then deploy it to the staging environment.

   Note

   The previous example was written using the declarative pipeline style, but the older scripted pipeline style is also supported.

4. Create the Pipeline BuildConfig in your OpenShift Dedicated cluster:

   $ oc create -f nodejs-sample-pipeline.yaml

   Copy to Clipboard Toggle word wrap

   1. If you do not want to create your own file, you can use the sample from the Origin repository by running:

      $ oc create -f https://raw.githubusercontent.com/openshift/origin/master/examples/jenkins/pipeline/nodejs-sample-pipeline.yaml

      Copy to Clipboard Toggle word wrap

5. Start the Pipeline:

   $ oc start-build nodejs-sample-pipeline

   Copy to Clipboard Toggle word wrap
   Note

   Alternatively, you can start your pipeline with the OpenShift Dedicated web console by navigating to the Builds Pipeline section and clicking Start Pipeline, or by visiting the Jenkins Console, navigating to the Pipeline that you created, and clicking Build Now.

   Once the pipeline is started, you should see the following actions performed within your project:

   • A job instance is created on the Jenkins server.
   • An agent pod is launched, if your pipeline requires one.

   • The pipeline runs on the agent pod, or the master if no agent is required.

     • Any previously created resources with the template=nodejs-mongodb-example label will be deleted.
     • A new application, and all of its associated resources, will be created from the nodejs-mongodb-example template.

     • A build will be started using the nodejs-mongodb-example BuildConfig.

       • The pipeline will wait until the build has completed to trigger the next stage.

     • A deployment will be started using the nodejs-mongodb-example deployment configuration.

       • The pipeline will wait until the deployment has completed to trigger the next stage.
     • If the build and deploy are successful, the nodejs-mongodb-example:latest image will be tagged as nodejs-mongodb-example:stage.

   • The agent pod is deleted, if one was required for the pipeline.

     Note

     The best way to visualize the pipeline execution is by viewing it in the OpenShift Dedicated web console. You can view your pipelines by logging in to the web console and navigating to Builds Pipelines.