To ensure the Community template repository remains convenient and useful for all users, contributors must adhere to the practices outlined below.
Each template must reside in its own folder inside the appropriate category:
[a-zA-Z0-9_-]
.Template folder name requirements:
template_
(lowercase).^template_[.a-zA-Z0-9()_-]+$
.template_linux_services
. Bad example: template_microsoft_iis_7.5,_8.0,_8.5_and_10_services,_ports_and_performance_counters
.Separate subfolders must exist for each supported Zabbix version. The format for these version directories is X.X
, where X.X
refers to the major version (7.0
, 7.4
, etc.). Ensure that the template file inside each version folder is actually exported for that version of Zabbix. It is acceptable to skip some Zabbix versions if the template is identical across them (the template import is backwards compatible and you can import templates for previous versions into newer Zabbix version).
Each version folder must contain only:
^template_[.a-zA-Z0-9()_-]+\.(yaml|json|xml)$
.README.md
file (recommended):
README.md
and the template's internal description.files
folder:
node_exporter
repository for a Linux monitoring template) is acceptable, and can be noted in the README.md
.README.md
).Do not upload templates as compressed (e.g., .zip
, .tar.gz
) files.
files
folder or described clearly in the README.md
.template_name
├── 7.0
| ├── template_name.yaml
| ├── README.md
| ├── files
| | ├── other_files
| | ├── external_check.sh
| | ├── user_parameters.conf
| | ├── ...
├── 7.4
| ├── template_name.yaml
| ├── README.md
| ├── files
| | ├── other_files
| | ├── external_check.sh
| | ├── user_parameters.conf
| | ├── ...
Missing version directory:
template_name
├── template_name.yaml
├── README.md
├── files
| ├── other_files
| ├── external_check.sh
| ├── user_parameters.conf
| ├── ...
Multiple template files:
template_name
├── 7.0
| ├── template_name_1.yaml
| ├── template_name_2.yaml
| ├── template_name_3.yaml
| ├── README.md
| ├── files
| | ├── other_files
| | ├── external_check.sh
| | ├── user_parameters.conf
| | ├── ...
Compressed files are not allowed:
template_name
├── 7.0
| ├── template_name.zip
All files in the same directory:
template_name
├── 7.0
| ├── template_name.yaml
| ├── README.md
| ├── external_check.sh
| ├── script.py
| ├── user_parameters.conf