jenkins如何通過pipeline部署springboot項目
更新時間：2024年09月25日 09:50:44 作者：海光之藍
為了提高SpringBoot項目的部署效率和規(guī)范性,建議將項目代碼和部署腳本分離,項目代碼倉庫專注業(yè)務邏輯,構建為jar包；另外設立獨立代碼倉庫存放Jenkinsfile等部署配置文件,在Jenkins中配置pipeline,自動拉取項目代碼進行構建和部署
jenkins通過pipeline部署springboot項目
部署方案
1、springboot項目不保存部署的pipeline或dockerfile構建腳本等與部署相關的問文件，業(yè)務項目只需關心業(yè)務，能夠正常構建為jar包即可
2、新建一個代碼倉庫，用于保存項目需要構建的Jenkinsfile
3、jenkins配置pipeline地址，從倉庫拉取要構建的項目進行構建和部署
構建文件倉庫示例結構如下：
4、jenkins配置
5、springboot項目鏡像構建文件
# 指定基礎鏡像，這是分階段構建的前期階段
FROM eclipse-temurin:21-jre-alpine as builder
# 設定時區(qū)、中文
ENV TZ=Asia/Shanghai
# 安裝chrony包
RUN apk add --no-cache chrony
# 配置chrony
RUN echo "server 0.pool.ntp.org iburst" >> /etc/chrony/chrony.conf
RUN echo "server 1.pool.ntp.org iburst" >> /etc/chrony/chrony.conf
RUN echo "server 2.pool.ntp.org iburst" >> /etc/chrony/chrony.conf
RUN echo "server 3.pool.ntp.org iburst" >> /etc/chrony/chrony.conf
# 執(zhí)行工作目錄
WORKDIR application
# 配置參數
ARG JAR_FILE=target/*.jar
# 將編譯構建得到的jar文件復制到鏡像空間中
COPY ${JAR_FILE} application.jar
# 通過工具spring-boot-jarmode-layertools從application.jar中提取拆分后的構建結果
RUN java -Djarmode=layertools -jar application.jar extract
# 啟動chronyd服務
CMD ["chronyd"]
# 正式構建鏡像
FROM builder
WORKDIR application
# 前一階段從jar中提取除了多個文件，這里分別執(zhí)行COPY命令復制到鏡像空間中，每次COPY都是一個layer
COPY --from=builder application/dependencies/ ./
COPY --from=builder application/spring-boot-loader/ ./
COPY --from=builder application/snapshot-dependencies/ ./
COPY --from=builder application/application/ ./
# ENTRYPOINT ["java", "org.springframework.boot.loader.JarLauncher"]
# 分層構建傳遞參數寫法
ENTRYPOINT ["sh","-c","java $JAVA_OPTS org.springframework.boot.loader.JarLauncher $PARAMS"]
# 新新
# 例如： docker run -d -p 21991:2199 --name demo3 -e JAVA_OPTS="-Xmx128m" -e PARAMS="--spring.application.name=test-demo" docker-demo:1.3
#鏡像放在最后，所傳的java參數和覆蓋配置文件參數寫在docker鏡像之前不然會導致傳遞失敗
基礎鏡像可選擇：
eclipse-temurin:21-jre-alpine eclipse-temurin:21-jdk-alpine openjdk:21 openjdk:21-slim # 基于dibian構建 bitnami/minideb debian:bullseye-slim
6、demo項目docker-compose.yml文件
services:
demo:
# 啟動時傳入鏡像tag示例：BUILD_TAG=20240406-57 docker-compose up -d
image: registry.cn-guangzhou.aliyuncs.com/lyr-test/demo:${BUILD_TAG}
container_name: demo
restart: always
network_mode: host
deploy:
resources:
limits:
cpus: '1.00'
memory: 1G
reservations:
cpus: '0.10'
memory: 256M
environment:
- JAVA_OPTS= -XX:+UseContainerSupport -XX:InitialRAMPercentage=75.0 -XX:MaxRAMPercentage=75.0 -XX:MinRAMPercentage=75.0
# 當network_mode使用hots模式時，端口號設置不生效
- PARAMS = --server.port=80807、Jenkinsfile構建文件
// 獲取當前日期
def current_date = new Date().format('yyyyMMdd')
// 獲取當前構建號
def build_number = env.BUILD_NUMBER.toInteger()
// 服務器集合
def server_list = []
// 所有的腳本命令放在pipeline中
pipeline {
// 指定任務在哪個集群節(jié)點中執(zhí)行，any表示任意節(jié)點
agent any
parameters {
string(description: '代碼分支', name: 'CODE_BRANCH_PARAM', defaultValue: 'master', trim: true)
// 這在Jenkins的憑據里設置的待部署服務器的名稱就是服務器的ip;用docker-compose部署一般只會部署幾臺服務器，如果量大，建議上k8s
booleanParam defaultValue: true, description: '10.0.24.8', name: 'SERVER_1'
booleanParam description: '10.0.24.3', name: 'SERVER_2'
}
tools {
git 'Default'
}
// 聲明全局變量，方便后面修改使用
environment {
GIT_CONFIG_BRANCH = "master"
GIT_CONFIG_ADDRESS = "https://*******/demo-jenkins.git"
CODE_ADDRESS = "https://********/demo.git"
// jenkins中創(chuàng)建的代碼倉庫密鑰id
CREDENTIALS_ID = 'git-credentials-id'
IMG_REPO_CREDENTIALS_ID = 'img-repo-credentials-id'
IMG_REPO = "registry.cn-guangzhou.aliyuncs.com"
REPO_NAMESPACE = 'lyr-test'
DEFAULT_BUILD_TAG = "${current_date}-${build_number}"
}
stages {
stage('環(huán)境檢測') {
steps {
// 構建環(huán)境檢測
sh '''
cat /proc/version
free -m
df -h
docker -v
git -v
mvn -v
java -version
'''
echo '環(huán)境檢測完成'
}
}
stage('拉取配置文件') {
steps {
echo "拉取配置文件代碼分支:${GIT_CONFIG_BRANCH}"
sh "pwd"
dir('/var/jenkins_home/workspace/pipeline/') {
sh "pwd"
echo "${CREDENTIALS_ID}"
checkout scmGit(branches: [[name: "${GIT_CONFIG_BRANCH}"]], extensions: [], userRemoteConfigs: [[credentialsId: "${CREDENTIALS_ID}", url: "${GIT_CONFIG_ADDRESS}"]])
}
sh "pwd"
}
}
stage('拉取代碼') {
steps {
echo pwd
// BRANCH為構建分支參數
git branch: "${CODE_BRANCH_PARAM}", credentialsId: "${CREDENTIALS_ID}", url: "${CODE_ADDRESS}"
}
}
stage('maven構建') {
steps {
echo pwd
sh """
mvn clean package -U -Dmaven.test.skip=true
"""
}
}
stage('生成鏡像') {
steps {
echo pwd
// JOB_NAME為項目名變量（內置的環(huán)境變量） TAG為設置的變量標簽
sh '''
cp /var/jenkins_home/workspace/pipeline/${JOB_NAME}/Dockerfile /var/jenkins_home/workspace/${JOB_NAME}
'''
script {
echo "當前鏡像tag:${DEFAULT_BUILD_TAG}"
sh "docker build -f Dockerfile -t ${IMG_REPO}/${REPO_NAMESPACE}/${JOB_NAME}:${DEFAULT_BUILD_TAG} ."
}
}
}
stage('推送鏡像') {
steps {
withCredentials([usernamePassword(credentialsId: 'img-repo-credentials-id', passwordVariable: 'IMG_PWD', usernameVariable: 'IMG_USER')]) {
sh '''
echo "${IMG_PWD}" | docker login --username ${IMG_USER} --password-stdin ${IMG_REPO}
docker image prune -f
docker push ${IMG_REPO}/${REPO_NAMESPACE}/${JOB_NAME}:${DEFAULT_BUILD_TAG}
'''
}
}
}
stage('清理') {
steps {
sh '''
# 退出鏡像倉庫
# docker logout ${IMG_REPO}
# 清理前鏡像
# docker images
# 刪除指定鏡像
# docker rmi ${IMG_REPO}/${REPO_NAMESPACE}/${JOB_NAME}:${PRE_BUILD_TAG}
# 命令刪除，刪除最早一個
# docker images | grep "demo" | sort -r | tail -n 1 | awk '{print $3}' | xargs docker rmi
# 清理后鏡像
docker images
'''
}
}
stage('部署至服務器') {
steps {
script {
script {
echo "SERVER_1:" + SERVER_1
if (SERVER_1=="true") {
server_list.add('10.0.24.8')
}
echo "SERVER_2:" + SERVER_2
if (SERVER_2=="true") {
server_list.add('10.0.24.3')
}
for (server_ip in server_list) {
echo "當前部署的服務器id:${server_ip}"
withCredentials([usernamePassword(credentialsId: server_ip, passwordVariable: 'SERVER_PWD', usernameVariable: 'SERVER_USER')]) {
node {
def remote = [:]
remote.name = "deploy"
remote.host = server_ip
remote.user = "${SERVER_USER}"
remote.password = "${SERVER_PWD}"
remote.allowAnyHosts = true
stage('遠程ssh部署') {
echo "當前遠程ssh部署的項目名:${JOB_NAME}"
sshCommand remote: remote, command: "mkdir -p /data/${JOB_NAME}"
sshPut remote: remote, from: """/var/jenkins_home/workspace/pipeline/${JOB_NAME}/docker-compose.yaml""", into: """/data/${JOB_NAME}"""
sshCommand remote: remote, command: """
cd /data/${JOB_NAME}/
BUILD_TAG=${DEFAULT_BUILD_TAG} docker-compose up -d
docker-compose ps
"""
echo "ssh部署腳本執(zhí)行完成"
}
}
}
}
}
}
}
}
}
// 通知內容
post {
success {
//成功通知
echo "成功通知"
}
failure {
// 失敗通知
echo "失敗通知"
}
}
}8、jenkins中配置Jenkinsfile中使用到的代碼倉庫憑據，鏡像倉庫憑據和服務器密碼憑據
9、配置完成后，點擊構建就行
10、當首次部署到新服務器時，需要登錄鏡像倉庫，可以手動登錄，也可以在jenkins中進行配置，每次發(fā)布都要登錄，不然會拉取鏡像錯誤
// 服務器集合
def server_list = []
// 所有的腳本命令放在pipeline中
pipeline {
// 指定任務在哪個集群節(jié)點中執(zhí)行，any表示任意節(jié)點
agent any
parameters {
choice(description: '服務名', name: 'SERVICE_NAME', choices: ["demo"])
string(description: '鏡像tag', name: 'BUILD_TAG_PARAM', defaultValue: '20240405-01', trim: true)
booleanParam defaultValue: true, description: '10.0.24.8', name: 'SERVER_1'
booleanParam description: '10.0.24.3', name: 'SERVER_2'
}
tools {
git 'Default'
}
// 聲明全局變量，方便后面修改使用
environment {
GIT_CONFIG_BRANCH = "master"
GIT_CONFIG_ADDRESS = "https://******/demo-jenkins.git"
// jenkins中創(chuàng)建的代碼倉庫密鑰id
CREDENTIALS_ID = 'git-credentials-id'
IMG_REPO_CREDENTIALS_ID = 'img-repo-credentials-id'
IMG_REPO = "registry.cn-guangzhou.aliyuncs.com"
REPO_NAMESPACE = 'lyr-test'
}
stages {
stage('環(huán)境檢測') {
steps {
// 構建環(huán)境檢測
sh '''
cat /proc/version
free -m
df -h
docker -v
git -v
mvn -v
java -version
'''
echo '環(huán)境檢測完成'
}
}
stage('拉取配置文件') {
steps {
echo "拉取配置文件代碼分支:${GIT_CONFIG_BRANCH}"
sh "pwd"
dir('/var/jenkins_home/workspace/pipeline/') {
sh "pwd"
echo "${CREDENTIALS_ID}"
checkout scmGit(branches: [[name: "${GIT_CONFIG_BRANCH}"]], extensions: [], userRemoteConfigs: [[credentialsId: "${CREDENTIALS_ID}", url: "${GIT_CONFIG_ADDRESS}"]])
}
sh "pwd"
}
}
stage('登錄鏡像') {
steps {
withCredentials([usernamePassword(credentialsId: 'img-repo-credentials-id', passwordVariable: 'IMG_PWD', usernameVariable: 'IMG_USER')]) {
script {
echo "SERVER_1:" + SERVER_1
if (SERVER_1=="true") {
server_list.add('10.0.24.8')
}
echo "SERVER_2:" + SERVER_2
if (SERVER_2=="true") {
server_list.add('10.0.24.3')
}
for (server_ip in server_list) {
echo "當前部署的服務器id:${server_ip}"
withCredentials([usernamePassword(credentialsId: server_ip, passwordVariable: 'SERVER_PWD', usernameVariable: 'SERVER_USER')]) {
node {
def remote = [:]
remote.name = "deploy"
remote.host = server_ip
remote.user = "${SERVER_USER}"
remote.password = "${SERVER_PWD}"
remote.allowAnyHosts = true
stage('遠程ssh部署') {
echo "當前遠程ssh登錄的服務器ip:${server_ip}"
sshCommand remote: remote, command: """
echo "${IMG_PWD}" | docker login --username ${IMG_USER} --password-stdin ${IMG_REPO}
"""
echo "鏡像ssh部署腳本執(zhí)行完成"
}
}
}
}
}
}
}
}
stage('部署至服務器') {
steps {
script {
script {
echo "SERVER_1:" + SERVER_1
if (SERVER_1=="true") {
server_list.add('10.0.24.8')
}
echo "SERVER_2:" + SERVER_2
if (SERVER_2=="true") {
server_list.add('10.0.24.3')
}
for (server_ip in server_list) {
echo "當前部署的服務器id:${server_ip}"
withCredentials([usernamePassword(credentialsId: server_ip, passwordVariable: 'SERVER_PWD', usernameVariable: 'SERVER_USER')]) {
node {
def remote = [:]
remote.name = "deploy"
remote.host = server_ip
remote.user = "${SERVER_USER}"
remote.password = "${SERVER_PWD}"
remote.allowAnyHosts = true
stage('遠程ssh部署') {
echo "當前遠程ssh部署的項目名:${SERVICE_NAME}"
sshCommand remote: remote, command: "mkdir -p /data/${SERVICE_NAME}"
sshPut remote: remote, from: """/var/jenkins_home/workspace/pipeline/${SERVICE_NAME}/docker-compose.yaml""", into: """/data/${SERVICE_NAME}"""
sshCommand remote: remote, command: """
cd /data/${SERVICE_NAME}/
BUILD_TAG=${BUILD_TAG_PARAM} docker-compose up -d
docker-compose ps
"""
echo "ssh部署腳本執(zhí)行完成"
}
}
}
}
}
}
}
}
}
// 通知內容
post {
success {
//成功通知
echo "成功通知"
}
failure {
// 失敗通知
echo "失敗通知"
}
}
}總結
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
這篇文章主要為大家詳細介紹了Java在編寫算法時如何加快讀寫數據速度,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下2024-03-03
這篇文章主要介紹了java在網頁上面抓取郵件地址的方法,是比較典型的Java正則匹配應用實例,具有一定的參考借鑒價值,需要的朋友可以參考下2014-11-11
Spring4下validation數據校驗無效(maven)的解決
這篇文章主要介紹了Spring4下validation數據校驗無效(maven)的解決，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-06-06
DFS指在進行算法運算時，優(yōu)先將該路徑的當前路徑執(zhí)行完畢，執(zhí)行完畢或失敗后向上回溯嘗試其他途徑。BFS指在進行算法運算時，優(yōu)先將當前路徑點的所有情況羅列出來，然后根據羅列出來的情況羅列下一層。本文介紹了二者的實現與應用，需要的可以參考一下2022-11-11
Java技能點之SimpleDateFormat進行日期格式化問題
這篇文章主要介紹了Java技能點之SimpleDateFormat進行日期格式化問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-04-04
這篇文章主要介紹了通過案例了解靜態(tài)修飾符static使用場景,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-10-10
這篇文章主要介紹了java反射機制根據屬性名獲取屬性值的操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-10-10
這篇文章主要介紹了javaWeb 四大域對象詳細介紹的相關資料,需要的朋友可以參考下2016-11-11
本篇文章主要介紹了Spring Boot的Profile配置詳解，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-05-05
這篇文章主要介紹了如何基于FTP4J實現FTPS連接過程解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-10-10