Skip to content

NimTechnology

Trình bày các công nghệ CLOUD một cách dễ hiểu.

  • Kubernetes & Container
    • Docker
    • Kubernetes
      • Ingress
    • Helm Chart
    • Isito-EnvoyFilter
    • Apache Kafka
      • Kafka
      • Kafka Connect
      • Lenses
    • Vault
    • Longhorn – Storage
    • VictoriaMetrics
  • CI/CD
    • ArgoCD
    • ArgoWorkflows
    • Spinnaker
    • Jenkins
    • Harbor
    • TeamCity
    • Git
      • Bitbucket
  • Coding
    • Terraform
      • GCP – Google Cloud
      • AWS – Amazon Web Service
    • Golang
    • Laravel
    • Python
    • Jquery & JavaScript
    • Selenium
  • Log & Monitor
    • Prometheus
    • Grafana
    • ELK
      • Kibana
      • Logstash
  • BareMetal
  • Toggle search form

[Jenkins] Lesson 5: Condition “When” in Pipeline Jenkins

Posted on October 30, 2021October 31, 2021 By nim No Comments on [Jenkins] Lesson 5: Condition “When” in Pipeline Jenkins

Contents

  • When
    • Environment
    • equals
    • Not
    • expression
    • allOf
    • anyOf
    • Branch
    • buildingTag-tag
      • buildingTag – all stag
      • tag
        • particular tag
        • prefix tag
    • changelog – commit
    • changeRequest – Pull Request
      • Attributes of changeRequest
    • changeset

When

nếu mà match với điều kiện when thì sẽ action step trong stage(“Đó”)
nếu ko match với điều kiện when thì skip step trong stage(“Đó”)
nghe hơi ngáo vậy đi vào ví dụ thôi

Environment

pipeline{
	agent{
	    label "k8s-permanent"
	}
	environment{
	    DEPLOY_TO = "production"
	}
	stages{
		stage("Build"){
		    when{
		        environment name: "DEPLOY_TO", value: "production"
		    }
			steps{
				echo "Deploying"
			}
		}
	}
}

When này sẽ check environment nếu trả về true thì action steps bên dưới.

pipeline{
	agent{
	    label "k8s-permanent"
	}
	environment{
	    DEPLOY_TO = "test"
	}
	stages{
		stage("Build"){
		    when{
		        environment name: "DEPLOY_TO", value: "production"
		    }
			steps{
				echo "Deploying"
			}
		}
	}
}
Nếu không match điều kiện trong when thì skip stage

equals

pipeline{
	agent{
	    label "k8s-permanent"
	}
	environment{
	    DEPLOY_TO = "production"
	}
	stages{
		stage("Build"){
		    when{
		        equals expected: "production", actual: DEPLOY_TO // not actual: "DEPLOY_TO"
		    }
			steps{
				echo "Deploying ${DEPLOY_TO}"
			}
		}
	}
}

Các bạn để ý kĩ chỗ actual nhé

pipeline{
	agent{
	    label "k8s-permanent"
	}
	environment{
	    DEPLOY_TO = "test"
	}
	stages{
		stage("Build"){
		    when{
		        equals expected: "production", actual: DEPLOY_TO // not actual: "DEPLOY_TO"
		    }
			steps{
				echo "Deploying ${DEPLOY_TO}"
			}
		}
	}
}

Not

pipeline{
	agent{
	    label "k8s-permanent"
	}
	environment{
	    DEPLOY_TO = "test"
	}
	stages{
		stage("Build"){
		    when{
		        not{
		            equals expected: "production", actual: DEPLOY_TO // not actual: "DEPLOY_TO"
		        }
		    }
			steps{
				echo "Deploying ${DEPLOY_TO}"
			}
		}
	}
}

Nó là nghịch đảo

expression

nó giống kiểu so sánh nhưng gọn hơn equals

pipeline{
	agent{
	    label "k8s-permanent"
	}
	environment{
	    DEPLOY_TO = "production"
	}
	stages{
		stage("Build"){
		    when{
		        expression{
		            DEPLOY_TO == "production"
		        }
		    }
			steps{
				echo "Deploying ${DEPLOY_TO}"
			}
		}
	}
}

Bạn thử thay environment sai sem kq như thế nào nhé

allOf

yêu cầu tất cả các điều kiện bên trong phải trả về true

pipeline{
	agent{
	    label "k8s-permanent"
	}
	environment{
	    DEPLOY_TO = "production"
	    LANGUAGE = "golang"
	}
	stages{
		stage("Build"){
		    when{
		        allOf{
		            environment name: "DEPLOY_TO", value: "production"
		            environment name: "LANGUAGE", value: "golang"
		        }
		    }
			steps{
				echo "Deploying ${DEPLOY_TO} language ${LANGUAGE}"
			}
		}
	}
}

Nếu chúng ta chỉnh sai

anyOf

chỉ cần 1 trong các điều kiện trả true thì ok
tất cả đều trả về false là skip stage

pipeline{
	agent{
	    label "k8s-permanent"
	}
	environment{
	    DEPLOY_TO = "production"
	    LANGUAGE = "golang"
	}
	stages{
		stage("Build"){
		    when{
		        anyOf{
		            environment name: "DEPLOY_TO", value: "dev"
		            environment name: "LANGUAGE", value: "golang"
		        }
		    }
			steps{
				echo "Deploying ${DEPLOY_TO} language ${LANGUAGE}"
			}
		}
	}
}

con nếu false hết

Branch

https://github.com/mrnim94/pipeline-stage-when-branch

Nội dung file Jenkinsfile:

pipeline {
    agent any
    stages {
        stage('Build Master') {
            when {
                branch 'master'
            }
            steps {
                echo 'Building master'
            }
        }
        stage('Build Dev') {
            when {
                branch 'dev'
            }
            steps {
                echo 'Building dev'
            }
        }
    }
}

save lại và theo dõi

còn job master thì ngược lại

buildingTag-tag

https://github.com/mrnim94/pipeline-stage-when-buildingTag-tag

ở phần này bạn cần tìm hiểu một số command liên quan đến git he
https://xuanthulab.net/lam-viec-voi-tag-trong-git.html
Mình thấy anh mô tả khá chi tiết

Con ko bạn fork repo mình về sài ok

buildingTag – all stag

Jenkinsfile của tag buildTag

pipeline {
    agent any
	
    stages {
        stage('Build') {
		
			when{
				buildingTag()
			}
		
            steps {                
                echo 'Hello World building tag'
            }
        }
    }
}

tag

particular tag

ngoài ra chúng ta còn có thể chỉ tag chính xác

pipeline {
    agent any
	
    stages {
        stage('Build') {
		
			when{
				tag "2.0"
			}
		
            steps {                
                echo 'Hello World building tag'
            }
        }
    }
}

Lúc này chỉ run khi tag 2.0

prefix tag

Hoặc tag theo kiểu prefix

pipeline {
    agent any
	
    stages {
        stage('Build') {
		
			when{
				tag "release-*"
			}
		
            steps {                
                echo 'Hello World building tag'
            }
        }
    }
}

Lúc này sẽ run tag tag “release-1.0” hay “release-nim”

changelog – commit

https://github.com/mrnim94/pipeline-stage-when-changelog

pipeline {
    agent any
	
    stages {
        stage('Build') {
		
			when{
				changelog '.*some_text.*'
			}
		
            steps {                
                echo 'Hello World changelog'
            }
        }
    }
}

Nếu commit của chúng ta có string và match reg '.some_text.'
thì branch chứa commit sẽ được run stage build

save lại và theo đõi
build đã chạy

changeRequest – Pull Request

Bạn run các job dựa trên các pull request

https://github.com/mrnim94/pipeline-stage-when-changeRequest

Ta có Jenkinsfile

pipeline {
    agent any
	
    stages {
        stage('Build') {
		
			when{
				changeRequest()
			}
		
            steps {                
                echo 'Hello World changing request'
            }
        }
    }
}

Bạn sửa branch dev và toạ Pull request từ dev vào master

Trên jenkins tạo 1 job “Multibranch Pipeline” như các ví dụ có liên quan đên github nhé.

Đã build trên pull request
Ta thấy changeRequest còn giúp bạn các attributes như title, author
vậy là như thế nào

Attributes of changeRequest

pipeline {
    agent any
	
    stages {
        stage('Build') {
		
			when{
				changeRequest title:"when-pr"
			}
		
            steps {                
                echo 'Hello World changing request'
            }
        }
    }
}

ở Jenkinsfile trên chỉ build trên các Pull Request có title là when-pr

thực hiên scan repo lại
Ok build được trên pull request nhé.

changeset

pipeline {
    agent any
	
    stages {
        stage('Build') {
		
			when{
				changeset "*.js"
			}
		
            steps {                
                echo 'Hello World changeset JS'
            }
        }
    }
}

