NetBox::Zabbix integráció

Innen: Farkas Attila Wiki
Ugrás a navigációhoz Ugrás a kereséshez

Megjegyzés: ez az oldal szándékosan nincs a menüből közvetlenül linkelve - a NetBox és a Zabbix oldalakról hivatkozunk rá, mint a két rendszer gyakorlati összekötésének részletes leírására.

Miért kell összekötni a kettőt?

A NetBox tudja, minek kellene létezni a hálózaton (SoT) - a Zabbix azt figyeli, mi létezik és hogy viselkedik ténylegesen. Ha ezt a két host-listát kézzel, párhuzamosan tartjuk karban, előbb-utóbb szétcsúsznak: felveszünk egy routert a NetBox-ba, de elfelejtjük a Zabbix-ba is; vagy leszerelünk egy szervert, ami a Zabbix-ban "monitorozott, de már nem létező" hostként árválkodik tovább. A cél, hogy a Zabbix host-listája automatikusan, egy irányban kövesse a NetBox-ban rögzített adatokat.

Az integráció elve

   NetBox (SoT: eszköz létrehozva/módosítva/törölve)
        |
        | Webhook (HTTP POST-esemény egy általunk megadott címre)
        v
   Szinkronizáló szolgáltatás/szkript
        |
        | Zabbix API-hívás (host.create / host.update / host.delete)
        v
   Zabbix (host-lista mindig a NetBox aktuális állapotát tükrözi)

A NetBox Webhooks funkciója konfigurálható úgy, hogy egy adott esemény (pl. "device" objektum létrehozása/módosítása a DCIM-ben) esetén HTTP POST-ot küldjön egy általunk megadott URL-re, a változott objektum adataival (JSON). Egy ezt fogadó, kis szolgáltatás/szkript ezt lefordítja a Zabbix JSON-RPC API megfelelő hívására (lásd a host.create példát a Zabbix oldalon). Az elvet több közösségi projekt (pl. a nyílt forráskódú netbox-zabbix-sync) is pontosan így implementálja - a lényeg nem a konkrét eszköz, hanem a "webhook → fordítás → cél-API hívás" minta, ami tetszőleges hasonló integrációra (pl. NetBox → Nagios, NetBox → Prometheus service-discovery) újrafelhasználható.

Fontos irány: az adatáramlás egyirányú - a NetBox-ból a Zabbix felé. A Zabbix-ban mért élő állapot (pl. hogy egy host éppen elérhető-e) soha nem írja felül a NetBox-ban rögzített, tervezett/adminisztratív adatokat - a két rendszer szerepe emiatt marad tiszta és nem keveredik össze.

Példa: router-konfiguráció generálása a SoT-ból és kiosztása Ansible-lel

A NetBox gyakorlati hasznának másik, a fentitől független példája, amikor nem egy másik rendszer host-listáját, hanem egy eszköz konfigurációját állítjuk elő a benne rögzített adatokból - pl. MikroTik routerek alapkonfigurációját.

   NetBox (SoT: eszközök, interfészek, IP-címek)
        |
        | pynetbox API-hívás
        v
   Python generátor script + Jinja2 sablon
        |
        | legenerált, eszközönkénti .rsc fájlok
        v
   Ansible playbook (megadott host lista alapján)
        |
        | SSH (community.routeros collection)
        v
   MikroTik routerek (a generált konfiguráció importálva)

1. lépés - Jinja2 sablon a RouterOS-szkripthez

