Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/dataclassification/5.7/dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ The Dashboard administration area provides a selection of tools to review applic

The default screen shows a high-level overview of Netwrix Data Classification statistics, displaying
the last active times of each service (with inactive services shown in red). Select the "i" icon
next to each date to view the name of the active server as well as batch processing statistics. You
will also view the processing throughput.
next to each date to view the name of the active server as well as batch processing statistics.
If you have Distributed Query Server enabled, any instances that are missing their encryption key
will also be displayed. You will also view the processing throughput.

The following statistics are available for each thread type:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,88 +1,82 @@
---
title: "NDC Server Cluster"
description: "Configuring NDC Servers Cluster and Load Balancing with DQS Mode"
description: "Configuring an NDC Server Cluster and Load Balancing with DQS Mode"
sidebar_position: 10
---

# Configuring NDC Servers Cluster and Load Balancing with DQS Mode
# Configuring an NDC Server Cluster and Load Balancing with DQS Mode

The Distributed Query Server (DQS) mode allows you to balance the load between multiple Netwrix Data
Classification Servers (NDC Servers) while data collection, indexing and classification. This
approach is strongly recommended if you need to process large data volumes, for example:
The Distributed Query Server (DQS) mode allows you to balance the processing load of data collection,
indexing and classification over multiple Netwrix Data Classification Servers (NDC Servers) with a single shared database.
This approach is strongly recommended if you need to process large data volumes, for example:

- File Servers—Up to 64 m objects per cluster of 4 servers.
- SharePoint—Up to 32 m objects per cluster of 4 servers.
- File Servers — recommended if processing over 16m objects,
supports up to 64 m objects per cluster of 4 servers.
- SharePoint — Recommended if processing over 8m objects,
supports up to 32 m objects per cluster of 4 servers.

To apply Distributed Query Server mode, you need to arrange your NDC Servers in a 'cluster' for load
distribution, as described below. Each clustered NDC Server will store its own set of .CSE files —
that is, **NDC Index** will be a distributed index. To assemble and combine data required for the
To make use of Distributed Query Server mode, you need to arrange your NDC Servers in a 'cluster' for load
distribution as described below. Each clustered NDC Server will store its own set of .CSE index files,
thus distributing the index over the clustered servers. To assemble and combine data required for the
search results, each NDC Server will automatically communicate with the other clustered servers.

:::note
All NDC Servers in the cluster will share a single NDC SQL database.
:::

This functionality is implemented through the _Query Server_ functionality of NDC Server.

This functionality is implemented through the _QueryServer_ application installed together with NDC
Server.
## Configuring DQS Mode

## Applying DQS Mode
DQS mode is configured via the administrative web console and, from version 5.7.10 onwards, the installer.

DQS mode can be configured via the administrative web console.
### Preparation

If you want to implement DQS configuration for your NDC deployment, consider the following:
- This action cannot easily be undone so, before applying the DQS mode, take a full backup of your
NDC deployment. Also, read the DQS documentation sections thoroughly before you start.
- Make sure all servers you plan to add to the DQS cluster have a network connection and are
visible to each other across the network. Adjust your firewall settings if necessary.

- This action cannot easily be undone, so before applying the DQS mode, take a full backup of your
NDC deployment. Also, read the related documentation sections thoroughly before you start.
- Make sure all servers you plan to add to the DQS cluster have proper network connection and are
visible to each other across the network. Adjust firewall settings if necessary.
- Initially, all existing documents will be ‘allocated’ to the first server in the 'cluster' and
then re-distributed across all configured servers.
DQS mode can only be configured by a user whose account has the **Superuser** role.

To be able to configure the DQS mode, current account requires a **Superuser** role.
:::note
Once DQS mode is enabled, you cannot roll back your configuration. Netwrix
strongly recommends ensuring that you have taken a full backup of your environment prior to enabling DQS.
:::

To arrange NDC Servers cluster and apply DQS mode
### Enabling DQS Mode (5.7.9 and earlier versions)

1. Install and configure the first Netwrix Data Classification Server as described in the
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section.
2. Open administrative web console.
3. Navigate to Settings → Utilities → DQS.
2. Open the administrative web console.
3. Navigate to Settings → Config → Utilities → DQS.
4. Select Enable DQS.

:::note
Once the DQS mode is enabled, you cannot roll back your configuration. Netwrix
strongly recommends to ensure that you have taken a full backup of your environment. If ready,
confirm the DOS enablement operation when prompted.
:::


5. On the DQS tab, click Add to add servers you prepared, one by one.
5. On the DQS tab, click Add to open the DQS addition menu, and input the details for the first additional NDC server.

![dqs_mode_page_thumb_0_0](/images/dataclassification/5.7/requirements/dqs_mode_page_thumb_0_0.webp)