Nó sẽ đánh giá là bạn có change các fine có duôi là js hay ko?

change file js
sửa file .txt

Như đọc ở trên thì changeset ko phân biệt chữ hoa và chữ thường “glob case insensitive”

Để bắt chính sác hơn thì người ta dùng thêm

caseSensitive : Phân biệt hoa thường
REGEXP for regular expression matching

Và biểu diễn trên Pipeline như sau:

pipeline {
    agent any
	
    stages {
        stage('Build') {
		
			when{
				changeset pattern: "helloworld.js", caseSensitive: true
			}
		
            steps {                
                echo 'Hello World changeset JS'
            }
        }
    }
}

pipeline{
	agent none
	environment{
	    DEPLOY_TO = "production"
	}
	stages{
		stage("Build"){
            agent{
        	    label "k8s-permanent"
        	}
		    when{
		        beforeAgent false
		        environment name: "DEPLOY_TO", value: "dev"
		    }
			steps{
				echo "Deploying ${DEPLOY_TO} language ${LANGUAGE}"
			}
		}
	}
}

Giờ nếu các bạn muốn when được execute trước asign agent permanent thì sửa Pipeline như sau

pipeline{
	agent none
	environment{
	    DEPLOY_TO = "production"
	}
	stages{
		stage("Build"){
            agent{
        	    label "k8s-permanent"
        	}
		    when{
		        beforeAgent true
		        environment name: "DEPLOY_TO", value: "dev"
		    }
			steps{
				echo "Deploying ${DEPLOY_TO} language ${LANGUAGE}"
			}
		}
	}
}
Ta thấy stage build đã sảy ra trước và sử dụng agent none để run
Jenkins

Post navigation

Previous Post: [Jenkins] Lesson 4: Environment in Pipeline Jenkins
Next Post: [Jenkins] Lesson 6: Parallel in Pipe Jenkins

More Related Articles

[Jenkins] How do you show password or decrypt credentials on Jenkins Jenkins
Hướng dẫn phần quền user trên Jenkins. CI/CD
[Jenkins] Lesson 15: newContainerPerStages in Pipeline Jenkins Jenkins
[Jenkins] Scripted Pipeline lesson 6: Stage _ Input Jenkins
[Jenkins] Scripted Pipeline lesson 7: Stage _ Post Jenkins
[Jenkins] Scripted Pipeline lesson 14: Options _ NewContainerPerStage. Jenkins

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

Tham Gia Group DevOps nhé!
Để Nim có nhiều động lực ra nhiều bài viết.
Để nhận được những thông báo mới nhất.

Recent Posts

  • [Smartctl] Instruction check the health disk of Raspberry. January 16, 2023
  • [kubectl/Argocd] How to create a kubectl config file for serviceaccount or from the cluster secret of Argocd January 12, 2023
  • [Helm/Github] Create a public Helm chart repository with GitHub Pages January 8, 2023
  • [AWS] How to increase the disk size of a Windows EC2 machine? January 4, 2023
  • [Redis] ElastiCache-Redis Cross-Region Replication|Global DataStore January 3, 2023

Archives

  • January 2023
  • December 2022
  • November 2022
  • October 2022
  • September 2022
  • August 2022
  • July 2022
  • June 2022
  • May 2022
  • April 2022
  • March 2022
  • February 2022
  • January 2022
  • December 2021
  • November 2021
  • October 2021
  • September 2021
  • August 2021
  • July 2021
  • June 2021

Categories

  • BareMetal
  • CI/CD
    • ArgoCD
    • ArgoWorkflows
    • Git
      • Bitbucket
    • Harbor
    • Jenkins
    • Spinnaker
    • TeamCity
  • Coding
    • Golang
    • Jquery & JavaScript
    • Laravel
    • Python
    • Selenium
    • Terraform
      • AWS – Amazon Web Service
      • GCP – Google Cloud
  • Kubernetes & Container
    • Apache Kafka
      • Kafka
      • Kafka Connect
      • Lenses
    • Docker
    • Helm Chart
    • Isito-EnvoyFilter
    • Kubernetes
      • Ingress
    • Longhorn – Storage
    • Vault
    • VictoriaMetrics
  • Log & Monitor
    • ELK
      • Kibana
      • Logstash
    • Grafana
    • Prometheus
  • Uncategorized
  • Admin

Copyright © 2023 NimTechnology.