Feature Modules Installation¶
NetEye Core is the set of most commonly used functionalities offered by the platform, including monitoring, visualization (both dashboards and maps), configuration, reporting, and event handling.
However, the NetEye modular architecture supports the installation of additional Feature Modules that extend the NetEye Core functionalities. This separation allows to customize NetEye in order to address specific customer needs.
NetEye Modules vs. Preview Software¶
There are two types of additional modules, (NetEye) Feature Modules and Preview Software. Feature Modules are fully fledged modules, whose functionalities are well defined and established , whereas Preview Software are modules that are not yet completed and provide a set of functionalities that might change in the future; they might be installed to check new software, developed by Wuerth-Phoenix, that will be later become part of the official NetEye platform.
Note also that each Feature Module needs the installation of a group of packages, while a Preview Software is limited to one or few packages. They also belong to different repositories and can be installed from the command line.
In order to install any of them, execute the corresponding command, which changes slightly depending on the module’s type (please consider following the advice on Safe Command Execution when you do this), and then follow the procedure for either a Single Node or Cluster Node.
NetEye Modules¶
Each of these modules has its own, distinct contract and requires NetEye Core. Also the SIEM module dependency from Log Manager has been removed, starting from the 4.12 release and now requires only NetEye Core.
Module |
Requires |
Yum group name |
---|---|---|
Log Manager |
NetEye Core |
neteye-logmanagement |
SIEM |
NetEye Core |
neteye-siem |
vSphereDB |
NetEye Core |
neteye-vmd |
SLM |
NetEye Core |
neteye-slm |
Asset |
NetEye Core |
neteye-asset |
ntopng |
NetEye Core |
neteye-ntopng |
Command Orchestrator |
NetEye Core |
neteye-cmd |
Preview Software¶
Modules of this type can be installed whenever desired, and reside in the NetEye Extras repository.
Module |
Requires |
Yum group name |
---|---|---|
Lampo |
NetEye Core |
lampo |
Tornado |
NetEye Core |
tornado |
Single Node¶
To install a NetEye Module, run the following command with the appropriate Yum group name from the table above:
# yum -y groupinstall <yum-group-name> --enablerepo=neteye
The Preview Software have a slight different syntax:
# yum -y groupinstall <yum-group-name> --enablerepo=neteye --enablerepo=neteye-extras
Here, <yum-group-name> is taken from the table in the Preview Software section
Once done, please follow the procedure needed to update a NetEye single instance, then the directions on section Refreshing the additional module, to complete the overall installation.
Cluster Node¶
Differently from the Single Node, the NetEye Module or Preview Software must be installed on every node of the cluster with the same commands described in the previous section. So, the command(s):
# yum -y groupinstall <yum-group-name> --enablerepo=neteye
# yum -y groupinstall <yum-group-name> --enablerepo=neteye --enablerepo=neteye-extras
must be run on each node of the cluster.
After the yum
installation of the <feature_module> OR
<preview_software>, these additional steps are needed:
Look for the template file having filepath with pattern
/usr/share/neteye/cluster/templates/Services-<name>-*.conf.tpl
(where<name>
is the name of the <feature_module> OR <preview_software> you are installing, and the*
is a wildcard for any string). If any such file does not exist, skip the following steps and go to the next section.If, on the contrary, any such file exists, adapt it to the settings of your cluster, and save it to a file with the same name without the
.tpl
suffix.Now, for each file saved in the previous step, create the cluster resource by executing the following command on one of the nodes of the cluster (replace
<name>
with the name of the <feature_module> OR <preview_software> you are installing, and the*
with the string that completes the actual filename):# /usr/share/neteye/scripts/cluster/cluster_service_setup.pl -c /usr/share/neteye/cluster/templates/Services-<name>-*.conf``
When the execution of the script above has finished, please perform the steps described the procedure to Update a NetEye Cluster.
Example: I want to install the ‘asset’ feature module on a NetEye cluster.
After performing yum groupinstall neteye-asset --enablerepo=neteye
on each node of the cluster, on one node I find the following files
with pattern
/usr/share/neteye/cluster/templates/Services-asset-*.conf.tpl
:
/usr/share/neteye/cluster/templates/Services-asset-glpi.conf.tpl
/usr/share/neteye/cluster/templates/Services-asset-ocsinventory-ocsreports.conf.tpl
/usr/share/neteye/cluster/templates/Services-asset-ocsinventory-server.conf.tpl
I adapt them to my cluster settings (adapt the ip_pre
,
cidr_netmask
and check the drbd_minor
and the
drbd_port
in this case) and save them in the files:
/usr/share/neteye/cluster/templates/Services-asset-glpi.conf
/usr/share/neteye/cluster/templates/Services-asset-ocsinventory-ocsreports.conf
/usr/share/neteye/cluster/templates/Services-asset-ocsinventory-server.conf
I create the cluster resources with the commands::
# /usr/share/neteye/scripts/cluster/cluster_service_setup.pl -c /usr/share/neteye/cluster/templates/Services-asset-glpi.conf
# /usr/share/neteye/scripts/cluster/cluster_service_setup.pl -c /usr/share/neteye/cluster/templates/Services-asset-ocsinventory-ocsreports.conf
# /usr/share/neteye/scripts/cluster/cluster_service_setup.pl -c /usr/share/neteye/cluster/templates/Services-asset-ocsinventory-server.conf
Finally, follow the procedure to Update a NetEye Cluster. To complete the overall installation, please follow the directions on section Refreshing the additional module.
Refreshing the additional module¶
If the procedure you followed above was successful, you can now refresh the additional module with these steps:
Refresh your browser window. This will ensure that the new module appears in the NetEye menu and all Javascript and CSS is reloaded properly.
Log out of NetEye and then log back in so that any permissions or roles required by the new module will take effect.