N|Solid Documentation

Versions

Installation

This guide will help you quickly install all of the N|Solid components for a production cluster. We provide production rpm and deb packages for use in Linux distributions. This makes it significantly easier to set up the N|Solid components by using our repositories. We support the following rpm based 64-bit Linux distributions:

We also support the following deb based 64-bit Linux distributions:

If you do not wish to use these packages, manual installation instructions are provided below.

Note: The default Node.js runtime used in the instructions below is Node.js v6 LTS (Boron). If you wish to use a version of N|Solid based on Node.js v4 LTS (Argon), replace any instances of boron with argon in the instructions below.

Installing N|Solid Packages

Step 1: Set Up the NodeSource N|Solid Repository

For rpm based distributions, use the following command as root:

$ curl -sL http://nsolid-rpm.nodesource.com/nsolid_setup_2.x | bash -

For deb based distributions, there is a similar command run as root:

$ curl -sL http://nsolid-deb.nodesource.com/nsolid_setup_2.x | bash -

In both cases, these scripts will attempt to determine the distribution you are using, set up the appropriate repository on your system, and import the NodeSource N|Solid GPG key used to sign the packages.

Step 2: Install the Packages

For rpm based systems, the command:

$ yum -y install nsolid-boron nsolid-storage nsolid-console

will install all the required components. You can then turn them on using the standard system tools. Older init style systems, for example, would turn on the storage component with:

$ /etc/init.d/nsolid-storage start

whereas newer systemd style systems would use the command:

$ systemctl start nsolid-storage

For deb based systems, the process is similar. To install the software:

$ apt-get -y install nsolid-boron nsolid-storage nsolid-console

On deb based systems, the relevant daemons will start automatically on installation, but you will still turn the services on and off using the standard tools as shown above depending on if you have an init based system or a systemd based system.

These packages can be installed separately, and possibly on different machines if you wish. However, if you plan on installing all of the components onto a single machine, the process can be further simplified. Instead of installing the components individually by name as we've done here, you can simply install the nsolid-console-all meta package for your system. For rpm based distributions:

$ yum -y install nsolid-boron-console-all

or for deb based distributions:

$ apt-get -y install nsolid-boron-console-all

This meta package will install all of the components and turn them on if needed.

Upgrading N|Solid Packages

Once you have set up the NodeSource N|Solid package repository appropriate to your system, you will automatically get point releases via the standard system update tools. For example, running:

yum -y update

will fetch and install any new versions of the packages that are available automatically.

Manual Installation

These instructions use the Linux platform builds, but the same steps apply for OS X (darwin) platforms.

Step 1: Get N|Solid

  1. Go to downloads.nodesource.com
  2. Click on the Debian, Ubuntu or RHEL, Fedora, CentOS button for the latest version of N|Solid
  3. Scroll down to the Manual Installation section and click the Download button
  4. Extract the archive

The extracted archive contains all N|Solid components for your architecture:

  1. The N|Solid Runtime (e.g. nsolid-v2.0.0-boron-linux-x64.tar.gz)
  2. The N|Solid Storage (e.g. nsolid-storage-v1.0.1.tar.gz)
  3. The N|Solid Console (e.g. nsolid-console-v2.0.0-linux-x64.tar.gz)

Step 2: Install the N|Solid Runtime

The N|Solid Runtime is a build of Node.js that is compiled to include the N|Solid Agent. The runtime should be installed on any application servers where you intend to run your Node.js application.

$ tar xf nsolid-v2.0.0-boron-linux-x64.tar.gz
$ cd nsolid-v2.0.0-boron-linux-x64
$ ls
bin  CHANGELOG.md  include  lib  LICENSE  LICENSE.NSOLID  README.md  share

We suggest installing into /usr/local for greatest compatibility, though most preferred installation methods used for Node.js will also work for N|Solid.

To install to /usr/local:

  1. remove existing npm and nsolid-cli installations:

    $ rm -rf /usr/local/lib/node_modules/npm /usr/local/lib/node_modules/nsolid-cli

  2. put the N|Solid components in place:

    $ cp -r lib bin share /usr/local/

To verify you are running Node compiled with the N|Solid Agent and see your version of N|Solid, use:

$ node -vv
v2.0.0

This package also contains the nsolid-cli application, which can act as a command-line interface to the N|Solid Agent via the N|Solid Storage, allowing scripted or manual interaction.

Step 3: Install the N|Solid Storage Component

N|Solid 2.0 provides a persistance component for orchestrating connectivity and retaining your metrics and assets.

$ tar xf nsolid-storage-v1.0.1.tar.gz
$ ls nsolid-storage-v1.0.1
etc  lib  LICENSE  node_modules  nsolid-storage.js  package.json  README.md  schemas  tsdb

Place this folder wherever you typically install your Node.js applications. For this example, we'll put it in /var/opt

# cp -r nsolid-storage-v1.0.1 /var/opt
# cd /var/opt/nsolid-storage-v1.0.1

Running npm start from within this directory will start the storage service with the default configuration.

For more information about configuration options for the N|Solid Storage, see: networking

You will want to run nsolid-storage as any other Node.js service in your infrastructure, using your process manager of choice.

Step 5: Install the N|Solid Console

The N|Solid Console is a graphical interface for your entire cluster of applications running on N|Solid. It communicates with each N|Solid Agent via N|Solid Storage to track metrics, collect information, or trigger events on any of your N|Solid processes.

The N|Solid Console is best experienced using one of the following browsers on a desktop/laptop system.

The download bundle includes the nsolid-console built for your platform.

$ tar xf nsolid-console-v2.0.0-linux-x64.tar.gz
$ ls nsolid-console-v2.0.0-linux-x64
FIXME

Place this folder wherever you typically install your Node.js applications. For this example, we'll put it in /var/opt

# cp -r nsolid-console-v2.0.0 /var/opt
# cd /var/opt/nsolid-console-v2.0.0

Running npm start from within this directory will start the N|Solid Console with the default configuration.

For more information about configuration options for the N|Solid Console, see: configuration

You will want to run nsolid-console as any other Node.js service in your infrastructure, using your process manager of choice.

Upgrading From Previous Versions of N|Solid

To upgrade from previous versions of N|Solid, use the instructions above to install over your previous installation. At each step, verify that the latest version of the component is installed and working.

If you have the N|Solid Hub or Proxy installed from an earlier version of N|Solid, these components can be removed. Their functionality is replaced with N|Solid Storage in 2.0.

For rpm based systems this can be done with

For deb based systems this would be

The etcd package may be in use by your system for other purposes, but if you no longer require it, it too can be removed

N|Solid 1.x Artifacts

Any snapshots or profiles recorded with a version of N|Solid prior to 2.0 will continue to exist in the N|Solid console storage location that was used, but these will not be visible in the console. If you require use of these, please access them directly on your storage device.

If you had not configured the storage path for your N|Solid Console, the default path for these files was previously