Navigation :

API Node Installation

Overall Installation Steps

The high-level steps for installing and configuring N2VS API nodes are:

Determine the server(s) that will supply the API logical component, bearing in mind the supported operating systems and minimum server requirements.
Ensure the installation pre-requisites are met.
Install the API package.
Perform any required post-installation steps.
1. Update the API configuration as desired.
Optionally, apply the recommended Apache security configuration.

Installation Pre-requisites

OS-specific Setup

Refer to the specific Red Hat or Debian instructions for any pre-requisites as required.

Apache 2

Apache 2 must be installed prior to installing the N2VS API package. The package to install will depend on your OS type:

RHEL 8	Other RPM-based Systems	DEB-based Systems
`sudo dnf install httpd`	`sudo yum install httpd`	`sudo apt-get install apache2`

The N2VS API package expects that the relevant Apache 2 configuration directory exists. Again, this varies depending on your OS type:

RPM-based Systems	DEB-based Systems
`/etc/httpd`	`/etc/apache2`

Finally, the apachectl program must exist (it is installed as part of the Apache 2 package) and Apache must be running.

Perl

The N2VS API node requires several Perl packages to be available prior to installation. The package names may vary depending on your OS type:

RPM-based Systems DEB-based Systems

perl or perl-interpreter >= 1:5.12
perl(B)
perl(DBI)
perl(DBD::Pg)
perl(Data::Compare)
perl(Data::Dumper)
perl(Date::Format)
perl(DateTime::Format::Pg)
perl(Digest)
perl(Getopt::Long)
perl(JSON)
perl(List::MoreUtils)
perl(MIME::Base64)
perl(POSIX)
perl(Scalar::Util)
perl(Storable)
perl(Time::Local)
perl(XML::LibXML)
perl(boolean)
perl(strict)
perl(warnings) perl >= 5.12
perl-base
perl-modules
libdbi-perl
libdata-compare-perl
libtimedate-perl
libdatetime-format-pg-perl
libjson-perl
liblist-moreutils-perl
libxml-libxml-perl
libboolean-perl

RPM-based Systems	DEB-based Systems
`perl` or `perl-interpreter` >= 1:5.12 `perl(B)` `perl(DBI)` `perl(DBD::Pg)` `perl(Data::Compare)` `perl(Data::Dumper)` `perl(Date::Format)` `perl(DateTime::Format::Pg)` `perl(Digest)` `perl(Getopt::Long)` `perl(JSON)` `perl(List::MoreUtils)` `perl(MIME::Base64)` `perl(POSIX)` `perl(Scalar::Util)` `perl(Storable)` `perl(Time::Local)` `perl(XML::LibXML)` `perl(boolean)` `perl(strict)` `perl(warnings)`	`perl` >= 5.12 `perl-base` `perl-modules` `libdbi-perl` `libdata-compare-perl` `libtimedate-perl` `libdatetime-format-pg-perl` `libjson-perl` `liblist-moreutils-perl` `libxml-libxml-perl` `libboolean-perl`

For each of these packages (or with all as one command), execute the instructions specific to your operating system:

RHEL 8	Other RPM-based Systems	DEB-based Systems
`sudo dnf install <package(s)>`	`sudo yum install <package(s)>`	`sudo apt-get install <package(s)>`

Jarvis

The N-Squared application Jarvis must be installed. Follow the installation steps for this, noting any prerequisites.

The N2VS API package also expects that the default Jarvis configuration directory exists:

/etc/jarvis

Installation Steps

Follow the appropriate installation steps depending on your installation sources.

From N-Squared Repository

Execute the instructions specific to your operating system:

RHEL 8	Other RPM-based Systems	DEB-based Systems
`sudo dnf install n2vs-api`	`sudo yum install n2vs-api`	`sudo apt-get install n2vs-api`

As Manual Installation

Transfer the provided package file to the target node, then follow the instructions specific to your operating system.

Execute (adjusting as appropriate for package location and version details) the following:

RPM-based Systems	DEB-based Systems
`sudo rpm -Uvh /path/to/n2vs-api-M.m.p-b.noarch.rpm`	`sudo dpkg -i /path/to/n2vs-api_M.m.p-b_all.deb`

Post-Installation Steps

GUI and Identity Management Integration

The Jarvis configuration on the API must be updated for API integration with the GUI node and the identity management platform. See the API configuration documentation for more information.

Database Integration

In the file /etc/jarvis/n2vs-admin.xml, locate the following section:

        <database connect="dbi:Pg:dbname=n2in;host=REPLACE_WITH_DB_ADDRESS;port=REPLACE_WITH_DB_PORT"
                  username="n2vs_web" password="REPLACE_WITH_DB_PASSWORD"/>

Replace the sentinel values as follows:

REPLACE_WITH_DB_ADDRESS must be updated to the address of the primary database node (or proxy) to connect to.
REPLACE_WITH_DB_PORT must be updated to the listening port configured for the primary database node (or proxy).
REPLACE_WITH_DB_PASSWORD must be updated to the n2vs_web database user’s password, as created during database preparation.

Locate the same section in the file /etc/jarvis/n2vs.xml and repeat the sentinel replacements.

Firewall

The firewall (if any) on the API node must be updated to allow:

Inbound user and API requests on the listening Apache port(s).
Outbound database requests to the SMF database nodes.
Outbound HTTP requests to the backend HTTP service nodes.

For example:

firewall-cmd --zone=public --add-port=80/tcp --permanent
firewall-cmd --zone=public --add-port=443/tcp --permanent
service firewalld restart

SELinux

If SELinux is in use, Apache must be allowed to initiate proxy connections. To enable this, execute:

sudo /usr/sbin/setsebool -P httpd_can_network_connect 1

Session Security

Jarvis allows for session security to be increased by configuring a number of configuration parameters. In particular, the following parameters may be updated:

app => csrf_protection
app => cross_origin_protection
app => xsrf_protection
app.sessiondb.parameter => Path
app.sessiondb.parameter => Domain
app.sessiondb.parameter => Secure

Refer to the Jarvis documentation for more details. Further information is also available in the documentation for the Perl modules CGI::Session and CGI::Cookie.