Proper way to run docker container using Jenkinsfile - docker

When making a jenkinsfile, I have steps to run dockers image which pulling from my docker hub.
stage('pull image and run') {
steps {
sh '''
docker login -u <username> -p <password>
docker run -d -p 9090:3000 <tag>
'''
}
}
This step is okay if I run this script the first time. However, if I run this script the second time, it will get this error.
Login Succeeded
+ docker run -d -p 9090:3000 <tag>
669955464d74f9b5186b437b7127ca0a24f6ea366f3a903c673489bec741cf78
docker: Error response from daemon: driver failed programming external connectivity on endpoint distracted_driscoll (db16abd899cf0cbd4f26cf712b1eee4ace5b491e061e2e31795c2669296068eb): Bind for 0.0.0.0:9090 failed: port is already allocated.
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // withEnv
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
ERROR: script returned exit code 125
Finished: FAILURE
Obviously, the port 9090 is not available so the execution failed.
Question:
What is the correct way to upgrade an app inside a docker container?
I can stop the container before running the docker run, but I can't find a proper way to do that in jenkinsfile steps.
Any suggestion?
Thanks

Jenkins has really good docker support to make your build proceed within docker container. good example can be found here
One declarative example to do maven build will be:
pipeline {
agent {
docker {
image 'maven:3-alpine'
args '-v /tmp:/tmp'
registryUrl 'https://myregistry.com/'
registryCredentialsId 'myPredefinedCredentialsInJenkins'
}
}
stages {
stage("01") {
steps {
sh "mvn -v"
}
}
stage("02") {
steps {
sh "mvn --help"
}
}
}
}
In a scripted pipeline, it would be
node {
docker.withRegistry('https://registry.example.com', 'credentials-id') {
docker.image('node:14-alpine').inside("-v /tmp:/tmp") {
stage('Test') {
sh 'node --version'
}
}
}
}

Related

Keep container running when using agent docker

I have this script run in sequential stages:
stage("Set up first image"){
agent {
docker {
label "${RUNNING_NODE}"
image "${IMAGE}"
reuseNode true
}
}
steps {
echo "This is treasure!"
}
}
And this is output:
16:01:55 [Pipeline] {
16:01:55 [Pipeline] echo
16:01:55 This is treasure!
16:01:55 [Pipeline] }
16:01:55 $ docker stop --time=1 ca63
16:01:56 $ docker rm -f ca63
16:01:56 [Pipeline] // withDockerContainer
Docker stops container immediately after stage is built, but I want this container alive to use in another stage. Is there any way to keep container still running after stage is built?
Thanks in advance!

Jenkins docker: command not found

I have installed Jenkins on local machine (MAC OS) and docker as well.
I have created Jenkinsfile which contain below code
pipeline {
agent {
docker { image 'python:2.7' }
}
stages {
stage('Test') {
steps {
sh 'python --version'
}
}
}
}
Now clicked on Build Now which gave me an error like this
+ docker inspect -f . python:2.7
/Users/PKD/.jenkins/workspace/gfffffgfg#tmp/durable-42c1e897/script.sh: line 1: docker:
command not found
[Pipeline] isUnix
[Pipeline] sh
+ docker pull python:2.7
/Users/PKD/.jenkins/workspace/gfffffgfg#tmp/durable-0ffec7d7/script.sh: line 1: docker:
command not found
[Pipeline] }
[Pipeline] // withEnv
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
ERROR: script returned exit code 127
Finished: FAILURE
I'm new to Jenkins and trying to resolve this issue by google it but didn't find anything helpful.
Can someone please help me to resolve this issue ?
The path to the docker binary is probably not in your PATH variable in the context that Jenkins is started in. Try executing docker by providing the full path to the executable, in my case it is: /usr/local/bin/docker. This will be the case if Jenkins is started by launchctl directly and doesn't pick up your bash or zsh envitonment.
If you've started Jenkins in a docker container however the reason for the docker executable not being found is different. You have no docker installed in your Jenkins container. But I doubt this is the case.

