Upgrading from v2.10.x to v2.11.x failing

[alexanderdeca]

Upgrading from a v2.10.x release to v2.11.x is failing and gives the following error : "ImportError: cannot import name 'COL_TENANT' from 'tenancy.tables' (/opt/netbox-2.11.0/netbox/tenancy/tables.py)"

Upgrading from v2.10.8 to v2.10.9 and following to v2.10.10 works perfectly however upgrading to v2.11.x is not working.

Applying database migrations (python3 netbox/manage.py migrate)...
Traceback (most recent call last):
File "netbox/manage.py", line 10, in
execute_from_command_line(sys.argv)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/management/init.py", line 419, in execute_from_command_line
utility.execute()
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/management/init.py", line 413, in execute
self.fetch_command(subcommand).run_from_argv(self.argv)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/management/base.py", line 354, in run_from_argv
self.execute(*args, **cmd_options)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/management/base.py", line 398, in execute
output = self.handle(*args, **options)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/management/base.py", line 89, in wrapped
res = handle_func(*args, **kwargs)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/management/commands/migrate.py", line 75, in handle
self.check(databases=[database])
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/management/base.py", line 419, in check
all_issues = checks.run_checks(
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/checks/registry.py", line 76, in run_checks
new_errors = check(app_configs=app_configs, databases=databases)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/checks/urls.py", line 13, in check_url_config
return check_resolver(resolver)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/core/checks/urls.py", line 23, in check_resolver
return check_method()
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/urls/resolvers.py", line 412, in check
for pattern in self.url_patterns:
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/utils/functional.py", line 48, in get
res = instance.dict[self.name] = self.func(instance)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/urls/resolvers.py", line 598, in url_patterns
patterns = getattr(self.urlconf_module, "urlpatterns", self.urlconf_module)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/utils/functional.py", line 48, in get
res = instance.dict[self.name] = self.func(instance)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/django/urls/resolvers.py", line 591, in urlconf_module
return import_module(self.urlconf_name)
File "/usr/lib/python3.8/importlib/init.py", line 127, in import_module
return _bootstrap._gcd_import(name[level:], package, level)
File "", line 1014, in _gcd_import
File "", line 991, in _find_and_load
File "", line 975, in _find_and_load_unlocked
File "", line 671, in _load_unlocked
File "", line 783, in exec_module
File "", line 219, in _call_with_frames_removed
File "/opt/netbox-2.11.0/netbox/netbox/urls.py", line 8, in
from extras.plugins.urls import plugin_admin_patterns, plugin_patterns, plugin_api_patterns
File "/opt/netbox-2.11.0/netbox/extras/plugins/urls.py", line 28, in
urlpatterns = import_object(f"{plugin_path}.urls.urlpatterns")
File "/opt/netbox-2.11.0/netbox/extras/plugins/utils.py", line 31, in import_object
spec.loader.exec_module(module)
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/config_officer/urls.py", line 2, in
from . import views
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/config_officer/views.py", line 36, in
from .tables import (
File "/opt/netbox-2.11.0/venv/lib/python3.8/site-packages/config_officer/tables.py", line 10, in
from tenancy.tables import COL_TENANT
ImportError: cannot import name 'COL_TENANT' from 'tenancy.tables' (/opt/netbox-2.11.0/netbox/tenancy/tables.py)

[candlerb]

COL_TENANT doesn't appear anywhere in the v2.11.0 source code. In fact, COL_TENANT was removed in this commit from 4 March 2021.

However, on my system, it exists in some pre-compiled python bytecode files:

root@netbox:/opt/netbox# grep -R COL_TENANT .
Binary file ./netbox/circuits/__pycache__/tables.cpython-35.pyc matches
Binary file ./netbox/tenancy/__pycache__/tables.cpython-35.pyc matches
Binary file ./netbox/dcim/__pycache__/tables.cpython-35.pyc matches
Binary file ./netbox/dcim/__pycache__/tables.cpython-36.pyc matches
Binary file ./netbox/ipam/__pycache__/tables.cpython-35.pyc matches
Binary file ./netbox/virtualization/__pycache__/tables.cpython-35.pyc matches
root@netbox:/opt/netbox# strings ./netbox/tenancy/__pycache__/tables.cpython-35.pyc | grep -3 COL
django_tables2r
utilities.tablesr
modelsr
COL_TENANTr
<module>
root@netbox:/opt/netbox#

Note: those cpython-35 files are still lying around from when I had an older version of Netbox running under python 3.5. But cpython-36 will still be live, as I'm using python 3.6 now.

This makes me think that on your system, you also have some stale pyc files lying around, which can cause old python code to be wrongly run.

Therefore, I suggest you delete all netbox pyc files (find /opt/netbox-2.11.0/netbox -name '*.pyc' -type f -delete) and then try again.

The pyc files will be automatically regenerated, as long as the 'netbox' user has write permissions to the source directories. Even if they can't be written it doesn't really matter, it's only an optimisation - although if you want, you can set the permissions so that they can (chown -R netbox:netbox /opt/netbox-2.11.0/netbox).

[candlerb]

Also: review how you're doing upgrades.

The fact that you're installing into a directory called /opt/netbox-2.11.0 suggests that you might be installing from a release tarball or zipball. But those are clean, and do not include any artefacts from previous versions (including pyc).

You should always untar or unzip into a fresh directory. Never untar or unzip on top of an existing release. Not only will this leave pyc files behind, this will also leave behind py files which exist in the old version but not in the new. That can really confuse the code.

That's why you should unpack into a fresh /opt/netbox-2.xx.x directory, then update the symlink, then copy over any media and scripts/reports. If that's too painful, then checkout the git master branch and use "git pull" for upgrades.

[alexanderdeca]

thanks for the feedback, just following the upgrade procedure (documented https://netbox.readthedocs.io/en/stable/installation/upgrading/, which is just creating a symlink to the unpacked netbox version .tar.gz.

I deleted the netbox pyc files , however it seems that there seems to be an issue with a plugin that I am running, after I delete the pyc files and do another grep it shows me the following result:

root@netbox:/opt/netbox# grep -R COL_TENANT
venv/lib64/python3.8/site-packages/config_officer/tables.py:from tenancy.tables import COL_TENANT
venv/lib64/python3.8/site-packages/config_officer/tables.py: tenant = tables.TemplateColumn(template_code=COL_TENANT)
Binary file venv/lib64/python3.8/site-packages/config_officer/pycache/tables.cpython-38.pyc matches
venv/lib/python3.8/site-packages/config_officer/tables.py:from tenancy.tables import COL_TENANT
venv/lib/python3.8/site-packages/config_officer/tables.py: tenant = tables.TemplateColumn(template_code=COL_TENANT)
Binary file venv/lib/python3.8/site-packages/config_officer/pycache/tables.cpython-38.pyc matches

I am running the "netbox-plugin-config-officer".

thanks for the feedback

Alexander

[candlerb]

Ah, that will be it. The plugin needs to be updated (you can report the problem here). You'll either have to remove it for now, or stick with Netbox 2.10.x until it is fixed.

[alexanderdeca]

Alright thanks for the feedback!