Skip to main content
Version: 4.10.0

Migration Guide

For N|Solid 3.x users, you will notice that begining in N|Solid 3.4.0, users of the Console are asked to authenticate before they can use the Console.

  • Requiring authentication is default behavior and can be disabled using the NSOLID_CONSOLE_AUTH_REQUIRE_LOGIN=false environment variable, or the corresponding configuration file setting.

  • To make use of the authentication to protect access to your Console, you should add the users that require access to the NodeSource Accounts organization which was used to activate the Console.

  • In order to use nsolid-cli with authentication enabled, you should set the NSOLID_CONSOLE_AUTH_ADMIN_TOKEN environment variable to a secure value and utilize this with the corresponding --auth parameter to nsolid-cli. See user authentication for more information.

If you are upgrading from N|Solid 2.x, here are the need-to-know steps for migrating to N|Solid 3.x.

  • N|Solid Storage has been eliminated, and its functionality is provided by the N|Solid 3.x Console server. Attempting to connect an existing N|Solid Storage instance to a N|Solid 3.x Console will not work unless the storage instance is running in relay mode.

  • Many of the settings and environment variables from N|Solid Storage are available in the 3.x N|Solid Console; substitute CONSOLE for STORAGE in the variable name. View the Networking documentation for specific settings.

  • Loading a N|Solid 3.x Console server with the same configuration as a N|Solid Storage instance will load some of your existing assets and metrics history, but Heap Snapshots will need to be accessed directly from your storage device. The default location has changed from ~/.nsolid-storage to ~/.nsolid-console.

  • The N|Solid 2.x Runtime is compatible with the N|Solid 3.x Console, but not all functionality will be available.

  • The environment variables used to configure N|Solid Runtime are the same as with N|Solid 2.x, however you must provide a valid license during any operation, either via a connection to an N|Solid Console, or by providing a License Token directly. Read the Configuration guide for more information.

  • The nsolid-cli syntax and behavior have changed from 2.x, be sure to read the Command Line Interface documentation if you use this functionality.