Last updated: 2019-06-27

Prerequisites for the Configuration Database

This page describes the prerequisites for successfully installing and running the Configuration Database. The Configuration Database is a SQL Server database and is installed in a SQL Server instance.

Nodinite Configuration Database Checklist

The Configuration Database sits in the middle of the "spider web" and on a single box machine you may have virtually no administration at all to get everything working. On the other hand, in a locked down distributed environment spanning multiple servers with network load balancing, firewalls, network zones (WLAN's), domains, DNS, group policies, anti virus/antimalware you may end up spending a lot of hours to get every piece of the puzzle in place.

Rest assure, Nodinite is built on Microsoft standard products and these form the very foundation for most enterprise business applications today. We are working hard on cloud enabling Nodinite as the required services mature one piece at a time to make sure you get a future proof solution for your business.

Verified Topic
SQL Server
MSDTC
Windows rights
Trusted for delegation
Register SPN
Database rights
Firewall
Linked Server(s)

Use the checklist above to verify that you have performed all steps required to get Nodinite flying


SQL Server

Nodinite is designed to be implemented according to customer needs and all modern SQL Server versions are supported (Enterprise, Standard, Express):

  • SQL Server 2017
  • SQL Server 2016
  • SQL Server 2014
  • SQL Server 2012
  • SQL Server 2008 R2

Note: It's you (or your IT-organization/hosting partner/...) responsibility to make sure the Configuration Database is regularly being backuped, at least once per day

You can run SQL Server on Windows Servers implemented on physical machines, virtual machines and in the cloud. Actual Windows version used must match the prerequisites for SQL Server version being used.

To maximize your experience with Nodinite you should implement all suggestions below:

  • Nodinite should run in dedicated SQL instances in order to guarantee/dedicate HW resources and avoid competing demands for resources, aid in the troubleshooting and avoid blame game situations
    • At least assign dedicated disk volumes for the Log Databases to make sure extended logging does not fault any other system/service
  • Keep the Logging Service close to the SQL Servers hosting the Log Databases for Nodinite

Do repeat optimizations below on ALL SQL Server instances (Configuration Database, Log Databases, BizTalk Databases)

  • Use -T1118 Trace flag on SQL Instances - Optimizes TEMPDB
  • Disable PAC Verification if your policy allows for this option to be set on all Windows Servers running any of Nodinite Core Services - Less RPC calls, improves performance
  • Nodinite should be installed on machines with dedicated Windows swap volumes (>2,5*physical RAM) and SQL discs should have > 300 MB/S R/W.
  • There should be a secured backup volume (or network share) available with sufficient free space for Nodinite databases
  • Windows Servers hosting any of the Core Services should have at least 16GB RAM. Environments with large number of messages logged and processed may need additional RAM
  • For each core assigned with your SQL Instance (up to 8), create 1 tempdb file with 128 MB in size (no autogrowth)

    If you have 14 cores that means you have 8 tempdb files. Putting the tempdb files on different volumes may increase overall performance of your system

  • Nodinite Log Databases when used together with BizTalk should be kept in Simple recovery mode (default)

Microsoft Distributed Transaction Coordinator (DTC)

The Configuration Database is involved in all SQL Server related operations and Nodinite uses the Windows Service Microsoft Distributed Transaction Coordinator (DTC) that is responsible for coordinating transactions that span multiple resource managers. We have written a dedicated tutorial for Nodinite with our best practices for how to install and configure the DTC Windows Service.

You must configure the DTC as documented otherwise Nodinite will not be able to function

What Windows rights does the Configuration Database require?

Nodinite keeps the identity of the user account for running Core Services related threads when traversing servers on your network. This means for example that when the Logging Service fetches data from BizTalk tracking database it will be the configured account that actually performs the remote operation. In order for the Windows Integrated Security to be able to pass and authenticate the user identity across servers all tasks outlined in the checklist in the beginning of thus tutorial must be properly configured.

The Configuration Database is a SQL Server database and is installed as part of the Core Services package. Since the Configuration Database is a SQL Server database You must use a Windows account that has been configured with the appropriate rights in SQL Server, see SQL Server database rights.

In order for Kerberos to work then the servers must be properly configured:

Trusted for delegation

sequenceDiagram opt Kerberos TGT Logging Service ->> Domain Controller: Service account credentials Domain Controller ->> Logging Service: Kerberos TGT end opt Service ticket Logging Service ->> Domain Controller: Send TGT to request a service ticket Domain Controller ->> Logging Service: service ticket end Logging Service ->> SQL (Configuration Database): Client TGT and service ticket opt SQL service ticket SQL (Configuration Database) ->> Domain Controller: Clients TGT to request a service ticket Domain Controller ->> SQL (Configuration Database): service ticket end SQL (Configuration Database) ->> BizTalk SQL (BizTalkMgmtDb): Client TGT and SQL service ticket BizTalk SQL (BizTalkMgmtDb) ->> SQL (Configuration Database): Response SQL (Configuration Database) ->> Logging Service: Response

anonymous Common error for problems related to not having trusted for delegation

Note: A restart is required if this settings is changed in the Active Directory

Make sure to run the following command to make sure your server gets the new configuration (allow some time for your Domain Controllers to replicate new setting first)

gpupdate /force

Register SPN

When running Nodinite in a distributed environment, Kerberos requires all SQL Instances (both physical node names and cluster names) have its SPNs registered in Active Directory.

Example1: If you have a single box server with BizTalk, SQL Server and Nodinite you don't have to register the SPN (not a distributed environment)

Example2: If you have Nodinite Configuration Database installed on one Windows Server with a SQL default instance and BizTalk in another two node fail over cluster running 2 SQL instances (1 default and 1 named instance), one for other BizTalk databases and one dedicated for the messagebox (BizTalkMSGBoxDb) you will have to register 7 SPNs in total (1 for Nodinite, 3 for the BizTalk instance, 3 for the BizTalk Messagebox instance)

  1. SQL Server name for default instance with Nodinite Configuration Database
  2. SQL Server first node name for default instance with BizTalk databases
  3. SQL Server second node name for default instance with BizTalk databases
  4. SQL Server cluster name for default instance with BizTalk databases
  5. SQL Server first node name for named instance with messagebox database
  6. SQL Server second node name for named instance with messagebox database
  7. SQL Server cluster name for named instance with messagebox database

SQL Server Default Instance

The following example registers accountname for the default SQL Instance using an elevated command prompt (requires 'Domain Admin' rights):

setspn -A MSSQLSvc/myhost.redmond.microsoft.com accountname

SQL Server Named Instance

The following example registers accountname for the named SQL Instance using an elevated command prompt (requires 'Domain Admin' rights): repeat for each combination of named instance /accountname)

