Setting up NuoDB Admin

NuoDB AdminAn interface for domain and database management. Introduced in NuoDB 4.0 to supersede NuoAgent, this interface is used to manage an admin domain. Use NuoDB Admin instead of NuoAgent to start and stop APs. When using NuoDB Admin to manage a domain and its databases, use NuoDB Command (nuocmd) instead of the NuoDB Manager (nuodbmgr) Command Line Interface (CLI) tool. See also Admin Process (AP). (nuoadmin) is the default admin interface for domain and database management in NuoDB 4.0 (see Using NuoDB Admin for Domain and Database Management).

Note: Although deprecated from the release of NuoDB 4.0, NuoAgent (NuoDB's legacy domain and database management admin interface), and its NuoDB Manager management tool, is also supported. For more information, see Physical or VMware Environments (NuoAgent) and NuoDB Manager.

Configuring nuoadmin.conf

Before starting NuoDB Admin, use a text editor to configure the nuoadmin.conf admin server configuration file. The peering, or joining of a NuoDB Admin process, into an admin domain's initial membership is achieved by setting the initialMembership property in nuoadmin.conf.

Note: To locate nuoadmin.conf, go to the /etc/nuodb directory (where NuoDB was installed using either RPM or the Debian Package Utility) or go to $NUODB_HOME/etc (where NuoDB was installed using a TAR file).

The following excerpt from nuoadmin.conf provides settings for an initial admin process defined on a host machine name called host1, which is also the initial member in the admin domain:

{
"initialMembership": {
"server0" : { "transport" : "host1:48005", "version" : "0:10000" }
},
"ThisServerId" : "server0",
"agentPort" : "48004",
"agentBindAddress" : "",
"adminPort" : "48005",
"portRange" : "48006",
"adminBindAddress" : "",
"altAddr" : "Host1",
…

Note: In this example localhost has been replaced by the value host1 for both the IntialMembership section and value for the altAddr property.

Note: The peer property may be used in nuoadmin.conf to specify entry peer. For more information on using the peer property, see Host Properties (nuoadmin.conf) and About Admin Processes and Peering.

TLS Admin Management Security

By default TLS admin management security is enabled. This results in NuoDB Command (nuocmd)CLI command authentication and encryption across the network.

To enable TLS Admin management security, opt for either the Shared or Unique Admin Key trust model and generate the required keys and certificate files. For additional information, see the NuoDB documentation page, Enabling TLS Encryption.

If you're conduction an evaluation of or proof of concept for NuoDB and would like to disable TLS admin management, simply edit the nuoadmin.conf file and set the ssl property to false.

"ssl": "false"

For more information on TLS Encryption, see Configuring NuoDB Admin.