From 4b8c91d957966a4694eabe307fd3accbd89da464 Mon Sep 17 00:00:00 2001 From: Maksym Buz Date: Wed, 3 Sep 2025 19:27:33 +0200 Subject: [PATCH] CHANGE: Readme adjusted --- zabbix-apk-builder/README.md | 82 +++++++++--------------------------- 1 file changed, 21 insertions(+), 61 deletions(-) diff --git a/zabbix-apk-builder/README.md b/zabbix-apk-builder/README.md index d558df0..e9e58fc 100644 --- a/zabbix-apk-builder/README.md +++ b/zabbix-apk-builder/README.md @@ -7,9 +7,9 @@ Automated Alpine Linux package builder for Zabbix Agent and Proxy with CI/CD pip - ๐Ÿ”„ **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, proxy, and main packages +- ๐Ÿ“ฆ **Multi-package Support**: Builds agent and proxy packages - ๐Ÿงช **Automated Testing**: Tests package installation in Alpine containers -- ๐Ÿ“Š **Gitea Integration**: Publishes packages to your private Gitea repository +- ๐Ÿ“Š **Gitea Integration**: Publishes packages to Gitea repository ## Quick Start @@ -17,11 +17,11 @@ Automated Alpine Linux package builder for Zabbix Agent and Proxy with CI/CD pip ```bash # Clone this repository -git clone +git clone https://git.mbuz.uk/mbuz/Zabbix.git cd zabbix-apk-builder # Make build script executable -chmod +x build.sh setup-cicd.sh +chmod +x build.sh ``` ### 2. Manual Build @@ -48,19 +48,14 @@ ls -la packages/ ### Built Packages 1. **zabbix-agent** - Zabbix Agent only -2. **zabbix-proxy** - Zabbix Proxy (without LDAP) -3. **zabbix** - Main package with libraries +2. **zabbix-proxy** - Zabbix Proxy +3. **zabbix** - Meta package ### Current Version - **Zabbix Version**: 7.4.2 -- **Alpine Base**: 3.18 -- **Architecture**: x86_64 - -### Dependencies Removed - -- LDAP support removed from proxy build -- Simplified configuration for smaller footprint +- **Alpine Base**: latest +- **Architecture**: all ## CI/CD Pipeline @@ -68,7 +63,7 @@ ls -la packages/ - **Daily**: Checks for new Zabbix versions at 6 AM UTC - **Push**: Builds when code changes in main/test branches -- **Manual**: Force builds via GitHub Actions +- **Manual**: Force builds via Gitea Actions ### Version Detection @@ -97,15 +92,17 @@ GITEA_SSH_KEY # SSH private key for Gitea access ``` . -โ”œโ”€โ”€ APKBUILD # Alpine package definition -โ”œโ”€โ”€ build.sh # Build automation script -โ”œโ”€โ”€ Dockerfile # Build environment -โ”œโ”€โ”€ .github/workflows/ # CI/CD pipeline -โ”œโ”€โ”€ packages/ # Built packages -โ”œโ”€โ”€ zabbix-agent.initd # Agent init script -โ”œโ”€โ”€ zabbix-agent.confd # Agent config -โ”œโ”€โ”€ zabbix-proxy.initd # Proxy init script -โ””โ”€โ”€ zabbix-proxy.confd # Proxy config +โ””โ”€โ”€ 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 @@ -191,45 +188,8 @@ curl -s "https://git.zabbix.com/rest/api/1.0/projects/ZBX/repos/zabbix/tags?limi sort -V | tail -1 ``` -### CI/CD Issues - -1. Check GitHub Actions logs -2. Verify SSH key permissions -3. Test Gitea connectivity -4. Validate APKBUILD syntax - -## Documentation - -- **[CI-CD-DOCS.md](CI-CD-DOCS.md)**: Comprehensive CI/CD documentation -- **[setup-cicd.sh](setup-cicd.sh)**: Setup script for CI/CD configuration - -## Security - -- Uses SSH keys for Gitea access -- Minimal package dependencies -- Regular security updates via automated builds -- No secrets stored in repository - -## Contributing - -1. Fork the repository -2. Create feature branch -3. Test changes in `test` branch -4. Submit pull request to `main` - ## License -This project follows the same license as Zabbix (GPL v2). - -## Support - -For issues: -1. Check troubleshooting section -2. Review CI/CD logs -3. Test manual build process -4. Check Zabbix API connectivity +This project follows the same license as Zabbix (AGPLv3). --- - -**Built with โค๏ธ for Alpine Linux and Zabbix monitoring** -# Workflow test - Wed Sep 3 19:02:19 CEST 2025