Planen eines Jobs in Jenkins

1. Einleitung

In diesem Artikel werden verschiedene Möglichkeiten zum Planen von Jobs in Jenkins behandelt.

Wir beginnen mit der Planung eines einfachen Auftrags, der so einfach wie das Drucken einer Nur-Text-Nachricht ausgeführt wird. Das Beispiel wird dahingehend weiterentwickelt, dass ein Job geplant wird, der automatisch durch Änderungen in einem SCM-Repository wie GitHub, Bitbucket usw. ausgelöst wird.

2. Ersteinrichtung

Wir gehen davon aus, dass JDK und Maven in der globalen Toolkonfiguration mit den Namen JDK9.0.1 bzw. Maven3.5.2 auf dem Jenkins-Server installiert wurden .

Es wird auch davon ausgegangen, dass wir Zugriff auf ein SCM-Repository wie Bitbucket haben, wenn ein Maven-Projekt ordnungsgemäß eingerichtet ist.

3. Planen eines einfachen Jobs

Scrollen wir auf der Jobkonfigurationsseite direkt zum Abschnitt Build Triggers . Da wir eine einfache Aufgabe erstellen möchten, lassen Sie uns das Kontrollkästchen markiert wählen Build - periodisch . Sobald wir dieses Kontrollkästchen aktivieren, wird ein Textfeld mit der Bezeichnung Zeitplan angezeigt .

Wir müssen Wert in einem Cron-konformen Format liefern . Auf der Seite sind umfangreiche Informationen verfügbar, wenn wir auf das Fragezeichen neben dem Feld klicken.

Geben Sie hier * / 2 * * * * ein, was einem Intervall von zwei Minuten entspricht:

Wenn Sie aus dem Textfeld tippen, werden Informationen direkt unter dem Feld angezeigt. Es sagt uns, wann der Job als nächstes ausgeführt wird.

Speichern wir den Job - in ungefähr zwei Minuten sollten wir den Status der ersten Ausführung des Jobs sehen:

Da wir den Job so konfiguriert haben, dass er alle zwei Minuten ausgeführt wird, sollten mehrere Build-Nummern angezeigt werden, wenn wir nach einiger Wartezeit zum Job-Dashboard zurückkehren.

4. Erstellen eines Jobs, der SCM abfragt

Lassen Sie uns einen Schritt vorwärts gehen und einen Job erstellen, der den Quellcode aus dem SCM-Repository wie Bitbucket abruft und einen Build ausführt.

Erstellen wir einen neuen Job, wie im vorherigen Abschnitt erläutert, mit einigen Änderungen.

Im Build - Trigger Abschnitt, statt der Auswahl Erstellen Sie regelmäßig , lassen Sie uns wählen Poll SCM . Sobald wir das tun, sollten wir ein Textfeld mit Label Schedule sehen .

Geben Sie * / 5 * * * * in dieses Feld ein. Dies bedeutet, dass der Job alle 5 Minuten ausgeführt werden soll:

Scrollen wir zum Abschnitt Quellcodeverwaltung . Wenn Sie das Optionsfeld neben Git auswählen , wird ein neuer Abschnitt mit der Bezeichnung Repositorys angezeigt .

Hier müssen wir Details unseres SCM-Repositorys konfigurieren . Geben Sie die URL des SCM-Repositorys in das Textfeld Repository-URL ein:

Wir müssen auch Benutzeranmeldeinformationen bereitstellen, damit Jenkins auf das Repository zugreifen kann.

Klicken Sie auf die Schaltfläche Hinzufügen neben Anmeldeinformationen. Daraufhin wird ein Popup-Bildschirm zum Erstellen der Benutzeranmeldeinformationen angezeigt.

Wählen wir die Art als Benutzername mit Passwort . Wir müssen den Benutzernamen und das Passwort in die angegebenen Textfelder eingeben:

Wenn Sie auf die Schaltfläche Hinzufügen klicken , kehren Sie zum Abschnitt Quellcodeverwaltung zurück .

