Updated documentation related to the upgrade to version 2.9.0 #4009

Closed
opened 2025-12-29 18:32:36 +01:00 by adam · 4 comments
Owner

Originally created by @azdolinski on GitHub (Aug 22, 2020).

Change Type

[ ] Addition
[x] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Area

[x] Installation instructions ->> upgrade procedure
[ ] Configuration parameters
[ ] Functionality/features
[ ] REST API
[ ] Administration/development
[ ] Other

Proposed Changes

https://netbox.readthedocs.io/en/stable/installation/upgrading/
from version 2.9.0 upgrade procedure in not valid.

  1. Section which says to do: '# cp netbox-X.Y.Z/netbox/netbox/configuration.py netbox/netbox/netbox/configuration.py'
    is problematic as new "Object-Based Permissions" model require new values for: REMOTE_AUTH_BACKEND
    and change REMOTE_AUTH_DEFAULT_PERMISSIONS to dict
    Please add some information in documentation about this.

For those who will be doing upgrade - all config changes between 2.8 and 2.9 are very clear visible when you compare old config with new 2.9 example:

(venv) [root@localhost netbox]# pwd
/opt/netbox/netbox/netbox
(venv) [root@localhost netbox]# diff configuration.example.py configuration.py
  1. there is nothing about requirements regarding Redis.
    I was using 2.8.8 before upgrade, and I was using redis-3.2.12-2.el7 - and all was working fine..
    Just after upgrade to 2.9.0 - main page was loading - but when I was trying to login - it shows me:
<class 'redis.exceptions.ResponseError'>
Error running script (call to f_0605214935a9ffcd4b9e5779300302540ff08da4): @user_script:36: @user_script: 36: Unknown Redis command called from Lua script

Upgrade to latest Redis 6.x resolve problem:

sudo yum -y update
sudo yum -y install http://rpms.remirepo.net/enterprise/remi-release-7.rpm
sudo yum --enablerepo=remi install redis
rpm -qi redis
sudo systemctl enable --now redis
sudo systemctl restart redis
sudo systemctl status redis

But again - there is nothing in upgrade procedure / or even in release notes that this version needs to have Redis 6.x.

Originally created by @azdolinski on GitHub (Aug 22, 2020). ### Change Type [ ] Addition [x] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) ### Area [x] Installation instructions ->> upgrade procedure [ ] Configuration parameters [ ] Functionality/features [ ] REST API [ ] Administration/development [ ] Other ### Proposed Changes https://netbox.readthedocs.io/en/stable/installation/upgrading/ from version 2.9.0 upgrade procedure in not valid. 1) Section which says to do: '# cp netbox-X.Y.Z/netbox/netbox/configuration.py netbox/netbox/netbox/configuration.py' is problematic as new "Object-Based Permissions" model require new values for: REMOTE_AUTH_BACKEND and change REMOTE_AUTH_DEFAULT_PERMISSIONS to dict Please add some information in documentation about this. For those who will be doing upgrade - all config changes between 2.8 and 2.9 are very clear visible when you compare old config with new 2.9 example: ```bash (venv) [root@localhost netbox]# pwd /opt/netbox/netbox/netbox (venv) [root@localhost netbox]# diff configuration.example.py configuration.py ``` 2) there is nothing about requirements regarding Redis. I was using 2.8.8 before upgrade, and I was using redis-3.2.12-2.el7 - and all was working fine.. Just after upgrade to 2.9.0 - main page was loading - but when I was trying to login - it shows me: ```console <class 'redis.exceptions.ResponseError'> Error running script (call to f_0605214935a9ffcd4b9e5779300302540ff08da4): @user_script:36: @user_script: 36: Unknown Redis command called from Lua script ``` Upgrade to latest Redis 6.x resolve problem: ```bash sudo yum -y update sudo yum -y install http://rpms.remirepo.net/enterprise/remi-release-7.rpm sudo yum --enablerepo=remi install redis rpm -qi redis sudo systemctl enable --now redis sudo systemctl restart redis sudo systemctl status redis ``` But again - there is nothing in upgrade procedure / or even in release notes that this version needs to have Redis 6.x.
adam added the status: acceptedtype: documentation labels 2025-12-29 18:32:36 +01:00
adam closed this issue 2025-12-29 18:32:36 +01:00
Author
Owner

@jeremystretch commented on GitHub (Aug 22, 2020):

Please open a separate issue for the second topic.

@jeremystretch commented on GitHub (Aug 22, 2020): Please open a separate issue for the second topic.
Author
Owner

@Mic-Pod commented on GitHub (Aug 22, 2020):

@azdolinski thanks for the 2. part. I have exactly the same issue. I'll try the upgrade again on Monday with Your solution.

@Mic-Pod commented on GitHub (Aug 22, 2020): @azdolinski thanks for the 2. part. I have exactly the same issue. I'll try the upgrade again on Monday with Your solution.
Author
Owner

@jeremystretch commented on GitHub (Aug 23, 2020):

Backward compatibility for the old REMOTE_AUTH_BACKEND default has been restored under #5033. I've also added a note in the v2.9 release notes.

@jeremystretch commented on GitHub (Aug 23, 2020): Backward compatibility for the old `REMOTE_AUTH_BACKEND` default has been restored under #5033. I've also added a note in the v2.9 release notes.
Author
Owner

@jeremystretch commented on GitHub (Aug 23, 2020):

  1. there is nothing about requirements regarding Redis.

The installation instructions specify that Redis 4.0 or later is required for v2.9.0, however this is not mentioned in the upgrade documentation.

@jeremystretch commented on GitHub (Aug 23, 2020): > 2. there is nothing about requirements regarding Redis. The installation instructions specify that Redis 4.0 or later is required for v2.9.0, however this is not mentioned in the upgrade documentation.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#4009