simenduev/jenkins-auto-slave

Jenkins自动代理镜像

镜像概述

基于JNLP协议的Jenkins代理Docker镜像，支持自动注册到Jenkins主节点，并在容器退出时自动注销。该镜像未预装agent.jar，而是在容器启动时从Jenkins主节点动态下载，有效避免主节点与代理之间的版本冲突问题。

核心功能和特性

• 自动注册与注销：容器启动时自动注册到Jenkins主节点，退出时自动注销
• 动态下载agent.jar：启动时从主节点获取agent.jar，解决版本兼容性问题
• 灵活配置：通过环境变量自定义代理名称、标签、执行器数量等参数
• Docker集成：支持挂载Docker套接字和二进制文件，实现代理内运行Docker命令

环境变量

常用变量

• JENKINS_AUTH：Jenkins服务器用户名及密码/API令牌，格式为user:secret
• JENKINS_URL：Jenkins主节点URL，例如http://localhost:8080
• JENKINS_AGENT_LABEL：空格分隔的代理标签，用于将代理分组（无默认值）
• JENKINS_AGENT_MODE：Jenkins在该节点调度构建的模式，可选NORMAL/EXCLUSIVE（默认NORMAL）
• JENKINS_AGENT_NAME：注册时使用的代理名称（默认$HOSTNAME）
• JENKINS_AGENT_NUM_EXECUTORS：执行器数量（默认1）

较少使用（可保持默认）

• DOCKER_GROUP：Docker组名称，需与主机Docker组一致（默认docker）
• DOCKER_SOCKET：Docker套接字路径（默认/var/run/docker.sock）
• JAVA_OPTS：传递给agent.jar进程的Java选项（默认未设置）
• JENKINS_AGENT_CONNECTION_MODE：与Jenkins控制器的连接模式（默认-http）

所需权限

该镜像应在可信环境中使用，即使如此，用于注册代理的用户权限也应受限。

请勿使用管理员用户

为实现自动注册到主节点，需创建具有以下权限的用户：

• Overall/Read
• Agent/Connect
• Agent/Create
• Agent/Delete
• Agent/ExtendedRead

使用方法

基本使用

未指定环境变量时运行会提示错误：

sh
$ docker run --rm simenduev/jenkins-auto-slave
please set both JENKINS_URL and JENKINS_AUTH env. variables
example:
JENKINS_AUTH=user:password
JENKINS_URL=http://localhost:8080

基础工作命令

sh
$ docker run -d \
    --net host \
    -e JENKINS_URL=http://jenkins.internal.domain:8080 \
    -e JENKINS_AUTH=registrator:1234567890123456789012  \
    -v /any/path/you/like:/var/jenkins_home \
    simenduev/jenkins-auto-slave

必须挂载/var/jenkins_home卷，代理才能执行构建任务。

支持Docker命令的配置

若需代理内运行Docker命令，需额外挂载Docker套接字和二进制文件：

sh
$ docker run -d \
    --net host \
    -e JENKINS_URL=[***] \
    -e JENKINS_AUTH=registrator:1234567890123456789012  \
    -v /any/path/you/like:/var/jenkins_home \
    -v /run/docker.sock:/run/docker.sock \
    -v /usr/bin/docker:/usr/bin/docker \
    simenduev/jenkins-auto-slave