Source control for Zabbix templates in Git
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
[!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
pipare currently stable enough for testing. If you run into unexpected bugs, please create an issue. For questions about usage, please start a discussion.
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.
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
.pngor.svgfiles as sources for image generation
Installation
ZabbixCI is available on PyPI and can be installed using pip:
pip install zabbixci
Alternatively, you can use a container image to run ZabbixCI, see the available container images. See the Containerized Deployment 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.
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 for first time users. Please see the Docs for extended details if needed.
License
This project is licensed under AGPL-3.0, see LICENSE for more information.
Contributing
Contributions are welcome! Please take a look at the following guidelines:
- Commit messages should follow the Gitmoji convention or prefix with types (feat:, fix:, style:, etc.).
- The codebase uses ruff for formatting and linting.
Star History
[!NOTE] If you like this project, please consider starring it on GitHub. ❤️
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file zabbixci-0.3.12.tar.gz.
File metadata
- Download URL: zabbixci-0.3.12.tar.gz
- Upload date:
- Size: 266.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a38a3b742b94d848201195b4d039344de5361e3573f55099299f51d45c0b73ca
|
|
| MD5 |
2a16325cc4cf595922be3b96e306417d
|
|
| BLAKE2b-256 |
8a7eea8102e6d2714ab61d7ac94963592046891bdb583e38607ccb375be4476e
|
Provenance
The following attestation bundles were made for zabbixci-0.3.12.tar.gz:
Publisher:
pypi.yaml on retigra/ZabbixCI
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
zabbixci-0.3.12.tar.gz -
Subject digest:
a38a3b742b94d848201195b4d039344de5361e3573f55099299f51d45c0b73ca - Sigstore transparency entry: 731991837
- Sigstore integration time:
-
Permalink:
retigra/ZabbixCI@72ee2b1f4bdf93deef83113b458a5baf0ff014cd -
Branch / Tag:
refs/tags/v0.3.12 - Owner: https://github.com/retigra
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yaml@72ee2b1f4bdf93deef83113b458a5baf0ff014cd -
Trigger Event:
release
-
Statement type:
File details
Details for the file zabbixci-0.3.12-py3-none-any.whl.
File metadata
- Download URL: zabbixci-0.3.12-py3-none-any.whl
- Upload date:
- Size: 50.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7f8e73a65dfa5374e1ebe191d1eaf06570080ddbf9d2398ad653fc722350d145
|
|
| MD5 |
8f286934c5c2d263a9ac850c95d4548b
|
|
| BLAKE2b-256 |
51ebef2a2781ce23b5e3fab1eef538dc77215354344511cf39465ced20361f0c
|
Provenance
The following attestation bundles were made for zabbixci-0.3.12-py3-none-any.whl:
Publisher:
pypi.yaml on retigra/ZabbixCI
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
zabbixci-0.3.12-py3-none-any.whl -
Subject digest:
7f8e73a65dfa5374e1ebe191d1eaf06570080ddbf9d2398ad653fc722350d145 - Sigstore transparency entry: 731991838
- Sigstore integration time:
-
Permalink:
retigra/ZabbixCI@72ee2b1f4bdf93deef83113b458a5baf0ff014cd -
Branch / Tag:
refs/tags/v0.3.12 - Owner: https://github.com/retigra
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yaml@72ee2b1f4bdf93deef83113b458a5baf0ff014cd -
Trigger Event:
release
-
Statement type:
