Close
Log in to Zabbix Blog
Email
Password
Show password Hide password
Forgot password?
Incorrect e-mail and/or password
or
By creating an account or logging in with an existing account, you agree to our Terms of Service
Как сделатьТехнический постВойти

NetBox и Zabbix — интеграция, которая идеально подходит

Если вы используете Zabbix, то знаете, каким утомительным может быть добавление узлов сети, привязка шаблонов и (что еще сложнее) поддержание соответствия вашей CMDB. А если у вас уже есть CMDB? В таком случае вам нужно синхронизировать CMDB с Zabbix… вручную? Конечно же нет! Прежде чем продолжить — и этот пост в блоге, и плагин принадлежат […]

Если вы используете Zabbix, то знаете, каким утомительным может быть добавление узлов сети, привязка шаблонов и (что еще сложнее) поддержание соответствия вашей CMDB. А если у вас уже есть CMDB? В таком случае вам нужно синхронизировать CMDB с Zabbix… вручную? Конечно же нет!

Прежде чем продолжить — и этот пост в блоге, и плагин принадлежат Opensource ICT Solutions. Мы специализируемся на Zabbix (это наш основной бизнес!) и, соответственно, стараемся зарабатывать на этом продукте с открытым исходным кодом. Плагин, о котором пойдет речь, имеет открытый исходный код, поэтому коммерческой выгоды мы от него не получаем — мы предлагаем его вам, чтобы отблагодарить сообщество (и, возможно, получить заказы на консалтинг).

Если вы уже знакомы с NetBox, самое время порадоваться. Если нет — NetBox предоставляет мощный «single source of truth» для управления всем, что есть в вашей сети: управление IP-адресами (IPAM), управление инфраструктурой центров обработки данных (DCIM), инвентаризация устройств, размещение оборудования в стойках, кабельные соединения, виртуальные ресурсы и многое другое. NetBox распространяется по лицензии Apache 2.0, поэтому исходный код основного программного обеспечения полностью открыт, а активное сообщество создает для него плагины, интеграции и пользовательские расширения. Платформа очень гибкая: можно добавлять настраиваемые поля, применять собственные правила проверки и защиты, выполнять интеграцию через REST и GraphQL API и запускать множество сценариев автоматизации.

Как было бы здорово использовать это вместе с Zabbix: создавать новую сущность в CMDB (вашем single source of truth), синхронизировать ее с Zabbix и, сосредоточившись только на одном продукте, всегда быть уверенными в полноте мониторинга?

Какую задачу мы решаем?

Многие наши клиенты используют NetBox в качестве CMDB, а Zabbix — в качестве решения для мониторинга. Сложность, с которой они сталкиваются, состоит в синхронизации NetBox и Zabbix, а такую задачу инженеры обычно не любят.

У клиентов, которые не используют CMDB (или, по крайней мере, не NetBox), всегда остается неуверенность в том, применены ли к узлу сети в Zabbix нужные шаблоны и макросы. Хотя Zabbix позволяет выполнять массовое обновление, для поддержания согласованности все равно нужно детально знать роль каждого устройства.

NetBox, напротив, уже хранит гораздо более полный контекст о конфигурационных единицах. Для устройства или виртуальной машины можно задать роль, тип устройства, собственника и даже площадку или локацию. Не хватает лишь способа использовать эту информацию, чтобы мониторинг этих устройств в Zabbix выполнялся правильно.

Кроме того, такой подход все упрощает: если устройство зарегистрировано в CMDB (а значит, вы за него отвечаете), то и его мониторинг выполняется правильно. С точки зрения реализации проектов документирование нужно выполнить только один раз, и такой подход гарантирует, что оно действительно будет выполнено. Короче говоря: если устройства нет в CMDB, его мониторинг не ведется — а значит, оно и не входит в нашу зону ответственности.

Это также означает, что инженерам, реализующим проект, не обязательно глубоко разбираться в работе Zabbix: достаточно уметь заполнять CMDB — мониторинг будет обеспечен автоматически.

Что мы разработали?

