https://github.com/retigra/zabbixci
Tool to allow continuous integration of Zabbix assets.
https://github.com/retigra/zabbixci
git sync synchronization zabbix zabbix-templates
Last synced: about 1 month ago
JSON representation
Tool to allow continuous integration of Zabbix assets.
- Host: GitHub
- URL: https://github.com/retigra/zabbixci
- Owner: retigra
- License: agpl-3.0
- Created: 2024-12-02T11:44:27.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-03-07T07:51:21.000Z (8 months ago)
- Last Synced: 2025-04-02T08:04:55.385Z (8 months ago)
- Topics: git, sync, synchronization, zabbix, zabbix-templates
- Language: Python
- Homepage:
- Size: 1.62 MB
- Stars: 59
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
> [!WARNING]
> This project is under active development, the code in the main branch should
> be relatively stable but things might break every now and then. The releases
> that can be installed with `pip` are currently stable enough for testing. If
> you run into unexpected bugs, please create an
> [issue](https://github.com/retigra/ZabbixCI/issues/new). For questions about
> usage, please start a
> [discussion](https://github.com/retigra/ZabbixCI/discussions/new?category=q-a).
# ZabbixCI
ZabbixCI is a tool that adds continuous integration to Zabbix, allowing you to
synchronize Zabbix assets with a Git repository. By using the Zabbix API,
ZabbixCI can create, update, and delete assets across multiple Zabbix servers.
> [!NOTE]
> ZabbixCI has no affiliation with [Zabbix SIA](https://www.zabbix.com).
## Features
ZabbixCI provides the following features:
- Easily installable through pip or run it as a container image
- Fully configurable through cli arguments, config file and/or environment
variables
- Supports HTTP(S) and SSH auth for Git
- Export assets from Zabbix and push them to Git
- Pull assets from Git and import them in Zabbix
- Only changed or new assets will be processed during Git push or Zabbix import
actions
- Removes deleted assets automatically (unless black- or whitelisting is used)
- Use dry-run to verify behavior without changes to Zabbix or Git
- Build with parallelization in mind to speed up the process (can be scaled for
your needs)
- (Optional) Support for private CA servers to verify certificates
- (Optional) Allow black-/whitelisting of assets (supports regexp)
- (Optional) Use separate branches for push and pull transactions
### Additional template features
- Sync your templates with Git
- Built-in Zabbix version compatibility checking
- (Optional) Automatically populate empty vendor field with your own string
- (Optional) Allow automatic versioning of exported templates based on
timestamps
### Additional image (icons and backgrounds) features
- Sync your map images with Git
- Sync your icon-maps with Git
- Dynamically generate icons and backgrounds in predefined sizes
- Use `.png` or `.svg` files as sources for image generation
## Installation
ZabbixCI is available on [PyPI](https://pypi.org/project/zabbixci/) and can be
installed using pip:
```bash
pip install zabbixci
```
Alternatively, you can use a container image to run ZabbixCI, see the available
[container images](https://github.com/retigra/ZabbixCI/pkgs/container/zabbixci).
See the
[Containerized Deployment](https://github.com/retigra/ZabbixCI/blob/main/docs/Containerized.md)
documentation for more information.
## Configuration
ZabbixCI requires parameters to be set as command line arguments, a yaml
configuration or as environment variables. See the
[example configuration file](https://github.com/retigra/ZabbixCI/tree/main/docs/config.yaml).
We recommend passing environment variables when using the container image. Feel
free to use the method that best suits your workflow.
## Usage
We have a
[quickstart tutorial](https://github.com/retigra/ZabbixCI/tree/main/docs/tutorials/quickstart.md)
for first time users. Please see the
[Docs](https://github.com/retigra/ZabbixCI/tree/main/docs/README.md) for
extended details if needed.
# License
This project is licensed under AGPL-3.0, see
[LICENSE](https://github.com/retigra/ZabbixCI/tree/main/LICENSE.txt) for more
information.
# Contributing
Contributions are welcome! Please take a look at the following guidelines:
- Commit messages should follow the [Gitmoji](https://gitmoji.dev/) convention
or prefix with types (feat:, fix:, style:, etc.).
- The codebase uses [ruff](https://docs.astral.sh/ruff/) for formatting and
linting.
## Star History
> [!NOTE]
> If you like this project, please consider starring it on GitHub. ❤️
