[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_136":137},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_83":-5,"_84":85,"_129":-5,"_130":11,"_131":17,"_132":11,"_133":-5,"_134":135},"canonicalUrl","https://hub.docker.com/r/zhengxiongzhao/jenkins-slave/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","zhengxiongzhao","reponame","jenkins-slave","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_37":38,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":50,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":69,"_74":11,"_75":76,"_80":28,"_81":82},"categories",[],"content_types",[39],"image","date_registered","2025-05-08T07:39:09.941554Z","description","","is_private","last_updated","2025-05-22T14:14:54.064309Z","last_modified","2025-05-22T14:56:22.07339Z","media_types",[51],"application/vnd.docker.container.image.v1+json","name","pull_count",1130,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Custom Jenkins Inbound Agent with Docker CLI, Buildx, and Pre-configured Caches/Mirrors\n\n[![Publish Docker image to Docker Hub](https://github.com/zhengxiongzhao/jenkins-slave/actions/workflows/publish-docker-image.yml/badge.svg?event=push)](https://github.com/zhengxiongzhao/jenkins-slave)\n\nThis repository provides a `Dockerfile` to build a custom Jenkins inbound agent. The agent is based on the official `jenkins/inbound-agent:latest-jdk17` and comes pre-installed with:\n\n* **Docker CLI**: Version `28.1.1` (customizable via `DOCKER_CLI_VERSION` build argument).\n* **Docker Buildx**: Version `v0.14.0` (customizable via `BUILDX_VERSION` build argument).\n* **Common Build Tools**: Includes `wget`, `tar`, `zip`, `curl`, `bash`, `gnupg`, `expect`, etc.\n* **Pre-configured Caches**: Dedicated cache directories for NPM, Yarn, Go, and Maven to speed up builds.\n* **Pre-configured Mirrors**: NPM, Yarn, Go, and Maven are configured to use popular Chinese mirrors.\n\nThis setup is ideal for Jenkins jobs that require Docker build capabilities and benefit from pre-configured caches and mirrors for faster dependency resolution. The system's default Java is JDK 17 (from the base image).\n\n\n## Image Contents\n\n* **Base Image**: `jenkins/inbound-agent:latest-jdk17` (Provides default JDK 17, which is the system default `java` and `JAVA_HOME`).\n* **Docker CLI**: Version `28.1.1` (or as specified by `DOCKER_CLI_VERSION` build-arg) installed in `/usr/local/bin/docker`.\n* **Docker Buildx**: Version `v0.14.0` (or as specified by `BUILDX_VERSION` build-arg) installed in `/usr/local/lib/docker/cli-plugins/docker-buildx`.\n* **Common Utilities**: `wget`, `vim`, `tar`, `zip`, `gzip`, `grep`, `coreutils`, `ca-certificates`, `apt-transport-https`, `iputils-ping`, `telnet`, `netcat-openbsd`, `iproute2`, `curl`, `bash`, `gnupg`, `expect`, `lsb-release`, `software-properties-common`.\n* **Cache Directories**:\n * NPM: `${CACHE_BASE_DIR}/npm` (defaults to `/data/cache/npm`)\n * Yarn: `${CACHE_BASE_DIR}/yarn` (defaults to `/data/cache/yarn`)\n * Go Mod: `${CACHE_BASE_DIR}/go/mod-cache` (defaults to `/data/cache/go/mod-cache`)\n * Go Build: `${CACHE_BASE_DIR}/go/cache` (defaults to `/data/cache/go/cache`)\n * Maven: `${CACHE_BASE_DIR}/mvn` (defaults to `/data/cache/mvn`)\n* **Mirror Configurations**:\n * **NPM**: `~/.npmrc` configured for `registry.npmmirror.com/`.\n * **Yarn**: `~/.yarnrc` and `~/.yarnrc.yml` configured for `registry.npmmirror.com/`.\n * **Go**: `~/.config/go/env` configured for `goproxy.cn`.\n * **Maven**: `~/.m2/settings.xml` configured to use Aliyun public repository as a mirror.\n* **User**: Runs as `jenkins` user (UID 1000). `jenkins` user is added to the `docker` group.\n\n## Getting Started\n\n### Prerequisites\n\n* Docker installed on your local machine.\n\n## Quick Usage / Standalone Agent Setup\n\nThis section describes how to run the agent container directly using Docker CLI or Docker Compose, typically for manual connections or local Jenkins setups.\n\n**Key Considerations for Standalone Usage:**\n* **Docker Socket**: To enable Docker commands within the agent (DooD - Docker-outside-of-Docker), mount the host's Docker socket: `-v /var/run/docker.sock:/var/run/docker.sock`.\n* **Persistent Caches**: To persist build caches (NPM, Yarn, Go, Maven), mount the `/data/cache` directory from the host: `-v /path/on/host/jenkins_cache:/data/cache`.\n* **Workspace**: Mount a directory for the agent's workspace: `-v /path/on/host/jenkins_agent_workspace:/home/jenkins/agent`.\n\n### Option 1: Using Docker CLI for Manual Connection\n\nYou can manually connect this agent to your Jenkins master using `docker run`. This is useful for testing or specific setups where you don't use a Jenkins plugin to manage agent lifecycles.\n\nFirst, create a new permanent agent node in Jenkins (Manage Jenkins -> Nodes and Clouds -> New Node). Set the Launch method to \"Launch agent by connecting it to the master\". Note the agent name and the secret provided by Jenkins.\n\nThen, run the agent container:\n```bash\ndocker run -d --name my-custom-agent \\\n -e JENKINS_AGENT_NAME=\"\" \\\n -e JENKINS_SECRET=\"\" \\\n -e JENKINS_JNLP_URL=\"/computer//slave-agent.jnlp\" \\\n -e JENKINS_AGENT_WORKDIR=\"/home/jenkins/agent/workspace\" \\\n -v /var/run/docker.sock:/var/run/docker.sock \\\n -v /path/to/your/host/workspace:/home/jenkins/agent/workspace \\\n -v /path/to/your/host/cache:/data/cache \\\n zhengxiongzhao/jenkins-slave:latest\n```\nReplace placeholders like ``, ``, and `` with your actual values. The `JENKINS_JNLP_URL` is often constructed this way. Adjust volume mounts as needed.\nMake sure your Jenkins master's JNLP port (usually 50000) is accessible from the agent container.\n\n### Option 2: Using Docker Compose for Jenkins Master & Agent\n\nYou can manage a local Jenkins master and this agent using Docker Compose. This is useful for local development or testing a complete Jenkins environment.\n\nHere's an example `docker-compose.yml`:\n```yaml\nversion: '3.8'\nservices:\n jenkins:\n image: jenkins/jenkins:lts-jdk17\n container_name: jenkins-master\n ports:\n - \"8080:8080\"\n - \"50000:50000\" # JNLP port\n volumes:\n - jenkins_home:/var/jenkins_home\n - /var/run/docker.sock:/var/run/docker.sock # Allow Jenkins master to access Docker for Docker Plugin\n environment:\n - JENKINS_OPTS=\"--prefix=/jenkins\" # Optional: if running Jenkins behind a reverse proxy with a path\n # For Docker Cloud configuration in Jenkins (if master launches other agents):\n - JENKINS_DOCKER_HOST=unix:///var/run/docker.sock\n\n # This agent service in Docker Compose is for a manually configured permanent agent.\n jenkins-agent:\n image: zhengxiongzhao/jenkins-slave:latest # Or your custom-built image tag\n container_name: custom-jenkins-agent-manual-compose\n # depends_on: [jenkins] # Ensures jenkins master starts first if this agent auto-connects\n # restart: unless-stopped\n environment:\n # For manual JNLP connection to the 'jenkins' service defined above:\n - JENKINS_AGENT_NAME=manual-compose-agent # Must match the node name in Jenkins\n - JENKINS_JNLP_URL=http://jenkins:8080/jenkins/computer/manual-compose-agent/slave-agent.jnlp # Assumes jenkins service name and prefix\n - JENKINS_SECRET=\n - JENKINS_AGENT_WORKDIR=/home/jenkins/agent/workspace\n volumes:\n - /var/run/docker.sock:/var/run/docker.sock # For DooD\n - ./agent_workspace_compose:/home/jenkins/agent/workspace # Example host path for workspace\n - ./agent_cache_compose:/data/cache # Example host path for cache\n # Note: For this agent to connect, you'd need to:\n # 1. Create a permanent node in Jenkins master named 'manual-compose-agent'.\n # 2. Set its launch method to \"Launch agent by connecting it to the master\".\n # 3. Copy the secret from Jenkins node configuration into JENKINS_SECRET above.\n # 4. Ensure network connectivity from this agent container to jenkins:50000 (JNLP port).\n\nvolumes:\n jenkins_home:\n```\n\n**To use this Docker Compose setup:**\n1. Save the content above as `docker-compose.yml`.\n2. Replace `` with the actual secret from the Jenkins node configuration.\n3. Create necessary local directories for volumes if using host paths (e.g., `./agent_workspace_compose`, `./agent_cache_compose`).\n4. Run `docker-compose up -d`.\n5. Access Jenkins at `http://localhost:8080` (or with `/jenkins` prefix if configured).\n6. **For the `jenkins-agent` service (manual permanent agent):**\n * In Jenkins: Manage Jenkins -> Nodes and Clouds -> New Node.\n * Node name: `manual-compose-agent` (or as in `JENKINS_AGENT_NAME`).\n * Select \"Permanent Agent\".\n * Remote root directory: `/home/jenkins/agent`.\n * Launch method: \"Launch agent by connecting it to the master\".\n * After saving, view the agent's configuration to get the `secret` and update `JENKINS_SECRET` in `docker-compose.yml` if it was a placeholder.\n * Restart the agent if you updated the secret: `docker-compose up -d --force-recreate jenkins-agent`.\n7. **Note**: The `jenkins` service in this Docker Compose setup can also be configured with the Docker Plugin (see next section) to dynamically launch other agents using this same `zhengxiongzhao/jenkins-slave:latest` image, separate from the manually defined `jenkins-agent` service.\n\n## Usage with Jenkins Plugins\n\nThis section describes how to integrate the agent with Jenkins using common plugins, where Jenkins manages the agent's lifecycle.\n\n**Key Considerations for Plugin-Managed Agents:**\n* **Docker Socket Access**: The Jenkins master (or the entity launching the agent, like a Kubernetes pod definition) needs access to the Docker daemon to start this agent container. This often means mounting `/var/run/docker.sock`.\n* **Persistent Caches**: Configure volume mounts for `/data/cache` in the plugin's agent template to persist caches.\n* **Docker Group ID (GID)**: The `jenkins` user in the image is part of a `docker` group. If using DooD, ensure the GID of the host's Docker socket matches the `docker` group GID inside the container (configurable via `DOCKER_HOST_GID` build-arg, defaults to `2375`) or manage permissions appropriately.\n\n### Option 1: Jenkins Docker Plugin\n\n* Install the \"Docker\" plugin in Jenkins.\n* Go to `Manage Jenkins` -> `Nodes and Clouds` -> `Configure Clouds`.\n* Add a new Cloud of type \"Docker\".\n* Configure Docker Host URI (e.g., `unix:///var/run/docker.sock` if Jenkins master has direct access, or `tcp://:2375` if remote).\n* Add a \"Docker Agent Template\":\n * **Label**: e.g., `docker-build-agent` (use this label in your Jenkins jobs).\n * **Docker Image**: `zhengxiongzhao/jenkins-slave:latest` (or your locally built tag).\n * **Remote File System Root**: `/home/jenkins/agent`.\n * **Connect method**: `Attach Docker container` or `Connect with JNLP`.\n * **Docker Run Arguments (Example for Docker Socket & Cache)**:\n ```\n -v /var/run/docker.sock:/var/run/docker.sock\n -v /path/on/host/jenkins_plugin_cache:/data/cache\n ```\n Ensure `/path/on/host/jenkins_plugin_cache` directory exists and has appropriate permissions.\n\n### Option 2: Jenkins Kubernetes Plugin\n\nIf your Jenkins master runs on Kubernetes, you can use the Kubernetes plugin to dynamically provision this agent as a pod.\n\n* Define a Pod Template in Jenkins configuration (Manage Jenkins -> Nodes and Clouds -> Configure Clouds -> Add new cloud -> Kubernetes):\n ```yaml\n apiVersion: v1\n kind: Pod\n spec:\n containers:\n - name: jnlp # The main JNLP container\n image: zhengxiongzhao/jenkins-slave:latest\n args: ['$(JENKINS_SECRET)', '$(JENKINS_NAME)']\n volumeMounts:\n - name: workspace-volume\n mountPath: /home/jenkins/agent # Jenkins agent root\n - name: app-cache # Consolidated cache volume\n mountPath: /data/cache\n - name: docker-sock # If running Docker-outside-of-Docker\n mountPath: /var/run/docker.sock\n volumes:\n - name: workspace-volume\n emptyDir: {} # Or a persistent volume claim\n - name: app-cache # Consolidated cache volume\n hostPath: # Example: using hostPath, consider persistentVolumeClaim for production\n path: /mnt/k8s_jenkins_cache # Ensure this path exists on K8s nodes\n type: DirectoryOrCreate\n - name: docker-sock # If running Docker-outside-of-Docker\n hostPath:\n path: /var/run/docker.sock\n type: Socket\n ```\n * Set the **Label** for this Pod Template (e.g., `docker-build-k8s-agent`).\n * Use this label in your Jenkins jobs.\n\n## Automated Publishing with GitHub Actions\n\nThis repository is configured with a GitHub Actions workflow (`.github/workflows/publish-docker-image.yml`) that automatically:\n\n1. Builds the Docker image whenever changes are pushed to the `main` branch.\n2. Tags the image with the commit SHA and `latest` (for the default branch).\n3. Publishes the image to Docker Hub.\n\nYou can find the published images on Docker Hub at:\n`https://hub.docker.com/r/zhengxiongzhao/jenkins-slave`\n\nThe image will be tagged as:\n* `zhengxiongzhao/jenkins-slave:latest` (for pushes to the default branch)\n* `zhengxiongzhao/jenkins-slave:`\n\n### Building the Image Locally\n\nTo build the Docker image locally if you prefer not to use the pre-built images from Docker Hub or want to customize it:\n\n1. Clone this repository:\n ```bash\n git clone https://github.com/zhengxiongzhao/jenkins-slave.git\n cd jenkins-slave\n ```\n2. Build the image:\n ```bash\n docker build -t custom-jenkins-agent:latest .\n ```\n You can also specify versions and cache locations during build using `ARG`s defined in the `Dockerfile`:\n ```bash\n docker build \\\n --build-arg DOCKER_CLI_VERSION=\"28.1.1\" \\\n --build-arg BUILDX_VERSION=\"v0.14.0\" \\\n --build-arg CACHE_BASE_DIR_ARG=\"/custom/cache/path\" \\\n -t my-custom-jenkins-agent:custom .\n ```\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request or open an Issue.\n(Further details on contributing can be added here, e.g., coding standards, commit message conventions.)\n\n## License\n\nThis project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.\n(You can choose a different license if you prefer. If so, create a `LICENSE` file with the chosen license text.)\n","has_starred","hub_user","immutable_tags_settings",{"_70":11,"_71":72},"enabled","rules",[73],".*","is_automated","permissions",{"_77":17,"_78":11,"_79":11},"read","write","admin","user","storage_size",346405127,"orgData","recentTags",[86,123],{"_87":39,"_88":89,"_90":91,"_92":93,"_94":95,"_96":97,"_45":112,"_113":89,"_114":28,"_115":51,"_52":116,"_117":118,"_119":103,"_120":112,"_121":61,"_122":17},"content_type","creator",8979858,"digest","sha256:083c96f9d57a5f787646555e0608abaaeb2109a9c1f22c96c3ebd5674b847761","full_size",253949446,"id",903819159,"images",[98],{"_99":100,"_90":91,"_101":43,"_102":103,"_104":105,"_106":107,"_108":43,"_109":-5,"_110":93,"_58":61,"_111":-5},"architecture","amd64","features","last_pulled","2026-09-11T21:04:08.26052129Z","last_pushed","2025-05-22T14:14:45.815095696Z","os","linux","os_features","os_version","size","variant","2025-05-22T14:14:52.989038Z","last_updater","last_updater_username","media_type","latest","repository",27309003,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_87":39,"_88":89,"_90":91,"_92":93,"_94":124,"_96":125,"_45":127,"_113":89,"_114":28,"_115":51,"_52":128,"_117":118,"_119":103,"_120":127,"_121":61,"_122":17},903819115,[126],{"_99":100,"_90":91,"_101":43,"_102":103,"_104":105,"_106":107,"_108":43,"_109":-5,"_110":93,"_58":61,"_111":-5},"2025-05-22T14:14:46.484148Z","v1.0.0","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_33":138,"_145":146,"_134":159,"_160":11},{"_35":139,"_37":140,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":141,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":142,"_74":11,"_75":144,"_80":28,"_81":82},[],[39],[51],{"_70":11,"_71":143},[73],{"_77":17,"_78":11,"_79":11},"tags",{"_147":148,"_149":-5,"_150":-5,"_151":152},"count",2,"next","previous","results",[153,156],{"_87":39,"_88":89,"_90":91,"_92":93,"_94":95,"_96":154,"_45":112,"_113":89,"_114":28,"_115":51,"_52":116,"_117":118,"_119":103,"_120":112,"_121":61,"_122":17},[155],{"_99":100,"_90":91,"_101":43,"_102":103,"_104":105,"_106":107,"_108":43,"_109":-5,"_110":93,"_58":61,"_111":-5},{"_87":39,"_88":89,"_90":91,"_92":93,"_94":124,"_96":157,"_45":127,"_113":89,"_114":28,"_115":51,"_52":128,"_117":118,"_119":103,"_120":127,"_121":61,"_122":17},[158],{"_99":100,"_90":91,"_101":43,"_102":103,"_104":105,"_106":107,"_108":43,"_109":-5,"_110":93,"_58":61,"_111":-5},[],"canDeleteTags","actionData","errors"]

zhengxiongzhao/jenkins-slave

Tags for zhengxiongzhao/jenkins-slave