Files
Zabbix/zabbix-apk-builder/README.md
2025-09-03 19:27:33 +02:00

196 lines
4.1 KiB
Markdown

# Zabbix APK Builder
Automated Alpine Linux package builder for Zabbix Agent and Proxy with CI/CD pipeline integration.
## Features
- 🔄 **Automatic Version Detection**: Monitors Zabbix releases using official Bitbucket API
- 🏗️ **Docker-based Building**: Consistent, reproducible builds in isolated environment
- 🚀 **CI/CD Pipeline**: Full automation from version detection to package deployment
- 📦 **Multi-package Support**: Builds agent and proxy packages
- 🧪 **Automated Testing**: Tests package installation in Alpine containers
- 📊 **Gitea Integration**: Publishes packages to Gitea repository
## Quick Start
### 1. Repository Setup
```bash
# Clone this repository
git clone https://git.mbuz.uk/mbuz/Zabbix.git
cd zabbix-apk-builder
# Make build script executable
chmod +x build.sh
```
### 2. Manual Build
```bash
# Build packages locally
./build.sh
# Packages will be in ./packages/
ls -la packages/
```
### 3. CI/CD Setup
```bash
# Run the setup script
./setup-cicd.sh
# Follow the prompts to configure GitHub secrets
```
## Package Information
### Built Packages
1. **zabbix-agent** - Zabbix Agent only
2. **zabbix-proxy** - Zabbix Proxy
3. **zabbix** - Meta package
### Current Version
- **Zabbix Version**: 7.4.2
- **Alpine Base**: latest
- **Architecture**: all
## CI/CD Pipeline
### Automatic Triggers
- **Daily**: Checks for new Zabbix versions at 6 AM UTC
- **Push**: Builds when code changes in main/test branches
- **Manual**: Force builds via Gitea Actions
### Version Detection
Uses Zabbix Bitbucket API:
```bash
https://git.zabbix.com/rest/api/1.0/projects/ZBX/repos/zabbix/tags
```
### Pipeline Jobs
1. **check-version**: Detects new Zabbix releases
2. **update-version**: Updates APKBUILD automatically
3. **build-packages**: Builds APK packages
4. **publish-to-gitea**: Deploys to your repository
5. **deploy-test**: Tests installation (test branch)
## Configuration
### GitHub Secrets Required
```bash
GITEA_SSH_KEY # SSH private key for Gitea access
```
### File Structure
```
.
└── zabbix-git
└── zabbix-apk-builder
├── .gitea/workflows # Workflows for Gitea actions
├── .gitignore # Ignore files
├── APKBUILD # APKBUILD file for Zabbix
├── Dockerfile # Dockerfile for building packages
├── README.md # Project description
├── build.sh # Script for manual builds
├── packages/ # Directory for built packages
├── zabbix-agent.* # Agent configuration files
└── zabbix-proxy.* # Proxy configuration files
```
## Usage
### Install Packages
```bash
# Add repository
echo "http://gitea-repo/mbuz/Zabbix/raw/branch/main/alpine/v3.18/main" >> /etc/apk/repositories
# Update and install
apk update
apk add zabbix-agent
# Enable and start
rc-update add zabbix-agent default
rc-service zabbix-agent start
```
### Configuration
```bash
# Configure agent
vim /etc/zabbix/zabbix_agentd.conf
# Set server IP
Server=your.zabbix.server
# Restart service
rc-service zabbix-agent restart
```
## Development
### Local Testing
```bash
# Test build locally
./build.sh
# Test in Docker
docker run --rm -it \
-v $(pwd)/packages:/packages \
alpine:3.18 sh -c "
apk add --allow-untrusted /packages/zabbix-agent-*.apk
zabbix_agentd --version
"
```
### Branch Strategy
- **main**: Production releases, auto-deployed
- **test**: Testing and validation, no auto-deploy
### Making Changes
1. Create feature branch from `test`
2. Test changes thoroughly
3. Merge to `test` for CI validation
4. Merge to `main` for production release
## Troubleshooting
### Build Issues
```bash
# Check build logs
docker logs $(docker ps -l -q)
# Manual build debug
docker run -it --rm -v $(pwd):/build alpine:3.18 sh
cd /build && ./build.sh
```
### Version Detection
```bash
# Test API manually
curl -s "https://git.zabbix.com/rest/api/1.0/projects/ZBX/repos/zabbix/tags?limit=100" | \
jq -r '.values[].displayId' | \
grep -E '^[0-9]+\.[0-9]+\.[0-9]+
| \
sort -V | tail -1
```
## License
This project follows the same license as Zabbix (AGPLv3).
---