{# templates/mikrotik.rsc.j2 #}
/system identity set name={{ device.name }}
{% for iface in device.interfaces %}
/ip address add address={{ iface.ip }} interface={{ iface.name }}
{% endfor %}

2. lépés - a NetBox-ból a sablonba: Python generátor script

import pynetbox
from jinja2 import Environment, FileSystemLoader

nb = pynetbox.api("https://netbox.example.com", token="NETBOX_API_TOKEN")
env = Environment(loader=FileSystemLoader("templates"))
template = env.get_template("mikrotik.rsc.j2")

# Csak a "router" szerepű, MikroTik gyártmányú eszközök a NetBox-ból
for dev in nb.dcim.devices.filter(role="router", manufacturer="mikrotik"):
    interfaces = []
    for iface in nb.dcim.interfaces.filter(device_id=dev.id):
        ip = nb.ipam.ip_addresses.filter(interface_id=iface.id)
        if ip:
            interfaces.append({"name": iface.name, "ip": str(ip[0])})

    rendered = template.render(device={"name": dev.name, "interfaces": interfaces})
    with open(f"generated/{dev.name}.rsc", "w") as f:
        f.write(rendered)

A script minden, a NetBox-ban "router" szerepkörrel és "mikrotik" gyártóval rögzített eszközhöz legenerál egy önálló, névre szóló .rsc (RouterOS-szkript) fájlt a generated/ mappába - a tartalma kizárólag a NetBox-ban rögzített adatokból (eszköznév, interfészek, IP-címek) épül fel.

3. lépés - a megadott host lista (Ansible inventory)

# hosts.ini
[mikrotik_routers]
router01 ansible_host=192.168.1.1
router02 ansible_host=192.168.1.2

[mikrotik_routers:vars]
ansible_user=admin
ansible_connection=network_cli
ansible_network_os=community.routeros.routeros

Megjegyzés: ez itt egy egyszerű, statikus hoszt-lista - ha a kiosztást is a NetBox-ból szeretnénk vezérelni (ne kelljen a hoszt-listát is kézzel karbantartani), ugyanerre a szerepre a korábban (lásd a NetBox oldalon) említett netbox.netbox gyűjtemény nb_inventory dinamikus inventory-pluginja is bevethető - ez esetben a "megadott host lista" maga is élőben, a NetBox API-ból jönne.

4. lépés - Ansible playbook: feltöltés és alkalmazás SSH-n keresztül

# deploy_mikrotik.yml
---
- name: Generált RouterOS-konfiguráció kiosztása SSH-n keresztül
  hosts: mikrotik_routers
  gather_facts: no
  tasks:
    - name: Legenerált script feltöltése a routerre
      ansible.netcommon.net_put:
        src: "generated/{{ inventory_hostname }}.rsc"
        dest: "{{ inventory_hostname }}.rsc"

    - name: Feltöltött script importálása/alkalmazása
      community.routeros.command:
        commands:
          - "/import file-name={{ inventory_hostname }}.rsc"

Futtatás (a community.routeros gyűjtemény telepítése után):

ansible-galaxy collection install community.routeros ansible.netcommon
ansible-playbook -i hosts.ini deploy_mikrotik.yml

A net_put modul SSH-n (SFTP-n) keresztül felmásolja a router saját fájltárolójába a hozzá tartozó, a 2. lépésben legenerált .rsc fájlt, a community.routeros.command pedig - szintén SSH-n keresztül - kiadja a /import parancsot, ami ténylegesen végrehajtja a feltöltött szkript tartalmát a routeren.

Az egész lánc összefoglalva

  • A NetBox rögzíti, milyen routereknek, interfészeknek, IP-címeknek kellene léteznie - ez az egyetlen hely, ahol ezt az adatot kézzel karbantartjuk.
  • A Python + Jinja2 pár ebből az adatból, automatikusan állít elő eszközönkénti, kész RouterOS-szkripteket - nem kell kézzel írni/másolni egyetlen konfigurációs sort sem.
  • Az Ansible (a community.routeros gyűjteménnyel) a megadott host-lista minden elemére SSH-n keresztül feltölti és alkalmazza is ezt a szkriptet.
  • Ugyanez az elv (NetBox → generátor/webhook → cél-rendszer API-hívása) áll a fentebb tárgyalt Zabbix-szinkron mögött is - csak ott a "cél-rendszer" nem egy router, hanem maga a Zabbix.