setspn -A MSSQLSvc/myhost.redmond.microsoft.com:instancename accountname

What SQL Rights does the Configuration Database require?

For performance reasons the Configuration Database accesses the databases directly using the Windows Service Account configured. The Configuration Database must have the following SQL rights assigned:

graph LR subgraph SQL Server roConfigDatabase(fal:fa-database Configuration database) --- |Linked Server| roLogDatabase(fal:fa-database fal:fa-database fal:fa-database Log databases) end subgraph Application Server roLoggingService(fa:fa-hdd Configuration Database) --- roConfigDatabase end

All SQL Instance(s) where Configuration Database and Log Databases are installed:

  • public - Rights to logon to instances and databases
  • dbcreator - Rights to create new Log Databases
  • diskadmin - Rights to create the database files in Windows for new Log Databases
  • securityadmin - Rights to assign rights on new Log Databases
  • db_ddladmin - se note below
  • Shrink Rights - Old Log Databases must be shrinked to regain allocated disk space, and the shrink operation requires membership in the sysadmin fixed server role or the db_owner fixed database role. See more here

Note: db_ddladmin is required in order for the service account to have proper rights to read statistics. Without this permission performance may be degraded, especially true for remote servers (linked servers). Read more here. Contact our support if you have any questions about this.

All Nodinite specific databases

  • Configuration Database

    • db_datareader
    • db_datawriter
    • db_ddladmin
    • sysadmin or at least db_owner
  • Log Databases (can be multiple )

    • db_datareader
    • db_datawriter
    • db_ddladmin
    • sysadmin or at least db_owner

Note: **See specific text for SQL instance above for membership in either sysadmin and/or db_owner for automatic shrink of Nodinite related Log Databases

What Firewall settings are required for the Configuration Database?

