|
| 1 | +# 🐳 Cloudsmith Datadog Agent Image Builder |
| 2 | + |
| 3 | +This repository automates the build and publication of a Datadog Agent Docker image with the [Cloudsmith integration](https://docs.cloudsmith.io/docs/integrations-datadog) pre-installed. |
| 4 | + |
| 5 | +📦 Image published to [Docker Hub → `cloudsmith/cloudsmith-datadog-agent`](https://hub.docker.com/r/cloudsmith/cloudsmith-datadog-agent) and [Cloudsmith → `cloudsmith/cloudsmith-datadog-agent`](https://cloudsmith.io/~cloudsmith/repos/cloudsmith-datadog-agent/packages/) |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## 📌 Purpose |
| 10 | + |
| 11 | +Datadog users who integrate Cloudsmith can now use a prebuilt Agent image with the `datadog-cloudsmith` integration bundled in. This reduces setup time and ensures consistent observability. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## 🚀 How It Works |
| 16 | + |
| 17 | +This repo contains a GitHub Actions workflow that: |
| 18 | + |
| 19 | +- Watches the [official Datadog integrations-extras repo](https://github.com/DataDog/integrations-extras) for new Cloudsmith integration tags (`cloudsmith-*`) |
| 20 | +- Triggers a Docker build using the official Datadog Agent base image |
| 21 | +- Installs the `datadog-cloudsmith` integration at the corresponding version |
| 22 | +- Pushes the final image to Cloudsmith and Docker Hub |
| 23 | + |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +## 🛠 Usage |
| 28 | + |
| 29 | +To run the image locally: |
| 30 | + |
| 31 | +```bash |
| 32 | +docker run -it --rm \ |
| 33 | + -e DD_API_KEY=<your-api-key> \ |
| 34 | + -e DD_SITE=datadoghq.com \ |
| 35 | + -e DD_HOSTNAME=custom-host \ |
| 36 | + -v ./conf.yaml:/etc/datadog-agent/conf.d/cloudsmith.d/conf.yaml \ |
| 37 | + -v ./datadog.yaml:/etc/datadog-agent/datadog.yaml:ro \ |
| 38 | + cloudsmith/cloudsmith-datadog-agent:<version> |
| 39 | +``` |
| 40 | + |
| 41 | +- Replace `<version>` with the appropriate tag (e.g., `1.0.0`, `1.1.0`, etc). |
| 42 | +- You can also mount the Cloudsmith config dynamically instead of copying it into the image. |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +## 📥 Tags Monitoring |
| 47 | +The CI workflow runs daily (via cron) and monitors for new tags like cloudsmith-1.2.3. |
| 48 | + |
| 49 | +When a new tag appears: |
| 50 | +- It triggers an automated Docker build |
| 51 | +- The new image is pushed to Docker Hub |
| 52 | +- `.last-built-version` is updated in this repo |
| 53 | + |
| 54 | +--- |
| 55 | + |
| 56 | +## 📁 Project Structure |
| 57 | + |
| 58 | +``` |
| 59 | +. |
| 60 | +├── Dockerfile # Default build using Datadog’s official base image |
| 61 | +├── .last-built-version # Tracks the most recently built tag |
| 62 | +├── README.md # GitHub repo README |
| 63 | +└── .github/ |
| 64 | + └── workflows/ |
| 65 | + └── build-cloudsmith-agent.yml # CI workflow to auto-build and publish Docker image |
| 66 | +``` |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +## 👥 Maintainer |
| 71 | + |
| 72 | +The image and workflow are maintained by [Cloudsmith Customer Engineering team](https://cloudsmith.com). Built for both public use and internal observability integrations. |
| 73 | + |
| 74 | +If you’re using Cloudsmith to distribute your packages, this is the easiest way to monitor activity directly within your Datadog dashboards. |
| 75 | + |
| 76 | + |
0 commit comments