ManageApp

Management Application Configuration

The N2SVCD Management Application provides a simple HTTP server to which operators can connect in order to view the current N2SVCD running configuration. Drilldown links allow operators to monitor in-use resources (e.g. to check connection status, and to review long-running calls in progress).

When the N2SVCD is running, you can connect your web browser to the N2SVCD Management interface at the address http://<n2svcd-host>:8088/, or other port number as may be configured.

In addition:

• The same port number provides a HTTP/JSON API.
• The svcmanage command-line tool also provides run-time Management functions.

Note that the ManageApp is quite distinct from the WatchdogApp:

• The WatchdogApp is mandatory, while ManageApp is entirely optional.
• The WatchdogApp is never forked, but ManageApp may be forked.
• The WatchdogApp is responsible for Shutdown on Signals, and Heartbeats.
• The ManageApp supports query, trace, and management of applications and instances.

You should only ever require one Management Application instance within the N2SVCD, although it is possible to run multiple apps (as long as each one listens on a distinct TCP port number). You don’t need to run any Management Application at all, although not doing so means that you will not have the ability to query the status of your running services.

The following configuration is used to create a Management Application instance.

<?xml version="1.0" encoding="utf-8"?>
<n2svcd>
  ...
  <applications>
    ...
    <application name="Manager" module="ManageApp">
      <include><lib>../apps/manage/lib</lib></include>
      <parameters>
        <parameter name="http_host" value="10.42.2.154"/>
        <parameter name="http_port" value="8088"/>
        <parameter name="security" value="sha1"/>
        <!-- Overridden by "config.users". -->
        <parameter name="admin_password" value="LSNb2Q/UBFfpT.hd:gdiyvTHqk+lnJqogbloOBzTGIC8"/>
        <parameter name="user_password" value="SuLk1c4I3tAEV4lj:TTHJaIHmkGxQKf+4Z3bZE2d48Cg"/>
        <parameter name="identifier" value="Production 01"/>
      </parameters>
      <config>
          <!-- Overrides "admin_password" and "user_password". -->
          <users>
              <user name="fred" password="Gff1KoM88MkbCSSg:WRjvf1HPmI9fKcXDddkEETtBzh0" is_admin="true" />
              <user name="wilma" password="noupxm9rVbJvTbTD:ocLjUrhD6lx5UTguRvcw0p4q2RQ" />
          </users>
      </config>
    </application>
    ...
  </application>
  ...
</n2svcd>

Configuration Details

The application element attributes for a Manage Application instance may include the below.

For details of the various parameter types used, refer to Common Configuration.

User Configuration

Individual users may be configured within the config.users section.

<?xml version="1.0" encoding="utf-8"?>
<n2svcd>
  ...
  <applications>
    ...
    <application name="Manager" module="ManageApp">
      ...
      <config>
          <!-- Overrides "admin_password" and "user_password". -->
          <users>
              <user name="fred" password="LSNb2Q/UBFfpT.hd:gdiyvTHqk+lnJqogbloOBzTGIC8" is_admin="true" />
              <user name="wilma" password="SuLk1c4I3tAEV4lj:TTHJaIHmkGxQKf+4Z3bZE2d48Cg" />
          </users>
      </config>
    </application>
    ...
  </application>
  ...
</n2svcd>

Each user element has the following parameters:

Note that if any user definitions are configured, the admin_password and user_password parameters are not used. However, such users may be explicitly defined with matching usernames if required, e.g.:

<users>
    <user name="admin" password="LSNb2Q/UBFfpT.hd:gdiyvTHqk+lnJqogbloOBzTGIC8" is_admin="true" />
    <user name="user" password="SuLk1c4I3tAEV4lj:TTHJaIHmkGxQKf+4Z3bZE2d48Cg" />
    ...
</users>

Generating Hashed Passwords

When using the sha1 and bcrypt methods to store passwords, the value to be written into the database must be generated using the mkpasswd program supplied with the n2svcd daemon. This program is normally installed as /usr/share/n2svcd/bin/mkpasswd.

$ cd /usr/share/n2svcd/bin
$ ./mkpasswd sha1
Password:
Re-Enter:
[Encrypted] = SuLk1c4I3tAEV4lj:TTHJaIHmkGxQKf+4Z3bZE2d48Cg

Example Management Page

An example management page is:

Message Handling

In addition to the common Application management messages, the ManageApp uses the following messages:

• MANAGEMENT Messages (!MANAGEMENT-*-REQUEST outbound).