In the previous article, we installed a jenkins server, installed required plugins to work with Git and Docker Hub. Then we created credetials for Git and DockerHub.
Now we will create a jenkins Job on the server. Then we will create a jenkinsfile in our website folder on the hostmachine and define pipeline steps.
Let's create a pipeline task on Jenkins. Click Dashboard and create a job. Enter a name for this job > choose pipeline > Hit Ok
Each time Jenkins runs a job, it will actually creates a build. You can define how many days you want to keep those build and the how many builds that you want to keep.
Click Save.
On VSCode on the host machine, install the vscode extension named "Jenkins Runner". This extension will allow us to run Jenkins Pipeline Script from VS code.
On your host machine in website folder create a folder named ".vscode". On .vscode folder create a file named "settings.json"
In paranthesis, Just type "jen" and it will bring available templates.
We do not need most of the fields in that template. Remove the unnecessary fileds and edit the template just like below. website_CI is the pipeline job's name that I created on Jenkins server. jenkins-master will be specified in the host config.
{
"jenkins-runner.jobs": {
"website_CI": {
"isDefault": true,
"runWith": "jenkins-master",
"name": "website_CI",
}
},
}
To add host information, type jen again and select the template named "jenkins-runner.hostConfigs"
Edit Host config like below. Makesureyou enter your own jenkins user name and password.
{
"jenkins-runner.jobs": {
"website_CI": {
"isDefault": true,
"runWith": "jenkins-master",
"name": "website_CI",
}
},
"jenkins-runner.hostConfigs": {
"jenkins-master": {
"url": "http://jenkins.configland.com:8080/",
"user": "yourjenkinsusername",
"password": "jenkinsuserpassword",
"useCrumbIssuer": true,
},
}
}
Save the settings.json.
In website folder, create file named "jenkinsfile". This will define the pipeline steps. For now we just want to clean up our workspace with this jenkinsfile in order to check if everything isconfigured correctly.
pipeline{
agent any
stages{
stage('Cleanup Workspace'){
steps{
script{
cleanWs()
}
}
}
}
}
On VScode, use Ctrl+Shift+P to openup command palette and select "Run Pipeline script on default job". This will run the jenkins pipeline.
On VSCode terminal, I can see the Jenkins job ran without any problems. If you see errors that about groovy control, the first thing you should check is jenkinsfile syntax.
In this article, its explained how you can validate your jenkinsfile syntax on VSCode locally.
On Jenkins server I can see our pipeline job successfully completed. You can click the build number on the bottom left to see console output.
Lets modify jenkinsfile and add another pipeline stage that connects to GitHub and clones our repository to jenkins workspace. credentialsId below(GitHub) is the GitHub Credential ID when I created the Credentials on Jenkins Server.
pipeline{
agent any
stages{
stage('Cleanup Workspace'){
steps{
script{
cleanWs()
}
}
}
stage('Checkout SCM'){
steps{
script{
git credentialsId: 'GitHub',
url: 'https://github.com/selimatmaca/website.git',
branch: 'main'
}
}
}
}
}
We have modified the jenkinsfile but you know github still does not have jenkinsfile in our repository. Run the following commands to push
git add .
git commit -m "pushing jenkinsfile"
git push
You can trigger the pipeline from Jenkins by clicking Build Now or you can just use VSCode command palette that we used previously.
So far everything seems to be in order. In the next article, we will create our actual Jenkins Job for Django App.