Single Instance Upgrade Procedure from 4.21 to 4.22¶

This guide will lead you through the steps specific for upgrading from a NetEye Single Node installation from version 4.21 to 4.22. You must have successfully completed the Update Procedure before attempting to start the upgrade procedure.

Warning

Remember that you must upgrade sequentially without skipping versions, therefore an upgrade to 4.22 is possible only from 4.21; for example, if you have version 4.14, you must first upgrade to the 4.15, then 4.16, and so on.

Before starting an upgrade, you should very carefully read the latest release notes on NetEye’s blog and check the feature changes and deprecations specific to the version being upgraded. You should check also the whole section Breaking Changes below.

The remainder of this section is organised as follows. Section Breaking Changes introduces substantial changes that users must be aware of before starting the upgrade procedure and may require to carry out some tasks before starting the upgrade; section NetEye Single Instance Upgrade Procedure presents the actual procedure, and finally section Additional Tasks shows which tasks must be executed after the upgrade procedure has been successfully executed.

Breaking Changes¶

NATS telegraf user

The NATS telegraf user has been deprecated due to security issues and will be removed in the NetEye 4.22 release. This means that the telegraf user must be migrated before the upgrade to NetEye 4.22. It has been replaced by two new users:

telegraf_wo with write-only privileges on NATS
telegraf_ro with read-only privileges on NATS

Please change your telegraf collectors and consumers to use the two new users as described in Section Write Data to influxDB through NATS master of the User Guide. Once you have removed all occurrences of telegraf user please go to Configuration / Modules / neteye / Configuration, click Remove NATS telegraf user and Save Changes.

Elastic Stack

From NetEye 4.22 onwards, we regenerated server certificates required to expose Elasticsearch through NGINX. The Elasticsearch REST certificate will be replaced but existing files are backed up with timestamp as follows:

/neteye/local/elasticsearch/conf/certs/es-rest.crt.pem.<timestamp>
/neteye/local/elasticsearch/conf/certs/es-rest.csr.<timestamp>
/neteye/local/elasticsearch/conf/certs/private/es-rest.key.<timestamp>

If you want to recreate certificates for any reason you have to include in the new certificates at least following information:

NetEye FQDN
elasticsearch.neteyelocal

Note

These parameters should be given as argument to script /usr/share/neteye/scripts/security/generate_server_certs.sh.

NetEye Single Instance Upgrade Procedure¶

To perform the upgrade, run from the command line the command:

# nohup neteye upgrade

All the tasks carried out by the command are listed in section neteye upgrade; a dedicated section provides directions in case the command fails.

Additional Tasks¶

This section lists the tasks that must be carried out manually, because they are not part of the neteye upgrade command.

In this release, no additional task is required.