cloud4me/jenkins-inbound-agent-docker-cli repository overview

Here's a comprehensive Docker Hub documentation for your Jenkins Swarm Agent image:

⁠Jenkins Inbound Agent with Docker CLI

A Docker image for running Jenkins agents using the Swarm plugin⁠ and based on docker-cli for seamless Docker support.

⁠Key Features

• Docker CLI: Allows Jenkins agents to interact with Docker directly.
• Swarm Plugin Support: Simplifies connecting agents to a Jenkins controller.
• Lightweight and Configurable: Customizable environment variables for various use cases.

⁠Usage

To deploy a Jenkins agent using this image, you can use a docker-compose.yml file or run it directly with the docker run command.

⁠Example with Docker Compose

version: '3.8'

services:
  jenkins-agent:
    image: cloud4me/jenkins-inbound-agent-docker-cli:latest
    environment:
      - URL=https://myjenkins.ir
      - USERNAME=<jenkins-server-username>
      - PASSWORD=<jenkins-server-password>
      - NAME=swarm-agent
      - USE_WEB_SOCKET=true
      - WORK_DIR=/home/agent
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock

⁠Example with docker run

docker run -d \
  --name jenkins-agent \
  --env URL=https://myjenkins.ir \
  --env USERNAME=<jenkins-server-username> \
  --env PASSWORD=<jenkins-server-password> \
  --env NAME=swarm-agent \
  --env USE_WEB_SOCKET=true \
  -v /var/run/docker.sock:/var/run/docker.sock \
  cloud4me/jenkins-inbound-agent-docker-cli:latest

⁠Environment Variables

Customize your agent configuration using the following environment variables:

⁠Volumes

The following volumes are typically required:

⁠Tags

⁠Example Use Case

Deploying this agent is ideal for builds that require Docker CLI operations, such as container builds or running tests in isolated environments.

⁠Feedback and Contributions

For issues, suggestions, or contributions, please visit our Cloud4me⁠ (replace with your actual link if needed).

This document can serve as the official Docker Hub description for your image, making it clear and user-friendly for potential users!