mirror of
https://github.com/KwiTsukasa/kt-template-online-api.git
synced 2026-05-27 15:44:54 +08:00
ci: 构建后启动业务容器
This commit is contained in:
parent
689dae40a1
commit
c95448bcf3
58
Jenkinsfile
vendored
58
Jenkinsfile
vendored
@ -34,10 +34,16 @@ pipeline {
|
|||||||
parameters {
|
parameters {
|
||||||
booleanParam(name: 'BUILD_DOCKER_IMAGE', defaultValue: true, description: '是否在非 PR 分支使用项目现有 dockerfile 构建镜像')
|
booleanParam(name: 'BUILD_DOCKER_IMAGE', defaultValue: true, description: '是否在非 PR 分支使用项目现有 dockerfile 构建镜像')
|
||||||
booleanParam(name: 'PUSH_DOCKER_IMAGE', defaultValue: false, description: '是否执行 docker push;仅发布分支生效,需要 Agent 已提前完成 docker login')
|
booleanParam(name: 'PUSH_DOCKER_IMAGE', defaultValue: false, description: '是否执行 docker push;仅发布分支生效,需要 Agent 已提前完成 docker login')
|
||||||
|
booleanParam(name: 'RUN_DOCKER_CONTAINER', defaultValue: true, description: 'Docker 镜像构建成功后是否重启业务容器;仅发布分支生效')
|
||||||
string(name: 'PUBLISH_BRANCH_PATTERN', defaultValue: '^(main|master|release/.+)$', description: '允许推送镜像的分支正则')
|
string(name: 'PUBLISH_BRANCH_PATTERN', defaultValue: '^(main|master|release/.+)$', description: '允许推送镜像的分支正则')
|
||||||
string(name: 'DOCKER_REGISTRY', defaultValue: '', description: '镜像仓库地址,为空时只生成本地镜像')
|
string(name: 'DOCKER_REGISTRY', defaultValue: '', description: '镜像仓库地址,为空时只生成本地镜像')
|
||||||
string(name: 'IMAGE_NAME', defaultValue: 'kt-template-online-api', description: 'Docker 镜像名称')
|
string(name: 'IMAGE_NAME', defaultValue: 'kt-template-online-api', description: 'Docker 镜像名称')
|
||||||
string(name: 'IMAGE_TAG', defaultValue: '', description: '镜像标签,为空时使用 分支名-BUILD_NUMBER;PR 使用源分支名')
|
string(name: 'IMAGE_TAG', defaultValue: '', description: '镜像标签,为空时使用 分支名-BUILD_NUMBER;PR 使用源分支名')
|
||||||
|
string(name: 'CONTAINER_NAME', defaultValue: 'kt-template-online-api', description: '业务容器名称')
|
||||||
|
string(name: 'CONTAINER_PORT', defaultValue: '48085', description: '宿主机映射端口,容器内固定使用 48085')
|
||||||
|
string(name: 'CONTAINER_ENV_FILE', defaultValue: '/nas-env/kt-template-online-api/.env.production', description: 'Agent 容器内可读取的业务 env 文件路径')
|
||||||
|
string(name: 'CONTAINER_NETWORK', defaultValue: '', description: '业务容器加入的 Docker 网络,为空则使用 Docker 默认网络')
|
||||||
|
string(name: 'CONTAINER_EXTRA_ARGS', defaultValue: '', description: 'docker run 额外参数,例如 -v /host/data:/app/data')
|
||||||
}
|
}
|
||||||
|
|
||||||
environment {
|
environment {
|
||||||
@ -102,6 +108,7 @@ pipeline {
|
|||||||
Tag: ${env.TAG_NAME ?: '-'}
|
Tag: ${env.TAG_NAME ?: '-'}
|
||||||
Docker image: ${env.DOCKER_IMAGE}
|
Docker image: ${env.DOCKER_IMAGE}
|
||||||
Publish branch: ${env.IS_PUBLISH_BRANCH}
|
Publish branch: ${env.IS_PUBLISH_BRANCH}
|
||||||
|
Run container: ${params.RUN_DOCKER_CONTAINER}
|
||||||
""".stripIndent()
|
""".stripIndent()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -167,6 +174,57 @@ pipeline {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
stage('Docker Run') {
|
||||||
|
when {
|
||||||
|
allOf {
|
||||||
|
expression { return params.BUILD_DOCKER_IMAGE && params.RUN_DOCKER_CONTAINER }
|
||||||
|
expression { return env.IS_CHANGE_REQUEST != 'true' }
|
||||||
|
expression { return env.IS_PUBLISH_BRANCH == 'true' }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
steps {
|
||||||
|
script {
|
||||||
|
if (!isUnix()) {
|
||||||
|
error('Docker Run stage requires a Linux/NAS Jenkins Agent.')
|
||||||
|
}
|
||||||
|
|
||||||
|
def containerName = params.CONTAINER_NAME?.trim() ?: 'kt-template-online-api'
|
||||||
|
def containerPort = params.CONTAINER_PORT?.trim() ?: env.APP_PORT
|
||||||
|
def containerEnvFile = params.CONTAINER_ENV_FILE?.trim()
|
||||||
|
if (!containerEnvFile) {
|
||||||
|
error('CONTAINER_ENV_FILE is required when RUN_DOCKER_CONTAINER is enabled.')
|
||||||
|
}
|
||||||
|
|
||||||
|
def networkArg = params.CONTAINER_NETWORK?.trim() ? "--network ${params.CONTAINER_NETWORK.trim()}" : ''
|
||||||
|
def extraArgs = params.CONTAINER_EXTRA_ARGS?.trim() ?: ''
|
||||||
|
|
||||||
|
// 部署阶段会替换同名容器;真实 env 文件只从 NAS 挂载进 Agent,不进入 Git。
|
||||||
|
runCmd("""
|
||||||
|
set -e
|
||||||
|
if [ ! -f '${containerEnvFile}' ]; then
|
||||||
|
echo "Container env file not found: ${containerEnvFile}"
|
||||||
|
echo "Mount the NAS env directory into the Agent, for example:"
|
||||||
|
echo "/vol1/docker/kt-template-online-api:/nas-env/kt-template-online-api:ro"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
docker rm -f '${containerName}' >/dev/null 2>&1 || true
|
||||||
|
docker run -d \\
|
||||||
|
--name '${containerName}' \\
|
||||||
|
--restart=always \\
|
||||||
|
${networkArg} \\
|
||||||
|
--env-file '${containerEnvFile}' \\
|
||||||
|
-e NODE_ENV=production \\
|
||||||
|
-p '${containerPort}':${env.APP_PORT} \\
|
||||||
|
${extraArgs} \\
|
||||||
|
'${env.DOCKER_IMAGE}'
|
||||||
|
|
||||||
|
docker ps --filter "name=^/${containerName}\$"
|
||||||
|
""".stripIndent())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
post {
|
post {
|
||||||
|
|||||||
@ -72,6 +72,7 @@ docker run -d \
|
|||||||
-e JENKINS_SECRET=替换成节点页面里的secret \
|
-e JENKINS_SECRET=替换成节点页面里的secret \
|
||||||
-e JENKINS_AGENT_WORKDIR=/home/jenkins/agent \
|
-e JENKINS_AGENT_WORKDIR=/home/jenkins/agent \
|
||||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||||
|
-v /vol1/docker/kt-template-online-api:/nas-env/kt-template-online-api:ro \
|
||||||
-v kt-node-agent-workdir:/home/jenkins/agent \
|
-v kt-node-agent-workdir:/home/jenkins/agent \
|
||||||
kt-jenkins-agent:node22
|
kt-jenkins-agent:node22
|
||||||
```
|
```
|
||||||
@ -84,6 +85,39 @@ docker run -d \
|
|||||||
|
|
||||||
如果 NAS 上的 Agent 需要执行 `docker build`,保留 `/var/run/docker.sock` 挂载。这个挂载等同于让 Agent 拥有 NAS Docker 控制权限,只建议放在可信内网环境。
|
如果 NAS 上的 Agent 需要执行 `docker build`,保留 `/var/run/docker.sock` 挂载。这个挂载等同于让 Agent 拥有 NAS Docker 控制权限,只建议放在可信内网环境。
|
||||||
|
|
||||||
|
## 业务容器 env 文件
|
||||||
|
|
||||||
|
Jenkinsfile 的 `Docker Run` 阶段默认会读取 Agent 容器内的:
|
||||||
|
|
||||||
|
```text
|
||||||
|
/nas-env/kt-template-online-api/.env.production
|
||||||
|
```
|
||||||
|
|
||||||
|
这个路径来自上面启动 Agent 时的只读挂载:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
-v /vol1/docker/kt-template-online-api:/nas-env/kt-template-online-api:ro
|
||||||
|
```
|
||||||
|
|
||||||
|
所以真实生产环境变量文件放在 NAS 本地即可,不需要上传 Git:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir -p /vol1/docker/kt-template-online-api
|
||||||
|
vi /vol1/docker/kt-template-online-api/.env.production
|
||||||
|
chmod 600 /vol1/docker/kt-template-online-api/.env.production
|
||||||
|
```
|
||||||
|
|
||||||
|
多分支流水线构建时保持默认参数即可:
|
||||||
|
|
||||||
|
```text
|
||||||
|
RUN_DOCKER_CONTAINER=true
|
||||||
|
CONTAINER_NAME=kt-template-online-api
|
||||||
|
CONTAINER_PORT=48085
|
||||||
|
CONTAINER_ENV_FILE=/nas-env/kt-template-online-api/.env.production
|
||||||
|
```
|
||||||
|
|
||||||
|
如果业务容器需要加入某个 Docker 网络,在 Jenkins 参数 `CONTAINER_NETWORK` 填网络名;如果需要挂载上传目录、日志目录等,在 `CONTAINER_EXTRA_ARGS` 填额外的 `docker run` 参数。
|
||||||
|
|
||||||
## 验证
|
## 验证
|
||||||
|
|
||||||
查看 Agent 日志:
|
查看 Agent 日志:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user