Если коротко — нативный плагин для NetBox, который взаимодействует с Zabbix API. Через API плагин собирает такую информацию, как шаблоны и макросы, существующие в вашей среде Zabbix. Все полностью основано на API, поэтому в NetBox достаточно добавить новый сервер Zabbix и дать ему синхронизироваться:

Zabbix netbox sync
Снимок экрана: новый сервер Zabbix в NetBox

На этом этапе не происходит ничего особенного. Просто устанавливается соединение и синхронизируются шаблоны, макросы и т. д. Остальная настройка выполняется в вашем экземпляре NetBox.

Как это выглядит?

 

 

Здесь есть обычные/встроенные пункты меню NetBox, и для тех, кто уже знаком с NetBox, в списке ниже нет ничего нового, кроме пункта «Zabbix»:

  • Organization — определение площадок, локаций и собственников для структурирования инфраструктуры
  • Racks — управление физическими стойками и размещением оборудования в них в центрах обработки данных
  • Devices — инвентаризация физических и виртуальных устройств, таких как серверы, маршрутизаторы и коммутаторы
  • Connections — моделирование физических кабельных и логических соединений между устройствами
  • Wireless — управление беспроводными LAN, SSID и связанным оборудованием
  • IPAM — управление IP-адресами: подсети, префиксы, IP-адреса и VRF
  • VPN — настройка туннелей, пиров и точек подключения VPN
  • Virtualization — учет кластеров, виртуальных машин и виртуальных интерфейсов
  • Circuits — управление каналами связи провайдеров, WAN-соединениями и связанными договорами
  • Power — определение кабелей питания, распределительных щитов и подключений к розеткам.
  • Provisioning — поддержка построения и автоматизации ввода устройств/сервисов в эксплуатацию
  • Customization — расширение NetBox с помощью настраиваемых полей, правил и доработок интерфейса
  • Operations — инструменты для рабочих процессов, задач и операционной деятельности
  • Admin — административные настройки пользователей, групп и глобальной конфигурации

Новым здесь является меню Zabbix, и именно оно позволяет управлять тем, что есть в Zabbix. Объекты в нем должны быть знакомы тем, кто знает Zabbix:

  • Servers
  • Proxies
  • Proxy Groups
  • Templates
  • Macros
  • Tags
  • Hostgroups
  • Maintenance

NetBox menu including Zabbix
Меню NetBox с плагином Zabbix

В различных встроенных объектах NetBox будет отображаться информация о настройке Zabbix.

Это уже доступно?

Конечно, иначе этот пост в блоге был бы совершенно бесполезен! Установить плагин можно через https://pypi.org/project/nbxsync.

Мы выпустили наш плагин для NetBox под лицензией GNU Affero General Public License v3 (AGPL-3.0), поскольку она лучше всего защищает и нашу работу, и сообщество. В отличие от пермиссивных лицензий, AGPL гарантирует, что любой, кто изменяет или расширяет плагин, должен делиться своими изменениями на условиях той же лицензии, даже если программное обеспечение предоставляется только как сервис. Это исключает появление закрытых форков, гарантирует, что улучшения возвращаются в сообщество, и соответствует духу сотрудничества NetBox и Zabbix.

Хотя AGPL по-прежнему допускает использование в коммерческой среде, она не позволяет организациям извлекать прибыль из закрытых доработок, ничего не отдавая взамен. Короче говоря, AGPL-3.0 обеспечивает честность, прозрачность и подлинную открытость исходного кода плагина. Эту же лицензию использует и Zabbix, поэтому сообщество с ней уже знакомо.

Мы открыли исходный код и опубликовали его на GitHub Opensource ICT Solutions, найти его можно здесь: https://github.com/OpensourceICTSolutions/nbxsync

Мы считаем документацию важной, поскольку сами часто оказывались в ситуации, когда из-за ее отсутствия приходилось самостоятельно разбираться, как что-то работает. Мы очень стараемся избавить вас от такой ситуации и поэтому создали для этого проекта подробную документацию. Разумеется, мы можем помочь, если вы запутаетесь, но поскольку это тоже отнимает наше время, такая помощь не будет бесплатной. Документация доступна здесь: https://nbxsync.com.