Wählen Sie diese Benutzeranmeldeinformationen in der Dropdown-Liste neben Anmeldeinformationen aus :

Als letztes müssen wir das Build-Skript einrichten.

Scrollen wir nach unten zum Abschnitt Build , klicken Sie auf Build-Schritt hinzufügen und wählen Sie Shell ausführen . Da wir an einem Maven-Projekt im SCM-Repository arbeiten, müssen wir mvn clean install eingeben , um einen Maven-Build durchzuführen.

Let's try to understand what we've done here.

We've created a job that is scheduled to run every 5 minutes. The job's been configured to pull source code from the master branch of the given Bitbucket repository.

It will use provided user credentials to log in to Bitbucket.

After pulling the source code, the job will execute the script containing a provided Maven command.

Now, if we save and wait approximately five minutes, we should see the build execution in Build History section on the job dashboard.

The Console Output should show the output of the Maven build. We can see in the console output that the source code has been pulled from Bitbucket and the command mvn clean install has been executed:

Since it's a Maven build, the console output might be very long depending on the number of Maven dependencies that are downloaded.

But at the end of the output, we should see BUILD SUCCESS message.

5. Creating a Job That Uses Pipeline as Script

So far, we've seen how to create jobs that execute at the predefined scheduled time.

Now, let's create a job that's not bound to any particular schedule. Instead, we'll configure it to automatically trigger whenever there is a new commit in SCM repository.

Going back to Jenkins dashboard, let's click New Item. This time, instead of Freestyle project, we'll select Pipeline. Let's name this job PipelineAsScriptJob.

Upon clicking OK button, we'll be taken to the pipeline configuration page. This page has several sections such as “General”, “Build Triggers”, “Advanced Project Options”, and “Pipeline”.

Let's scroll down to “Build Triggers” section and the select checkbox next to Build when a change is pushed to Bitbucket. This option will be available only if we've installed the Bitbucket Plugin:

Let's scroll down to Pipeline section. We need to select Pipeline Script in the drop-down next to Definition.

The Text Box just below this drop-down is waiting for the script to be placed in. There're two ways of doing this.

We can either type the whole script, or we can make use of a utility provided by Jenkins, which is known as Pipeline Syntax.

Let's choose the second option:

On click of Pipeline Syntax, as highlighted in the diagram above, a new tab opens up in the browser. This is a handy utility where we can specify the operation that we wish to perform, and the tool will generate the script in Groovy for us. We can then copy the script and paste it into the pipeline configuration.

Let's select checkout: General SCM in the Sample Step drop-down. After providing the SCM Repo URL and user credentials, we need to click the Generate Pipeline Script button.

This generates the script in the text box:

Let's copy this script and save it somewhere for later use.

On the same page, let's scroll up and select withMaven: Provide Maven environment in the Sample Step drop-down. It must be noted here, that this option will be available only if Pipeline Maven Integration Plugin is installed.

We need to select the names of Maven and JDK installations next to the corresponding drop-downs. We need to click the Generate Pipeline Script button.

This generates the script in the text box:

Let's save the script.

There are still a few more scripts that we need to generate. Let's select node: Allocate node in the Sample Step drop-down, type master in the Label text field and click Generate Pipeline Script:

Let's save the script.

And last one.

Let's select stage: Stage in the Sample Step drop-down, type scm in the Stage Name text field and click Generate Pipeline Script:

Let's save it.

It's time to collate all the scripts generated so far and stitch them together:

node('master') { stage('scm') { checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'e50f564f-fbb7-4660-9c95-52dc93fa26f7', url: '//[email protected]/projects/springpocrepo.git']]]) } stage('build') { withMaven(jdk: 'JDK9.0.1', maven: 'Maven3.5.2') { sh 'mvn clean install' } } }