Complete the following fields:
Fill in the following fields:

| Setting | Value |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Server | Provide the NDC Server name or IP address (name format is case-insensitive). |
| QS Path | Path to the solution component responsible for DQS mode, residing on the server being added. Filled in automatically; leave the default value. |
| Active | Select to enable clustering for the instance being added. |
| Alternate Server | Netwrix recommends using default values. |
| Alternate QS Path | Netwrix recommends using default values. |

6. Click **Save** to close the dialog.
7. Prepare to install other Netwrix Data Classification Server instances, assuming each server
requires a dedicated machine. Make sure they meet the
| Server | The NDC Server name or IP address (name format is case-insensitive). |
| QS Path | The path to the solution component responsible for DQS mode, residing on the server being added. This is filled in automatically when filling in the server name; leave the default value. | |
| Alternate Server | Optional, Netwrix recommends using default values. |
| Alternate QS Path | Optional, Netwrix recommends using default values. |

6. Click **Save** to close the dialog. Repeat steps 5 and 6 for each server you intend to add.
7. Prepare to install the other Netwrix Data Classification Server instances on their dedicated servers. To make best use of resources, each NDC server
requires a dedicated machine. Make sure each server meets the
[Hardware Requirements](/docs/dataclassification/5.7/introduction/requirements/hardwarerequirements.md) and general
[Software Requirements](/docs/dataclassification/5.7/introduction/requirements/softwarerequirements.md)
8. On each server, follow the installation steps as described in the
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section until SQL Database
configuration.
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section up to the SQL Database
configuration step.
9. On the SQL Database step, provide the name of the SQL Server instance that hosts NDC SQL database
you configured for the first NDC Server.

:::note
Ignore the confirmation dialog on the existing schema in the selected SQL database.
Ignore the confirmation dialog informing you of the existing schema in the selected SQL database.
:::


Expand All @@ -92,14 +86,63 @@ Ignore the confirmation dialog on the existing schema in the selected SQL databa

![dqs_servers_list_thumb_0_0](/images/dataclassification/5.7/requirements/dqs_servers_list_thumb_0_0.webp)

12. If you were configuring the DQS mode for the existing NDC deployment, you will be prompted to
re-collect data from the data sources —in order to re-distribute the content index across all
NDC Servers in the cluster.
### Enabling DQS Mode (5.7.10 and later versions)

:::note
To force re-distribution when necessary, you can use the Re-Collect command available
after clicking **Run Cleaner** button on the **Settings > Core > Collector** tab.
:::
1. Install and configure the first Netwrix Data Classification Server as described in the
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section.
2. Open the administrative web console.
3. Navigate to Settings → Config → Utilities → DQS.
4. Select Enable DQS.
5. Prepare to install other Netwrix Data Classification Server instances. Make sure each NDC server meets the
[Hardware Requirements](/docs/dataclassification/5.7/introduction/requirements/hardwarerequirements.md) and general
[Software Requirements](/docs/dataclassification/5.7/introduction/requirements/softwarerequirements.md)
6. On each server, follow the installation steps as described in the
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section up to the SQL Database
configuration step.
7. On the SQL Database step, provide the details of the SQL Server instance that hosts the NDC SQL database
you configured for the first NDC Server.
8. When you click next, a message box should appear stating that an NDC configuration was detected and
that the new install will be added to the existing DQS environment - click OK.

:::note
When upgrading an existing NDC instance the installer will attempt to resynchronise the DQS instances in the
background and, if successful, will skip the DQS Synchronisation step. You can then skip ahead to step 13. The DQS Synchronisation
step will only display for an upgrade if this process fails - this is not an issue, simply follow the steps below
to resynchronise the NDC instance with the primary NDC server.
:::

9. The Primary NDC Server Url field should have the server url of the primary NDC server (i.e. the first row in the DQS table)
automatically inserted. If it is not present or is incorrect, enter the address from the QS Path column of the first row of
the DQS table. Then click Connect to connect the installer to that server.
10. Once the installer has successfully connected to the primary NDC server, it will generate an authentication
code and display it in the Authentication Code field. Click Sync to open the NDC DQS settings page in a web browser.
11. On the web page, click on Register/Resync. This will open the authentication code entry tab - the authentication code generated by the installer
should be present in the input field. Click Submit to submit the authentication code.

:::note
If the authentication code is not autofilled, click on the Authentication Code field in the installer to copy the
value to your clipboard, then paste it in the authentication code field in the NDC UI.
:::

12. The Register/Resync tab should now display an 8-digit verification code. Copy this, paste it into
the Verification Code field in the installer, then click Join. The NDC installer will then perform
the resynchronisation.
13. Complete the installation.
14. Repeat steps 6 - 13 for each other new NDC Server, then review the list of servers to make sure all new
servers have been successfully added.