Docker Container Jenkins Pipeline Script: Permission denied while executing the script

I am running jenkins inside a docker container. I have created a simple pipleline to checkout,build and run docker image, but I am getting the following error.
Below is my pipleline script:
node {
def mvnHome = tool name: 'Maven Path', type: 'maven'
stage('Git CheckOut') {
git branch: '2019_DOCKER_SERVICES', credentialsId: 'git-creds', url: 'http://10.10.10.84:8111/scm/git/JEE_M_SERVICES'
}
stage('Maven Build') {
// Run the maven build
withEnv(["MVN_HOME=$mvnHome"]) {
if (isUnix()) {
sh '"$MVN_HOME/bin/mvn" -f Services/user-service/pom.xml clean install'
} else {
// bat(/"%MVN_HOME%\bin\mvn" -f Services\\user-service\\pom.xml clean install/)
}
}
}
stage('Docker Image Build') {
sh '"Services/user-service/" docker build -t user-service'
}
}
But I am getting the follow error in last stage, the first two stages ran successfully.
[Pipeline] // stage
[Pipeline] stage
[Pipeline] { (Docker Image Build)
[Pipeline] sh
+ Services/user-service/ docker build -t user-service
/var/jenkins_home/jobs/docker-demo/workspace#tmp/durable-a5c035cf/script.sh: 1: /var/jenkins_home/jobs/docker-demo/workspace#tmp/durable-a5c035cf/script.sh: Services/user-service/: Permission denied
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
You have to set up new Jenkins slaves using Docker
It's weird to run Docker inside the Docker container
To access low-level operations you have to run your Docker container privileged

Unable to push docker image on registry using Jenkinsfile

I am trying to push my image through Jenkinsfile on repository but when I do that I am facing below error.
Error response from daemon: Get https://mydockerregistryurl/v1/users/: x509: certificate signed by unknown authority
I have found many articles about this but did not understand any of this.
Can anyone try to help me?
Below is my jenkinsfile.
#!groovy
pipeline {
agent {
node {
label 'otd-agent'
}
}
stages{
stage('Test Stage'){
steps{
sh 'mvn clean test'
}
}
stage('SonarQube Analysis'){
steps{
withSonarQubeEnv('otd-sonar') {
sh 'mvn sonar:sonar'
}
}
}
stage('Package Stage'){
steps{
sh 'mvn clean package'
}
}
stage('Building Docker image') {
steps{
script {
sh 'docker build . -t jagathe-spike'
}
}
}
stage('Deploy Docker Image') {
steps{
script {
sh 'docker login -u username -p password docker-registry-default'
sh 'docker push docker-registry-default/otd-agathe'
}
}
}
}
}
If target registry docker-registry-default is running on OpenShift, you should deploy the OCP CA certificate which download from OCP on your Jenkins host.
Refer Installing a certificate authority certificate for external registries for more details.
For instance,
Download CA certificate from your OCP.
jenkins ~# scp root#master1.ocp.example.com:/etc/origin/master/ca.crt \
/etc/pki/ca-trust/source/anchors/ocp-ca.crt
Execuste update-ca-trust for registering the CA.
jenkins ~# update-ca-trust extract
Copy the CA to /etc/docker/certs.d as follows.(${} is placeholder, you should replace it properly with your information)
jenkins ~# cp /etc/pki/ca-trust/source/anchors/ocp-ca.crt \
/etc/docker/certs.d/${docker-registry-default}:${PORT}
Restart docker service for reloading
jenkins ~# systemctl restart docker.service
I hope it help you.

Bind Volumes to Docker container in a pipeline job

So, I have this pipeline job that builds completely inside a Docker container. The Docker image used is pulled from a local repository before build and has almost all the dependencies required to run my project.
The problem is I need an option to define volumes to bind mound from Host to container so that I can perform some analysis using a tool available on my Host system but not in the container.
Is there a way to do this from inside a Jenkinsfile (Pipeline script)?
I'm not fully clear if this is what you mean. But if it isn't. Let me know and I'll try to figure out.
What I understand of mounting from host to container is mounting the content of the Jenkins Workspace inside the container.
For example in this pipeline:
pipeline {
agent { node { label 'xxx' } }
options {
buildDiscarder(logRotator(numToKeepStr: '3', artifactNumToKeepStr: '1'))
}
stages {
stage('add file') {
steps {
sh 'touch myfile.txt'
sh 'ls'
}
}
stage('Deploy') {
agent {
docker {
image 'lvthillo/aws-cli'
args '-v $WORKSPACE:/project'
reuseNode true
}
}
steps {
sh 'ls'
sh 'aws --version'
}
}
}
post {
always {
cleanWs()
}
}
}
In the first stage I just add a file to the workspace. just in Jenkins. Nothing with Docker.
In the second stage I start a docker container which contains the aws CLI (this is not installed on our jenkins slaves). We will start the container and mount the workspace inside the /project folder of my container. Now I can execute AWS CLI command's and I have access to the text file. In a next stage (not in the pipeline) you can use the file again in a different container or jenkins slave itself.
Output:
[Pipeline] {
[Pipeline] stage
[Pipeline] { (add file)
[Pipeline] sh
[test] Running shell script
+ touch myfile.txt
[Pipeline] sh
[test] Running shell script
+ ls
myfile.txt
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] { (Deploy)
[Pipeline] getContext
[Pipeline] sh
[test] Running shell script
+ docker inspect -f . lvthillo/aws-cli
.
[Pipeline] withDockerContainer
FJ Arch Slave 7 does not seem to be running inside a container
$ docker run -t -d -u 201:201 -v $WORKSPACE:/project -w ... lvthillo/aws-cli cat
$ docker top xx -eo pid,comm
[Pipeline] {
[Pipeline] sh
[test] Running shell script
+ ls
myfile.txt
[Pipeline] sh
[test] Running shell script
+ aws --version
aws-cli/1.14.57 Python/2.7.14 Linux/4.9.78-1-lts botocore/1.9.10
[Pipeline] }
$ docker stop --time=1 3652bf94e933cbc888def1eeaf89e1cf24554408f9e4421fabfd660012a53365
$ docker rm -f 3652bf94e933cbc888def1eeaf89e1cf24554408f9e4421fabfd660012a53365
[Pipeline] // withDockerContainer
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] { (Declarative: Post Actions)
[Pipeline] cleanWs
[WS-CLEANUP] Deleting project workspace...[WS-CLEANUP] done
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Finished: SUCCESS
In your case you can mount your data in the container. Perform the stuff and in a later stage you can do your analysis on your code on your jenkins slave itself (without docker)
Suppose you are under Linux, run the following code
docker run -it --rm -v /local_dir:/image_root_dir/mount_dir image_name
Here is some detail:
-it: interactive terminal
--rm: remove container after exit the container
-v: volume or say mount your local directory to a volume.
Since the mount function will 'cover' the directory in your image, your should alway make a new directory under your images root directory.
Visit Use bind mounts to get more information.
ps:
run
sudo -s
and tpye the password before you run docker, that saves you a lot of time, since you don't have to type sudo in front of docker every time you run docker.
ps2:
suppose you have an image with a long name and the image ID is 5ed6274db6ce, you can simply run at least the first three digits, or more
docker run [options] 5ed
if you have more image have the same first three digits, you can use four or more.
For example, you have following two images
REPOSITORY IMAGE ID
My_Image_with_very_long_name 5ed6274db6ce
My_Image_with_very_long_name2 5edc819f315e
you can simply run
docker run [options] 5ed6
to run the image My_Image_with_very_long_name.

Resources