The first statement, node(‘master') in the script above, indicates that the job will be executed on a node named master, which is the default node on the Jenkins server.

Let's copy the above script to the Text Box in Pipeline section:

Let's save this configuration.

Now, there's only one thing that's left out. We need to configure a Webhook in Bitbucket. The Webhook is responsible for sending out a push notification to Jenkins server, whenever a particular event takes place in Bitbucket.

Let's take a look at how to configure it.

Let's log in to Bitbucket and select a repository. We should see an option Settings on the left-hand side column. Let's click it, and we should see an option Webhooks in WORKFLOW section. Let's create a new Webhook.

We need to provide some name to this webhook in the Title field. We also need to provide a URL for the webhook in the URL field. This URL needs to point to one particular REST API Endpoint provided by Jenkins, and that endpoint is bitbucket-hook.

It must be noted that the URL MUST end with a trailing slash:

While configuring the Webhook above, we've selected option Repository push. This means Bitbucket will send a notification to Jenkins server whenever a push happens.

This behavior can be modified; there are several different options to choose from.

For now, let's go with the default option,i.e., Repository Push.

We can setup webhook in Github, too; here‘s some helpful information on how to configure that.

Long story short: we've created a pipeline script in Groovy language – that should pull the source code from the master branch of the provided SCM repository (using the provided user credentials), whenever there's a push in the repository and then execute mvn clean install command on the Jenkins server.

It must be noted that this job's not going to run at any particular time. Instead, it's going to wait till there's a push in the master branch of the SCM repository.

As soon as there's a new push event, we'll see a new execution in the “Build History” section on the Jenkins job dashboard.

We should see a new build being initiated with a pending status next to it.

In a few seconds, this build should start execution, and we'll be able to see the complete log in Console Output.

The first statement in the console output says “Started by Bitbucket push by..” – this means that the build was triggered automatically when a Push took place in Bitbucket:

If all goes well, the build should complete successfully.

6. Create a Job That Uses Jenkinsfile

It's possible NOT to write any script in the Jenkins pipeline and still achieve build execution being triggered by the Bitbucket Webhook.

To do so, we have to create a new file in Bitbucket and name it as Jenkinsfile. The pipeline script needs to be transferred to this Jenkinsfile with a slight modification. Let's see exacttly how to do that.

We'll create a new pipeline in Jenkins and name it PipelineWithJenkinsfile.

On the pipeline configuration page, we'll select Pipeline script from SCM next to Definition in the Pipeline section. We'll see a drop-down with different options next to SCM. Let's choose Git from the drop-down.

We then have to provide the URL of Bitbucket repository and user credentials. Let's ensure that the text field next to Script Path contains the default value,i.e., Jenkinsfile:

As far as Jenkins is concerned, that's all we need to configure.

However, we have to create the Jenkinsfile in the repository; so, let's create a new text file, name it as Jenkinsfile and use this simple groovy script:

node('master') { stage('scm') { checkout scm } stage('build') { withMaven(jdk: 'JDK9.0.1', maven: 'Maven3.5.2') { sh 'mvn clean install' } } }

This script is almost the same as the pipeline script that we created in the earlier section, with just one modification. The statement in stage(‘scm') doesn't need the URL and user credentials information. Instead, all it needs is checkout scm.

And that's it. The moment we commit this file into Bitbucket, it'll trigger the build in Jenkins – and we should see the build being triggered in the Build History.

The only difference between this section and the earlier one is that we defined the pipeline script in the Bitbucket repository.

So ist der Build - Skript Teil des Quellcodes des Projektes , das gebaut werden muss . Wir pflegen das Skript nicht in Jenkins.

Stattdessen kennt Jenkins die SCM-Repository-Details und die Skriptdatei. Immer wenn ein Push in dieses Repository erfolgt, wird das Skript in Jenkinsfile auf dem Jenkins-Server ausgeführt .

7. Fazit

In diesem Tutorial haben wir gesehen, wie Jobs in Jenkins mithilfe verschiedener Strategien konfiguriert und geplant werden können.

Wir haben auch gesehen, wie ein Job in Jenkins so konfiguriert wird, dass er automatisch ausgelöst wird, basierend auf bestimmten Aktionen, die im SCM-Repository ausgeführt werden, z. B. Bitbucket.