Maintenir et mettre à jour NetBox

Une instance que personne ne maintient est une bombe à retardement : le jour où elle casse est le jour où tu découvres que la sauvegarde n'a jamais été testée. Cette page met en place une sauvegarde nocturne et la restaure une fois, met NetBox à jour vers une version choisie exprès, branche la tâche d'entretien, et laisse derrière elle une sonde qui te prévient quand quelque chose cloche.

Avant de commencer

$systemctl is-active netbox netbox-rq postgresql

active
active
active

Sauvegardes nocturnes

$sudo mkdir -p /var/backups/netbox && sudo chmod 700 /var/backups/netbox

#!/usr/bin/env bash
set -euo pipefail
stamp=$(date +%Y%m%d-%H%M)
dest=/var/backups/netbox
sudo -u postgres pg_dump -Fc netbox > "$dest/netbox-$stamp.dump"
files=(netbox/media netbox/netbox/configuration.py)
for f in netbox/netbox/ldap_config.py local_requirements.txt gunicorn.py; do
  if [ -e "/opt/netbox/$f" ]; then files+=("$f"); fi
done
tar -czf "$dest/netbox-files-$stamp.tar.gz" -C /opt/netbox "${files[@]}"
find "$dest" -name 'netbox-*' -mtime +14 -delete

$sudo chmod 750 /usr/local/sbin/netbox-backup.sh
$sudo systemctl daemon-reload
$sudo systemctl enable --now netbox-backup.timer
$sudo systemctl start netbox-backup.service

$systemctl is-active netbox-backup.timer

active

$ls /var/backups/netbox | sed 's/-[0-9]*-[0-9]*\././' | LC_ALL=C sort -u

netbox-files.tar.gz
netbox.dump

Exercice de restauration

$latest=$(ls -t /var/backups/netbox/netbox-*.dump | head -1)
$sudo -u postgres createdb -O netbox netbox_drill
$sudo -u postgres pg_restore --no-owner --role=netbox -d netbox_drill < "$latest"

$sudo -u postgres psql -d netbox_drill -tAc 'SELECT count(*) > 0 FROM dcim_site'

t

$sudo -u postgres dropdb netbox_drill

Mettre NetBox à jour

$sudo systemctl start netbox-backup.service
$cd /opt/netbox
$sudo git fetch --tags
$sudo git checkout v4.4.1
$sudo ./upgrade.sh
$sudo systemctl restart netbox netbox-rq

$sudo git -C /opt/netbox describe --tags --exact-match

v4.4.1

$curl -skf -H 'Authorization: Token ${NETBOX_TOKEN}' https://netbox.example.com/api/status/ | python3 -c 'import sys,json; print("v" + json.load(sys.stdin)["netbox-version"])'

v4.4.1

$curl -sk -o /dev/null -w '%{http_code}' https://netbox.example.com/login/

200

Ensuite, ouvre https://netbox.example.com/ et clique sur une page d'équipement et une recherche : que l'API réponde ne veut pas dire que l'interface s'affiche, puisque les fichiers statiques et les plugins peuvent casser l'un sans l'autre.

Si un plugin bloque la mise à jour

• Regarde le tableau de compatibilité du plugin sur son dépôt. S'il existe une release compatible, fige-la dans local_requirements.txt (netbox-bgp==0.15.0) et relance sudo ./upgrade.sh.
• S'il n'en existe pas, retire le plugin de PLUGINS dans configuration.py et de local_requirements.txt, mets à jour, et remets-le quand le plugin aura rattrapé. Ses tables restent dans la base ; rien n'est perdu, les pages disparaissent juste en attendant.
• Si les notes de version disent que le plugin est devenu une fonction native (ça arrive), migre les données avec les instructions du plugin avant la mise à jour.

Retour arrière

$sudo systemctl stop netbox netbox-rq
$cd /opt/netbox
$sudo git checkout $(sudo git describe --tags --abbrev=0 v4.4.1^)
$latest=$(ls -t /var/backups/netbox/netbox-*.dump | head -1)
$sudo -u postgres dropdb netbox && sudo -u postgres createdb -O netbox netbox
$sudo -u postgres pg_restore --no-owner --role=netbox -d netbox < "$latest"
$sudo ./upgrade.sh
$sudo systemctl start netbox netbox-rq

Entretien

$sudo ln -sf /opt/netbox/contrib/netbox-housekeeping.sh /etc/cron.daily/netbox-housekeeping
$sudo /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py housekeeping

$run-parts --test /etc/cron.daily | grep netbox

/etc/cron.daily/netbox-housekeeping

Logs et disque : gunicorn écrit sur la sortie standard, que systemd capture dans le journal ; plafonne-le. nginx et Apache font tourner leurs propres fichiers via logrotate, livré avec le paquet.

[Journal]
SystemMaxUse=500M

Chaque semaine, cinq minutes :

Supervision de base

$systemctl status netbox netbox-rq --no-pager | grep Active
$curl -skf -H "Authorization: Token ${NETBOX_TOKEN}" https://netbox.example.com/api/status/ | python3 -m json.tool

$curl -skf -H 'Authorization: Token ${NETBOX_TOKEN}' https://netbox.example.com/api/status/ | python3 -c 'import sys,json; print(json.load(sys.stdin)["rq-workers-running"] >= 1)'

True

Terminé

Chaque nuit un dump et une archive atterrissent dans /var/backups/netbox, tu en as restauré un à la main, NetBox tourne en v4.4.1, le journal des changements est purgé chaque jour, et une sonde sait quand les workers s'arrêtent. La page suivante arrête de cliquer : un utilisateur d'automatisation, pynetbox, des imports en masse, des webhooks et des scripts personnalisés.