Operations grimoire/NetBox - Revision history

Dereckson: /* Python */

2026-07-05T10:01:36Z

Python

@@ Line 81: / Line 81: @@
      pip install --upgrade pip
      pip install -r /srv/netbox/netbox/requirements.txt
 == Troubleshoot ==

Dereckson: /* Python */

2026-07-05T09:51:09Z

Python

← Older revision		Revision as of 09:51, 5 July 2026
Line 66:		Line 66:

	=== Python ===		=== Python ===

			''This procedure only applies when we do major interpreter change (e.g. Python 3.11 to 3.12) at OS level.'''

	To recreate the virtual environment with a new Python interpreter, recreate as root an empty venv directory:		To recreate the virtual environment with a new Python interpreter, recreate as root an empty venv directory:

Dereckson: /* Upgrade */

2026-07-05T09:50:28Z

Upgrade

← Older revision		Revision as of 09:50, 5 July 2026
Line 26:		Line 26:

	== Upgrade ==		== Upgrade ==
			=== NetBox ===
	To upgrade NetBox:		To upgrade NetBox:
	# Backup database on WindRiver		# Backup database on WindRiver
Line 64:		Line 64:

	Documentation needs to be generated before collectstatic. If not, run again the collectstatic command to copy docs from project-static to static directory.		Documentation needs to be generated before collectstatic. If not, run again the collectstatic command to copy docs from project-static to static directory.

			=== Python ===

			To recreate the virtual environment with a new Python interpreter, recreate as root an empty venv directory:

			rm -rf /srv/netbox/venv
			mkdir /srv/netbox/venv
			chown netbox:netbox /srv/netbox/venv

			Then, as netbox user, recreate it:

			python3 -m venv /srv/netbox/venv
			source /srv/netbox/venv/bin/activate
			pip install --upgrade pip
			pip install -r /srv/netbox/netbox/requirements.txt

	== Troubleshoot ==		== Troubleshoot ==

Dereckson: /* Troubleshoot */

2024-08-04T16:10:25Z

Troubleshoot

← Older revision		Revision as of 16:10, 4 August 2024
Line 66:		Line 66:

	== Troubleshoot ==		== Troubleshoot ==
			=== Grafana ===

			Use [https://grafana.nasqueron.org/d/O6v4rMpizda/netbox?orgId=1&refresh=10s Grafana dashboard] to check statistics.

			As of 2024-08-04, all the rates are erroneous and (a lot) over-evaluated.

	=== 500 after server reboot ===		=== 500 after server reboot ===
	After the server is restarted, NetBox needs PostgreSQL and Redis to work.		After the server is restarted, NetBox needs PostgreSQL and Redis to work.

Dereckson at 21:18, 8 July 2024

2024-07-08T21:18:50Z

← Older revision		Revision as of 21:18, 8 July 2024
Line 64:		Line 64:

	Documentation needs to be generated before collectstatic. If not, run again the collectstatic command to copy docs from project-static to static directory.		Documentation needs to be generated before collectstatic. If not, run again the collectstatic command to copy docs from project-static to static directory.

			== Troubleshoot ==
			=== 500 after server reboot ===
			After the server is restarted, NetBox needs PostgreSQL and Redis to work.

			* If PostgreSQL is down, we don't have any message on the web UI, it serves directly a 500 error code
			* If PostgreSQL up, Redis down, an explicit error message tells us it can't connect to Redis
			* When both services are up, site should work again

	== Conventions ==		== Conventions ==

Dereckson: /* Upgrade */

2024-01-06T19:40:01Z

Upgrade

← Older revision		Revision as of 19:40, 6 January 2024
Line 61:		Line 61:
	To track configuration changes, you can use https://github.com/netbox-community/netbox/commits/develop/netbox/netbox/configuration_example.py		To track configuration changes, you can use https://github.com/netbox-community/netbox/commits/develop/netbox/netbox/configuration_example.py

	If psycopg can't build, you can build it with <code>pip install "psycopg[c]"</code>. That requires development headers for PostgreSQL, available on all FreeBSD servers where ~~FreeBSD~~ is ~~available. For~~ a Docker image based on Linux, search for a libpq-dev or libpq-devel package for that purpose.		If psycopg can't build, you can build it with <code>pip install "psycopg[c]"</code>. That requires development headers for PostgreSQL, available on all FreeBSD servers where PostgreSQL is installed ; for a Docker image based on Linux, search for a libpq-dev or libpq-devel package for that purpose.

	Documentation needs to be generated before collectstatic. If not, run again the collectstatic command to copy docs from project-static to static directory.		Documentation needs to be generated before collectstatic. If not, run again the collectstatic command to copy docs from project-static to static directory.

Dereckson: /* Upgrade */

2024-01-06T19:35:26Z

Upgrade

← Older revision		Revision as of 19:35, 6 January 2024
Line 62:		Line 62:

	If psycopg can't build, you can build it with <code>pip install "psycopg[c]"</code>. That requires development headers for PostgreSQL, available on all FreeBSD servers where FreeBSD is available. For a Docker image based on Linux, search for a libpq-dev or libpq-devel package for that purpose.		If psycopg can't build, you can build it with <code>pip install "psycopg[c]"</code>. That requires development headers for PostgreSQL, available on all FreeBSD servers where FreeBSD is available. For a Docker image based on Linux, search for a libpq-dev or libpq-devel package for that purpose.

			Documentation needs to be generated before collectstatic. If not, run again the collectstatic command to copy docs from project-static to static directory.

	== Conventions ==		== Conventions ==

Dereckson: /* Upgrade */ As doc icons links to https://netbox.nasqueron.org/static/docs/, we need to generate the doc

2024-01-06T19:34:30Z

Upgrade: As doc icons links to https://netbox.nasqueron.org/static/docs/, we need to generate the doc

← Older revision		Revision as of 19:34, 6 January 2024
Line 49:		Line 49:
	rm netbox		rm netbox
	ln -s netbox-3.7.0 netbox		ln -s netbox-3.7.0 netbox
			cd /srv/netbox/netbox
			mkdocs build
	cd /srv/netbox/netbox/netbox		cd /srv/netbox/netbox/netbox
	python3 manage.py migrate		python3 manage.py migrate

Dereckson at 19:29, 6 January 2024

2024-01-06T19:29:15Z

← Older revision		Revision as of 19:29, 6 January 2024
Line 22:		Line 22:

	sudo -u postgres pg_dump netbox \| gzip > netbox-$(date +"%Y-%m-%d").gz		sudo -u postgres pg_dump netbox \| gzip > netbox-$(date +"%Y-%m-%d").gz

			Database is currently hosted on WindRiver, not on DB-A, even if a user exists there and an outdated copy exists.

			== Upgrade ==

			To upgrade NetBox:
			# Backup database on WindRiver
			# Install the new version
			# Copy configuration
			# Update Python dependencies
			# Shutdown the service: <code>service netbox stop</code> or if pid is wrong <code>killall netbox</code>
			# Symlink the directory in /srv/netbox
			# Run the database migrations and regenerate static resources, etc. as documented in upgrade.sh
			# Start the service

			An example for upgrade to 3.7.0:

			sudo -u postgres pg_dump netbox \| gzip > netbox-$(date +"%Y-%m-%d").gz
			cd /srv/netbox
			wget https://github.com/netbox-community/netbox/archive/refs/tags/v3.7.0.tar.gz
			tar xzf v3.7.0.tar.gz
			cp /srv/netbox/netbox/netbox/netbox/configuration.py netbox-3.7.0/netbox/netbox/
			source venv/bin/activate
			pip install -r netbox-3.7.0/requirements.txt
			killall -u netbox
			rm netbox
			ln -s netbox-3.7.0 netbox
			cd /srv/netbox/netbox/netbox
			python3 manage.py migrate
			python3 manage.py collectstatic
			python3 manage.py remove_stale_contenttypes
			python3 manage.py reindex --lazy
			python3 manage.py clearsessions
			service netbox start

			To track configuration changes, you can use https://github.com/netbox-community/netbox/commits/develop/netbox/netbox/configuration_example.py

			If psycopg can't build, you can build it with <code>pip install "psycopg[c]"</code>. That requires development headers for PostgreSQL, available on all FreeBSD servers where FreeBSD is available. For a Docker image based on Linux, search for a libpq-dev or libpq-devel package for that purpose.

	== Conventions ==		== Conventions ==

Dereckson: /* Integration with IRC */

2024-01-06T18:03:55Z

Integration with IRC

← Older revision		Revision as of 18:03, 6 January 2024
Line 15:		Line 15:
	17:13:59 < Dereckson> 172.27.27.6		17:13:59 < Dereckson> 172.27.27.6
	17:14:00 < Odderon> (Dereckson): 172.27.27.6/28 docker-001.nasqueron.org / Decommissioned address for docker-001.nasqueron.org / Drake [deprecated]		17:14:00 < Odderon> (Dereckson): 172.27.27.6/28 docker-001.nasqueron.org / Decommissioned address for docker-001.nasqueron.org / Drake [deprecated]

			Source code of the translation code is available at https://devcentral.nasqueron.org/source/netbox-darkbot-db/

	== Backup ==		== Backup ==