A configuration backup system using netbox and napalm to backup devices into a git repository
- Connects to any device that supports napalm and provides both a running configuration and startup configuration
- Stores backups in a git repository
- Runs as a scheduled task through Django RQ
- Only displays backups with changes
- Provides both configuration download and diffs for point-in-time backups
- Allow github repositories
- Add job "discovery" based on specific criteria (napalm enabled, device role switch, has primary ip as an example)
- Add RQ job to ensure all backups are queued
- Allow manual queueing of job
- Add API endpoint to trigger backup
- Add signal(s) to trigger backup
- Install from PyPI (
pip install netbox-config-backup) - Edit netbox configuration:
PLUGINS = [
'netbox_config_backup',
# Other plugins here
]
PLUGINS_CONFIG = {
'netbox_config_backup': {
# Parent folder must exist and be writable by your RQ worker and readable by the WSGI process
'repository': '/path/to/git/repository',
'committer': 'User <email>',
'author': 'User <email>',
# Freqency of backups in seconds, can be anywhere 0+ (Recommended is 1800 (30 minutes) or 3600 (1 hr)
'frequency': 3600
}
}
- Migrate:
python3 netbox/manage.py migrate - Copy /etc/systemd/system/netbox-rq.service to /etc/systemd/system/ncb-rq@.service
- Edit: /etc/systemd/system/ncb-rq@.service: ExecStart:
ExecStart=/opt/netbox/venv/bin/python3 /opt/netbox/netbox/manage.py rqworker --name ncb@%i --with-scheduler netbox_config_backup.jobs
- Reload systemd:
systemctl daemon-reload - Enable the service with x number of workers:
systemctl enable ncb-rq@{1..10}(This will generate 10 worker symlinks to auto start) - Start the service with x number of workers:
systemctl start ncb-rq@{1..10}(This will start 10 workers) - Create your first device backup
To enable logging, add the following to your configuration.py under LOGGING:
'netbox_config_backup': {
'handlers': ['enter_your_handlers_here'],
'level': 'desired_log_level',
'propagate': True,
},