Skip to main content

Upgrade Path

Why are there upgrade paths?

As new innovation is introduced into nodectl, the configuration files may be updated to reflect new features; either to Tessellation, the Protocol that runs our Constellation Node, or nodectl itself.

During each upgrade process from one version to the next, the upgrade process may change. Removed elements from one upgrade may not properly translate to another version. So if you are not coming directly from the previous version that was released, you may run into errors or unexpected behaviors.

Understanding the Upgrade Path

Utilizing the upgrade_path command, you can review what versions of nodectl you need upgrade to before reaching the final version you are attempting to reach.

It will offer you information regarding what the upgrade path is to properly advance your way, through versions of nodectl from the current version your Node is running to the latest version.

IMPORTANT

Regardless of what version you are on. It is HIGHLY RECOMMENDED and REQUIRED to download the next version in line with path shown with the upgrade_path command (available after version 2), and regardless of... to utilize the upgrade command after the download is completed, for each version you download.

info

An alternative method is to build a new Node and simply start at the latest version which will not require any upgrade paths

Current Upgrade Path Table

Previous VersionUpgrade Directly To Version
v0.1.0v0.14.1
v0.14.1v1.8.1
v1.8.1v1.11.7
v1.11.7v1.12.0
v1.12.0v2.7.1
v2.7.1v2.8.1
v2.8.1v2.11.3
v2.11.3v2.12.7
v2.12.7v2.13.0

Example

You are on version v0.1.5

You will need to start by finding the closest version to your version, that is great than your version.

  1. We find v1.14.1

  2. We will now download v1.14.1 using the wget command

  3. We will upgrade our Node via sudo nodectl upgrade

  4. We will now download v1.8.1

  5. We will upgrade our Node via sudo nodectl upgrade

  6. We will now download v1.11.7

  7. We will upgrade our Node via sudo nodectl upgrade

  8. We will now download v1.12.0

  9. We will upgrade our Node via sudo nodectl upgrade

IMPORTANT

Version 1.12.0 to version 2.7.1 will require a special migration process.

This migration can be accomplished by following the step-by-step process via the migration tutorial.

We continue this process until we reach the current version.

End of document