The Configuration Database requires both inbound and outbound ports to be opened. Since Nodinite is highly configurable, the actual ports in use may differ from what's being exampled here.

The following image shows which Core Services are using the Configuration Database:

graph LR subgraph SQL Server roConfigDatabase(fal:fa-database Configuration database) --- |Linked Server| roLogDatabase(fal:fa-database fal:fa-database fal:fa-database Log databases) end subgraph Application Server roLogAPI(fal:fa-cloud-download Log API) --- |SQL, DTC, DNS, RPC, ...|roConfigDatabase roWebAPI(fal:fa-cloud Web API) roWebAPI --- |SQL, DTC, DNS, RPC, ...|roConfigDatabase roLoggingService(fal:fa-hdd Logging Service) --- |SQL, DTC, DNS, RPC, ...|roConfigDatabase roMonitoringService(fal:fa-watch-fitness Monitoring Service) --- |SQL, DTC, DNS, RPC, ...|roConfigDatabase end
  1. TCP Ports between Configuration Database and Core Services
  2. TCP Ports between Configuration Database and Log Databases / BizTalk SQL Server

The Log API, Web API, Logging Service and the Monitoring Service accesses the Configuration Database using the configured Windows Service Account.

1. TCP Ports between Configuration Database and Core Services

  • RPC Ports, kerberos 88 TCP
  • SQL Server ports, usually 1433, depends on your actual configuration
  • DTC - Facilitates transactional support
  • DNS - Windows needs to know where your servers are (can of course also be solved using hosts)
    • 53 both TCP/UDP

2. TCP Ports between Configuration Database and Log Databases / BizTalk SQL Server

The following Windows Components are accessing the Configuration Database and used/configured ports must be allowed, follow each link for details:

graph LR subgraph SQL Server Hotel roLogDatabase2(fal:fa-database fal:fa-database fal:fa-database Log databases) end subgraph SQL Server roConfigDatabase(fal:fa-database Configuration database) --- |Linked Server| roLogDatabase(fal:fa-database fal:fa-database fal:fa-database Log databases) end subgraph BizTalk SQL Server roBizTalkMGMTDB(fal:fa-database BizTalkMGMTDb) end subgraph BizTalk SQL Server 2 roBizTalkDTADb(fal:fa-database BizTalkDTADb) end roConfigDatabase -.Linked Server.-roBizTalkMGMTDB roConfigDatabase -.Linked Server.-roBizTalkDTADb roConfigDatabase -.Linked Server.-roLogDatabase2

Prior to installing Nodinite a SQL DBA must add the following linked servers (match the conditions that apply for your environment):

  • localhost
  • localhost\instancename
  • remote SQL Server (with historical databases)
  • remote SQL Server\instancename (with historical databases)
  • remote BizTalk SQL Server with:
    • BizTalkDTADb
    • BizTalkMGMTDb

The BizTalk database(s) named above must be added as linked servers (even for localhost). Make sure to set the 'be made using the login's current security context' option on the security setting of the linked server connection.

To add a linked server in SQL use the following commands:

EXEC sp_addlinkedserver @server = 'LOCALHOST\instance';
EXEC sp_serveroption 'LOCALHOST\instance', 'rpc', true;
EXEC sp_serveroption 'LOCALHOST\instance', 'rpc out', true;

Running the SQL MMC you should now be able to retrieve the list of databases (including BizTalk management database and BizTalk tracking database) available on the BizTalk SQL instances.
linkedserver

Note: For single box solutions the Kerberos security protocol is not activated, however for distributed solutions, for example when Nodinite is installed on one (or more) server(s) and the databases are located elsewhere, the logins used for linked server must use the Kerberos protocol. Using SQL Server in mixed mode allows you to impersonate a Windows account to use a SQL account totally bypassing Kerberos related problems. We urge you to only use this solution as a temporary solution until you have resolved your Kerberos related problems.

Frequently asked questions

Common problems and FAQ for the Configuration Database can be found in the troubleshooting page.

Where do I add my custom built Search Field Plugins?

You simply copy the DLL to the 'Plugins' folder of the Configuration Database. If the DLL is being replaced then you must restart the Configuration Database.

Note: Make sure the DLL after the copy paste operation is not blocked by Windows. Right click on the DLL and select properties. Click on the Unblock button if it exists


Next Step

Install Nodinite
System Parameters