NetBox docker-compose: установка NetBox в Docker

Обновлено и опубликовано Опубликовано:

Используемые термины: NetBox, Docker, Linux.

В этой инструкции разберем установку NetBox через docker-compose — от подготовки окружения до создания первого администратора. Процесс, который в англоязычных источниках часто называют install netbox docker-compose, займет один запуск контейнеров и пару вспомогательных команд.

Разворачивать NetBox будем на основе официального проекта netbox-docker. Сам файл docker-compose.yml и весь набор конфигураций лежат в репозитории на GitHub.

Пример файла docker-compose

Создадим каталог для проекта и перейдем в него:

mkdir -p /opt/netbox && cd /opt/netbox

Теперь создадим docker-compose.yml, где опишем Traefik, PostgreSQL, Redis и само приложение NetBox:

vi docker-compose.yml

services:

  netbox-traefik:
    image: traefik:${TRAEFIK_VER}
    container_name: netbox-traefik
    hostname: netbox-traefik
    restart: unless-stopped
    environment:
      TZ: ${TZONE}
    command:
      - "--ping=true"
      - "--api.insecure=false"
      - "--providers.docker=true"
      - "--providers.docker.exposedbydefault=false"
      - "--entrypoints.web.address=:80"
    ports:
      - "80:80"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
    healthcheck:
      test: ["CMD-SHELL", "traefik healthcheck --ping"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 5s

  netbox-postgres:
    image: postgres:${DB_VER}
    container_name: netbox-postgres
    hostname: netbox-postgres
    restart: unless-stopped
    environment:
      TZ: ${TZONE}
      POSTGRES_DB: ${DB_NAME}
      POSTGRES_PASSWORD: ${DB_PASS}
      POSTGRES_USER: ${DB_USER}
    volumes:
      - ./postgres/data:/var/lib/postgresql
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U ${DB_USER} -d ${DB_NAME}"]
      interval: 5s
      timeout: 5s
      retries: 5

  netbox-redis:
    image: valkey/valkey:${REDIS_VER}
    container_name: netbox-redis
    hostname: netbox-redis
    restart: unless-stopped
    environment:
      TZ: ${TZONE}
      REDIS_PASSWORD: ${REDIS_PASS}
    command:
      - sh
      - -c
      - valkey-server --appendonly yes --requirepass $$REDIS_PASSWORD
    volumes:
      - ./redis/data:/data
    healthcheck:
      test: ["CMD-SHELL", "valkey-cli --pass $$REDIS_PASSWORD ping"]
      start_period: 5s
      timeout: 3s
      interval: 1s
      retries: 5

  netbox-redis-cache:
    image: valkey/valkey:${REDIS_VER}
    container_name: netbox-redis-cache
    hostname: netbox-redis-cache
    restart: unless-stopped
    environment:
      TZ: ${TZONE}
      REDIS_PASSWORD: ${REDIS_PASS}
    command:
      - sh
      - -c
      - valkey-server --requirepass $$REDIS_PASSWORD
    volumes:
      - ./redis/cache:/data
    healthcheck:
      test: ["CMD-SHELL", "valkey-cli --pass $$REDIS_PASSWORD ping"]
      start_period: 5s
      timeout: 3s
      interval: 1s
      retries: 5

  netbox-app:
    image: netboxcommunity/netbox:${NBX_VER}
    container_name: netbox-app
    hostname: netbox-app
    restart: unless-stopped
    environment:
      TZ: ${TZONE}
      DB_NAME: ${DB_NAME}
      DB_USER: ${DB_USER}
      DB_PASSWORD: ${DB_PASS}
      DB_HOST: netbox-postgres
      DB_PORT: 5432
      REDIS_HOST: netbox-redis
      REDIS_PORT: 6379
      REDIS_PASSWORD: ${REDIS_PASS}
      SECRET_KEY: ${SECRET_KEY}
    depends_on:
      netbox-postgres:
        condition: service_healthy
      netbox-redis:
        condition: service_healthy
      netbox-redis-cache:
        condition: service_healthy
    expose:
      - 8080
    volumes:
      - ./app/configuration:/etc/netbox/config:z,ro
      - ./app/media:/opt/netbox/netbox/media:rw
      - ./app/reports:/opt/netbox/netbox/reports:rw
      - ./app/scripts:/opt/netbox/netbox/scripts:rw
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.netbox.rule=Host(`${DOMAIN}`)"
      - "traefik.http.routers.netbox.entrypoints=web"
      - "traefik.http.services.netbox.loadbalancer.server.port=8080"
    healthcheck:
      test: ["CMD-SHELL", "curl -f http://localhost:8080/login/"]
      start_period: 90s
      timeout: 3s
      interval: 15s
      
  netbox-worker:
    image: netboxcommunity/netbox:${NBX_VER}
    container_name: netbox-worker
    hostname: netbox-worker
    restart: unless-stopped
    environment:
      TZ: ${TZONE}
      DB_NAME: ${DB_NAME}
      DB_USER: ${DB_USER}
      DB_PASSWORD: ${DB_PASS}
      DB_HOST: netbox-postgres
      DB_PORT: 5432
      REDIS_HOST: netbox-redis
      REDIS_PORT: 6379
      REDIS_PASSWORD: ${REDIS_PASS}
      SECRET_KEY: ${SECRET_KEY}
    volumes:
      - ./app/configuration:/etc/netbox/config:z,ro
      - ./app/media:/opt/netbox/netbox/media:rw
      - ./app/reports:/opt/netbox/netbox/reports:rw
      - ./app/scripts:/opt/netbox/netbox/scripts:rw
    depends_on:
      netbox-app:
        condition: service_healthy
    command:
      - /opt/netbox/venv/bin/python
      - /opt/netbox/netbox/manage.py
      - rqworker
    healthcheck:
      test: ["CMD-SHELL", "ps -aux | grep -v grep | grep -q rqworker || exit 1"]
      start_period: 20s
      timeout: 3s
      interval: 15s

Коротко о сервисах:

  • netbox-traefik — принимает запросы на 80 порту и проксирует их на netbox-app.
  • netbox-postgres — база данных для хранения всех данных NetBox.
  • netbox-redis / netbox-redis-cache — Valkey, форк Redis с открытой лицензией, полностью совместим с redis-протоколом. Первый инстанс обслуживает очередь фоновых задач, второй — кэш конфигурации и сессий.
  • netbox-app — само приложение, образ берется с Netbox Docker Hub.
  • netbox-worker — воркер, обрабатывает отложенные задачи через rqworker.

* Netbox docker port наружу не публикуется — контейнер netbox-app отдает только expose: 8080 внутри docker-сети, снаружи все идет через Traefik на 80 порту.

Теперь создадим файл .env с переменными окружения:

vi .env

TZONE=Europe/Moscow

DOMAIN=netbox.dmosk.ru

TRAEFIK_VER=v2.11

NBX_VER=v4.6

DB_VER=18-alpine
DB_NAME=netbox
DB_USER=netbox
DB_PASS=db_pass

REDIS_VER=9.0-alpine
REDIS_PASS=redis_pass

* значения данных переменных необходимо заменить на свои.

Пояснения к переменным:

  • TZONE — часовой пояс контейнеров.
  • DOMAIN — доменное имя, по которому будет открываться NetBox.
  • TRAEFIK_VER, NBX_VER, DB_VER, REDIS_VER — версии образов сервисов.
  • DB_NAME, DB_USER, DB_PASS — параметры подключения к PostgreSQL.
  • REDIS_PASS — пароль для netbox-redis и netbox-redis-cache.

Стартовое конфигурирование и запуск

Официальный репозиторий проекта называется netbox-docker, оттуда возьмем шаблон конфигурации:

git clone https://github.com/netbox-community/netbox-docker.git /tmp/netbox

Подготовим каталог под конфигурацию приложения:

mkdir app

Перенесем шаблон конфигурации NetBox в свой проект:

mv /tmp/netbox/configuration app/

* каталог configuration содержит файл настроек NetBox, при необходимости его можно донастроить вручную.

NetBox требует уникальный SECRET_KEY. Сгенерируем его и добавим в .env:

echo "SECRET_KEY=$(openssl rand -base64 45)" >> .env

* если ключ поменять позже, старые сессии и API-токены станут недействительными.

Сначала запустим базовые сервисы — базу данных, redis и само приложение, не поднимая пока worker и Traefik:

docker-compose up -d netbox-postgres netbox-redis netbox-redis-cache netbox-app

Проверим логи запуска:

docker logs netbox-app -f

Первая инициализация может длиться около 5 минут.

После успешной инициализации поднимем все сервисы, включая worker и Traefik:

docker-compose up -d

NetBox готов к работе.

Создадим первого администратора:

docker-compose exec netbox-app /opt/netbox/netbox/manage.py createsuperuser

Система запросит логин, email и пароль дважды:

Username: admin
Email address: admin@dmosk.ru
Password: 
Password (again): 

Установка завершена, можно заходить в веб-интерфейс по адресу, указанному в DOMAIN.

Возможные ошибки при запуске

Не стартуют контейнеры netbox-app и netbox-worker

Контейнеры netbox-app и netbox-worker либо не начинают запускаться, либо запускаются после долгого простоя.

Причина: netbox-app и netbox-worker стартуют только после того, как зависимые сервисы пройдут healthcheck. Если postgres или redis не успели подняться, docker-compose может вывести что-то вроде Container netbox-docker-netbox-1 error dependency netbox failed to start.

Решение: проверяем логи зависимого контейнера, например docker logs netbox-postgres, дожидаемся статуса healthy и повторяем docker-compose up -d.

Плагины NetBox

NetBox поддерживает плагины (Netbox-docker plugins), но подключаются они не через .env — потребуется собрать собственный образ поверх netboxcommunity/netbox и указать плагин в файле конфигурации. Список поддерживаемых способов подключения плагинов и актуальная документация — в репозитории netbox-docker на GitHub.

Конфигурация рассчитана на тестовое или внутреннее окружение. Для продакшена дополнительно потребуется HTTPS через Traefik и Let's Encrypt, а также резервное копирование базы PostgreSQL — это отдельные темы, не входящие в базовую установку.

# DevOps # Linux # Контейнеризация # Серверы
Дмитрий Моск — частный мастер
Был ли вам полезен этот скрипт?

Да            Нет

Дмитрий Моск
— IT-специалист.
Настройка серверов, услуги DevOps.

Заказать настройку контейнеризации

Нужна бесплатная консультация?

Скрипты

Пример скрипта для миграции запущенной виртуальной машины Proxmox с ZFS репликацией

Пример манифеста для развертывания Hermes AI в Kubernetes

Пример файла docker-compose для развертывания брокера Kafka

Пример файла docker-compose для настройки и запуска Netbox

Пример сценария docker-compose для запуска сервера Dependency-Track

Запуск SonarQube Server в контейнере с помощью docker-compose

Пример docker-compose файла для запуска сервера rustdesk в docker

Другие скрипты

Все статьи

Нужен скрипт? Опишите его назначение:





Реклама