![dqs_servers_list_thumb_0_0](/images/dataclassification/5.7/requirements/dqs_servers_list_thumb_0_0.webp)


If you were configuring the DQS mode for an existing NDC deployment, you will be prompted to
re-collect data from the data sources in order to re-distribute the content index across all
NDC Servers in the cluster. This will result in all data sources being recollected, which may
take a significant amount of time.

:::note
To force re-distribution when necessary, you can use the Re-Collect command available
after clicking **Run Cleaner** button on the **Settings > Core > Collector** tab.
:::


To review system health and check your configuration, use the product dashboards.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ sidebar_position: 10

# NDC Server

Netwrix Data Classification **Server** can be deployed on a physical server or on a virtual machine
in the virtualized environment on VMware or Microsoft Hyper-V platform.
Netwrix Data Classification **Server** can be deployed on a physical server or on a virtual machine via software such as
VMware or the Microsoft Hyper-V platform.

When planning for NDC Server, consider a significant CPU load during data processing. Thus,
installing NDC Server on a highly-loaded production machine is not recommended. For more
information, refer to [Hardware Requirements](/docs/dataclassification/5.7/introduction/requirements/hardwarerequirements.md).
Installing NDC Server on a highly-loaded production machine is not recommended - NDC data
processing is highly resource intensive, and sharing resources with other programs and
processes will decrease the performance of both NDC and the other processes. For more information,
refer to [Hardware Requirements](/docs/dataclassification/5.7/introduction/requirements/hardwarerequirements.md).

**Web-based client** (management console) is always installed together with the NDC Server, so the
A **web-based client** (management console) is always installed together with the NDC Server, so the
IIS server role must be enabled on the target machine. For more information, refer to
[Software Requirements](/docs/dataclassification/5.7/introduction/requirements/softwarerequirements.md).

Expand All @@ -24,12 +25,11 @@ machine image with pre-installed Netwrix Data Classification on Generalized Wind
[Requirements to Deploy Virtual Appliance](/docs/dataclassification/5.7/introduction/virtualappliance/systemrequirements.md).
:::


Remember that for production environments, your NDC Server and database server must meet the
[Requirements to Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/requirements/overview.md). Virtual
appliance configuration is insufficient for production and is not recommended for that purpose.
[Requirements to Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/requirements/overview.md). The virtual appliance configuration is insufficient
for production and is not recommended for that purpose.

To balance the load while indexing and classifying data in the large-size and extra-large
environments (i.e. with over ≥ 16 mln objects to process), it is strongly recommended to deploy
several NDC Servers and configure **Distributed Query Server** mode for them.
To balance processing load while collecting indexing and classifying data in large-size and extra-large
environments (i.e. 16m+ objects to process), it is strongly recommended to deploy
multiple NDC Servers and configure **Distributed Query Server** mode for them.
[See Configuring NDC Servers Cluster and Load Balancing with DQS Mode for more information.](/docs/dataclassification/5.7/introduction/deployment/ndcserverandclient/dqsmode.md)
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 50

# Configure Health Alerting

On this step, you will be prompted to email settings for health reporting and select immediate
On this step, you will be prompted to set email settings for health reporting and select immediate
health alerts.

![initial_config_health](/images/dataclassification/5.7/install/initialconfiguration/initial_config_health.webp)
Expand All @@ -16,6 +16,6 @@ Complete the following fields:
| Setting | Description |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Would you like to configure Health Reporting? | Select Setup now if you want to receive health alerts. You can do it later in the communication settings area. [See System Health for more information.](/docs/dataclassification/5.7/dashboards.md) |
| Who should the email be sent from? | Select a user registered in Netwrix Data Classificationadministrative web console in the field or go to the Specific recipients below and specify one or more email addresses outside your organization. |
| What sort of immediate alerts should be sent? | Select the appropriate alerting level: do not receive any alerts at all, receive errors only, or get both: emails for errors and warnings. [See System Health for more information.](/docs/dataclassification/5.7/dashboards.md) |
| Should a daily health summary be sent? | Select whether you want to receive daily summary on the product health. |
| Who should the email be sent from? | Select a user registered in Netwrix Data Classification administrative web console in the field or go to the Specific recipients below and specify one or more email addresses outside your organization. |
| What sort of immediate alerts should be sent? | Select the appropriate alert level for the emails you wish to receive: do not receive any alerts at all, only receive alerts for errors, or get emails for both errors and warnings. [See System Health for more information.](/docs/dataclassification/5.7/dashboards.md) |
| Should a daily health summary be sent? | Select whether you want to receive daily summary on the current health status of NDC. |
Loading
Loading