upgrade - Concepts
There are 3 upgrade mechanisms regarding nodectl.
- Upgrade the nodectl utility to a new version. (binary)
- Upgrade your node to handle new features of nodectl, and modify some elements to make your node more efficient when working with the nodectl utility.
- Upgrade Tessellation and any elements of the VPS that may require modification to work with the Tessellation protocol.
Upgrade Options
Upgrade the nodectl utility.
Upgrade Tessellation using nodectl.
Upgrade nodectl
nodectl's built-in upgrade command.
nodectl is smart enough to guide you through the upgrade process. It will detect if the node need any extra steps to complete a successful upgrade.
These steps include:
- Is it safe to upgrade from the current version of nodectl your node is running to the latest version?
- There is an upgrade path that might need to be taken; dependent on, how much time has transpired from the last time your node was upgraded.
- Does your node require any extra upgrade steps to complete the nodectl upgrade for effective operation.
nodectl offers the --nodectl_only option. This will allow you to upgrade your node to handle new nodectl features without upgrading Tessellations and therefor not taking your node off the Tessellation cluster during the upgrade.
Upgrade to new version of nodectl
nodectl is simply a single binary files compiled to work on your VPS.
That is to say, it is single file that you can simply download from the Internet and execute on your system without the need for any dependency installations.
Upgrade detection
nodectl is smart enough to attempt to determine if there is an upgrade available. By reaching out to an external source (scrapping the nodectl repository on GitHub ) nodectl will check for the latest upgrade.
When a command is issued, nodectl will review the versioning on your node and if a new version on nodectl is detected, you will be notified.
A new version of nodectl was detected: v2.15.2
To upgrade issue: sudo nodectl upgrade_nodectl
In the above output, it shows us that our node is not up-to-date and the latest version available is v2.15.2.
Upgrade nodectl via nodectl
If nodectl is already installed on your system, we can issue the upgrade_nodectl command to attempt to upgrade.
sudo nodectl upgrade_nodectl
When we execute the upgrade_nodectl command; nodectl will detect that there is a new version, and begin the installation process.
You can follow the quick start guide.
info
nodectl cannot upgrade itself while the auto_restart feature is actively running. nodectl will identify if the auto_restart feature is enabled and disable it automagically for us.
Manual Installation
The process of a manual nodectl installation is simple. You navigate to the nodectl releases site on GitHub, copy the link to the binary, and paste that link into your node's CLI (command line interface).
danger
This process can possibly break your node if you do not follow the appropriate upgrade path.
Upgrade Node to work with new nodectl features
It is very simple to upgrade your node with new nodectl features. We simply execute the upgrade command with the --nodectl_only option and follow the prompts.
sudo nodectl upgrade --nodectl_only
Utilizing the --nodectl_only option will only handle upgrades necessary for nodectl to function properly. The advantage to this command is that it will not take the node off the the metagraphs it is connected with. If only updating nodectl, Tessellation will not be affected.
You can follow the quick start guide.
Upgrade Tessellation
Upgrade with nodectl
It is very simple to upgrade your node with new Tessellation version and features. We simply execute the upgrade command and follow the prompts.
sudo nodectl upgrade
nodectl will go through all the necessary requirements to bring your node up to the latest version and features of Tessellation utilizing prompts for any questions that offer optional actions on the node.
You can follow the step by step guide or quick start guide.
Manual upgrade
You can follow along with the manual steps to install Tessellation on a VPS.