Мы считаем, что совместная работа над проектом — это здорово, поэтому приветствуем вклад сообщества. Однако, чтобы мы могли принять pull request, сначала создайте issue в нашем репозитории на GitHub. Обязательно ознакомьтесь с нашими правилами разработки и учтите, что мы будем рады включить предложения/pull request, если они принесут пользу широкому сообществу.

Можно ли настроить его самостоятельно?

Да. Будем считать, что NetBox у вас уже развернут. Если нет, установите его по официальной документации NetBox: https://netboxlabs.com/docs/netbox/installation/.

Поскольку это нативный плагин, его установка проста и хорошо описана в документации NetBox: https://netboxlabs.com/docs/netbox/plugins/installation/. В нашей документации описана настройка, специфичная для плагина. Если это кажется вам сложным, мы с радостью поможем в рамках наших консалтинговых услуг.

Итак, NetBox развернут, плагин установлен — давайте пройдемся по настройке NetBox, чтобы вы получили представление о том, как все работает. В качестве основы в NetBox придется настроить довольно много, но, надеемся, это уже сделано, если NetBox внедрен в вашей организации.

В любом случае нам нужно добавить один или несколько новых серверов Zabbix. Открываем меню Zabbix, нажимаем «Servers» и добавляем там этот сервер:

NetBox Zabbix Server configuration
Настройка сервера Zabbix в NetBox

После добавления сервера NetBox автоматически синхронизируется с ним и получает из него шаблоны, готовые к использованию! Вместе с шаблонами синхронизируются и макросы, поэтому они тоже будут доступны в NetBox.

NetBox требует, чтобы устройства находились на площадке, поэтому начнем с нее. В разделе Organization → Sites создаем новую площадку. Несколько полей обязательны, они заполнены на снимке экрана ниже:

NetBox Sites Configuration
Настройка площадок в NetBox

Обязательны поля Name, Slug и Status. В рабочей среде вы, вероятно, захотите заполнить и некоторые другие поля, например Tenant, Region и т. д. Но мы пишем не руководство по NetBox, поэтому полностью опустим эту часть. Закончив, нажмите «Create» внизу страницы настройки.

После создания площадки пора добавить производителя в меню «Devices».

В данном случае добавим Cisco в качестве производителя:

Netbox Manufacturers configuration
Настройка производителей в NetBox

Закончив, нажмите «Create» внизу страницы настройки. Конечно, вы можете (и даже должны) добавить нескольких производителей — всех, которых вы фактически используете!

Следующий шаг — тип устройства. В конечном счете нам нужно знать производителя, но не менее важно знать, для какого типа устройства мы выполняем мониторинг. Поэтому следующим шагом добавим тип устройства, снова в главном меню «Devices». В нашем примере мы добавим коммутатор CBS220:

NetBox device type configuration
Настройка типа устройства в NetBox

Закончив, снова нажмите «Create».

И последнее, но не менее важное: нужно добавить роль устройства. Роль устройства — важный атрибут, поскольку она помогает четко определить функцию устройства в сети. Распределяя устройства по категориям в зависимости от их роли (например, маршрутизатор, коммутатор, межсетевой экран, сервер или точка доступа), мы получаем структурированное представление, которое значительно упрощает управление средой, ее мониторинг и устранение неполадок. Назначение ролей также обеспечивает согласованность, повышает качество документации и позволяет быстро определять назначение каждого устройства в крупных инфраструктурах.

Переходим в «Devices» → Device roles и далее:

NetBox Device Role
Роль устройства в NetBox

Теперь наконец можно добавить само устройство! Ради этого все и затевалось — вся предыдущая работа на самом деле лишь закладывала основу для этого момента. Мы добавляем устройство, которое в итоге станет узлом сети в Zabbix, со всеми связанными свойствами, переданными из конфигурации NetBox.

Переходим в Devices → Devices и добавляем его там:

NetBox Device configuration
Настройка устройства в NetBox (часть полей не показана)

После того как мы сохраним устройство, нажав «Create», NetBox сразу откроет страницу сведений о только что созданном устройстве. Здесь можно увидеть обзор всей только что введенной информации, например имя устройства, роль, площадку, положение в стойке и другие атрибуты. Эта страница служит центральной точкой для управления конфигурацией устройства и ее расширения.

Отсюда можно добавлять интерфейсы, назначать IP-адреса, подключать кабели или связывать устройство с виртуальными ресурсами. Другими словами, после создания запись об устройстве становится основой для документирования его места и функции в сети.

NetBox device overview
Обзор устройства в NetBox с параметрами Zabbix

На этом снимке экрана уже видно, что появилась новая вкладка «Zabbix» (прямо под именем устройства), а также новая кнопка «Sync Zabbix».

На вкладке «Zabbix» нужно назначить это устройство серверу Zabbix, поскольку по умолчанию оно не назначено ни одному серверу. Это может показаться немного странным, особенно если у вас один сервер Zabbix. Однако при разработке мы исходили из того, что NetBox обычно используют MSP, у которых несколько серверов Zabbix и которым по эксплуатационным причинам может даже понадобиться назначить этому устройству несколько серверов Zabbix.

Открываем вкладку «Zabbix» и нажимаем «Add» рядом с Zabbix Servers. Открывается новая страница настройки, на которой мы выбираем только что добавленный сервер:

NetBox Zabbix server assignment
Назначение сервера Zabbix в NetBox

После нажатия «Create» сервер будет назначен. Конечно, можно добавить к нему шаблон, но раз производитель и тип нам уже известны, должно работать наследование!

Вернемся в Device → Manufacturers и нажмем на только что добавленного производителя (Cisco). Нажмите на имя, и вы увидите, что у этого объекта тоже появилась новая вкладка «Zabbix». На этой вкладке можно настроить, какие шаблоны, группы узлов сети, теги и макросы всегда должны использоваться для этого производителя. Здесь мы просто добавим шаблон для этого производителя, чтобы показать наследование:

Netbox template inheritance
Наследование шаблонов в NetBox

После нажатия Create вернитесь к созданному устройству и посмотрите, как наследуется шаблон. Поскольку Zabbix также требует наличия группы узлов сети и интерфейса, настроим их сейчас.

Начнем с группы узлов сети: нажмите Zabbix -> Hostgroups. Там создадим новую группу, как показано на снимке экрана ниже. В нашей конфигурации есть кое-что необычное: вместо статических имен мы используем шаблоны Jinja2.

Имя объекта — «Device site», но фактическим значением станет имя ранее созданной площадки (OICTS HQ). Вся сила здесь в переменных: если мы создадим новое устройство для другой площадки и свяжем с ним эту группу узлов сети, она автоматически получит правильное имя площадки, и статическая настройка больше не понадобится!

Разумеется, группу узлов сети снова нужно назначить серверу Zabbix:

NetBox Zabbix hostgroups
Группы узлов сети Zabbix в NetBox

Следующий шаг — создать интерфейс узла сети Zabbix, который необходим для мониторинга и связи между Zabbix и устройством. Для этого мы используем функциональность IPAM (управление IP-адресами) в NetBox.

IPAM обеспечивает структурированный способ управления адресами и их распределения в сети, гарантируя согласованность и предотвращая конфликты. В данном случае переходим в IPAM → IP Addresses и добавляем новый IP-адрес, который будет служить интерфейсом управления устройства. Позже этот IP-адрес будет связан с конфигурацией узла сети в Zabbix, что обеспечит беспрепятственную передачу данных мониторинга.

NetBox IPAM config - IP address
Настройка IPAM в NetBox — IP-адрес

Если теперь вернуться в Devices -> устройство, которое нужно настроить, → вкладка «Zabbix», нужно добавить интерфейс узла сети и группу узлов сети. Нажмите Add в соответствующем разделе настройки и заполните минимально необходимые поля. Для интерфейсов узла сети это выглядит так:

NetBox Zabbix host Interface
Интерфейс узла сети Zabbix в NetBox

Для группы узлов сети нужно заполнить меньше полей, чем для других объектов. Достаточно выбрать подходящую группу из доступных вариантов. Это упрощает процесс и избавляет от лишней настройки.

После сохранения группа узлов сети будет правильно связана и готова к использованию в Zabbix:

NetBox Zabbix hostgroups
Группы узлов сети Zabbix в NetBox

Окончательный результат выглядит так. На этом этапе все необходимые элементы настроены в NetBox и правильно связаны со средой Zabbix. Устройству теперь назначены группа узлов сети, интерфейс узла сети и шаблоны, что дает полную картину того, как оно будет представлено в мониторинге.

По сути, здесь мы видим итог всех предыдущих шагов настройки: NetBox выступает в роли single source of truth, а Zabbix автоматически наследует правильную конфигурацию.

NetBox Zabbix device overview
Обзор устройства Zabbix в NetBox

Теперь пора синхронизировать устройство с Zabbix. В верхней части страницы сведений об устройстве, прямо рядом с его именем, есть кнопка «Sync Zabbix». При нажатии этой кнопки NetBox передаст всю настроенную нами информацию, такую как интерфейсы, шаблоны и группы узлов сети, непосредственно в Zabbix.

Через несколько секунд узел сети будет создан и полностью готов к мониторингу без какой-либо ручной настройки в Zabbix. Поскольку вся тяжелая работа автоматизирована, можно расслабиться, зная, что устройство синхронизировано правильно.

А теперь давайте перейдем в Zabbix и убедимся, что синхронизация выполнена:

Zabbix host overview from NetBox
Обзор узла сети Zabbix из NetBox

Отлично! Узел сети на месте, шаблон привязан, в качестве группы узлов сети автоматически задана «OICTS HQ», и интерфейс тоже выглядит правильно. Мониторинг начнется, а мы даже не прикасались к самому Zabbix!

Хотите увидеть, как это работает?

Легко! Мы подготовили видео на YouTube, чтобы вы могли своими глазами увидеть, как все работает. Кроме того, мы планируем провести вебинары, посвященные этому плагину. Зарегистрироваться на все наши вебинары можно бесплатно на сайте Zabbix.

И это все?

Нет! На самом деле с этим плагином для NetBox можно сделать гораздо больше, просто этот пост в блоге — не подходящее место, чтобы показать все. Чтобы вы получили представление: из NetBox можно настраивать обслуживание, которое будет автоматически синхронизироваться с Zabbix. Так у нас снова есть single source of truth, и мы можем с высоты птичьего полета видеть, на что это влияет.

Кроме того, можно настроить автоматическую синхронизацию, чтобы любые изменения в Zabbix перезаписывались конфигурацией NetBox. Так мы исключаем расхождения между NetBox и Zabbix. Это также гарантирует, что ничего страшного не произойдет, если инженеры забудут выполнить синхронизацию вручную. Тем не менее кнопка ручной синхронизации всегда останется, ведь никто не хочет ждать, чтобы исправить мониторинг после внесения изменений!

Помимо этого, плагин полностью поддерживает прокси и группы прокси — точно в том виде, в каком вы знаете их по Zabbix. Мы просто не стали показывать это здесь, чтобы статья не получилась слишком длинной.

План развития

Хотя этот проект для нас лишь побочный (свои ресурсы мы по-прежнему посвящаем Zabbix), у нас, конечно, есть видение и план развития, которым мы хотели бы следовать.

Одна из главных функций в плане развития — отображение проблем узлов сети в NetBox. Получая текущие проблемы заданного узла сети и показывая их в NetBox, мы сможем еще больше сократить время, проводимое в Zabbix. Наша цель — реализовать «единый интерфейс» (так же, как NetBox является «Single Source of Truth»).

Prev Post Prev Post Next Post Next Post
Подписаться
Уведомить о
0 Comments
Старые
Новые Популярные
0
Оставьте комментарий! Напишите, что думаете по поводу статьи.x