Upgrading to a New Nautobot Release¶

Review the Release Notes¶

Prior to upgrading your Nautobot instance, be sure to carefully review all release notes that have been published since your current version was released. Although the upgrade process typically does not involve additional work, certain releases may introduce breaking or backward-incompatible changes. These are called out in the release notes under the release in which the change went into effect.

Update Dependencies to Required Versions¶

Nautobot v1.0.0 and later requires the following:

Dependency	Minimum Version
Python	3.6
PostgreSQL	9.6
Redis	4.0

Install the Latest Release¶

As with the initial installation, you can upgrade Nautobot by either downloading the latest release package or by cloning the main branch of the git repository.

Option A: Download a Release¶

Download the latest stable release from GitHub as a tarball or ZIP archive. Extract it to your desired path. In this example, we'll use /opt/nautobot.

Download and extract the latest version:

wget https://github.com/nautobot/nautobot/archive/vX.Y.Z.tar.gz
sudo tar -xzf vX.Y.Z.tar.gz -C /opt
sudo ln -sfn /opt/nautobot-X.Y.Z/ /opt/nautobot

Copy local_requirements.txt from the current installation to the new version:

sudo cp /opt/nautobot-X.Y.Z/local_requirements.txt /opt/nautobot/

Be sure to replicate your uploaded media as well. (The exact action necessary will depend on where you choose to store your media, but in general moving or copying the media directory will suffice.)

sudo cp -pr /opt/nautobot-X.Y.Z/nautobot_root/media/ /opt/nautobot

Also make sure to copy or link any jobs that you've made. Note that if these are stored outside of the project root, you may not need to copy them. (Check the JOBS_ROOT parameter in the configuration file above if you're unsure.)

sudo cp /opt/nautobot-X.Y.Z/jobs/*.py /opt/nautobot/jobs
# If you have any job data files (such as YAML or JSON) stored in the JOBS_ROOT directory, be sure to copy those as well

If you followed the original installation guide to set up uWSGI, be sure to copy its configuration as well:

sudo cp /opt/nautobot-X.Y.Z/uwsgi.ini /opt/nautobot/

Option B: Clone the Git Repository¶

This guide assumes that Nautobot is installed at /opt/nautobot. Pull down the most recent iteration of the main branch:

cd /opt/nautobot
sudo git checkout main
sudo git pull origin main

Run the Upgrade Script¶

Once the new code is in place, verify that any optional Python packages required by your deployment (e.g. napalm or django-auth-ldap) are listed in local_requirements.txt. Then, run the upgrade script:

sudo ./install.sh

This script performs the following actions:

• Destroys and rebuilds the Python virtual environment
• Installs all required Python packages
• Installs any additional packages from local_requirements.txt
• Applies any database migrations that were included in the release
• Collects all static files to be served by the HTTP service
• Deletes stale content types from the database
• Deletes all expired user sessions from the database
• Clears all cached data to prevent conflicts with the new release

Restart the Nautobot Services¶

Finally, restart the gunicorn and RQ services:

sudo systemctl restart nautobot nautobot-worker