Skip to content

Commit 07d54cf

Browse files
BenHayman-NetwrixBenHayman-Netwrix
committed
updated documentation for 5.7.10
1 parent cf5fd22 commit 07d54cf

File tree

11 files changed

+177
-102
lines changed

11 files changed

+177
-102
lines changed

‎docs/dataclassification/5.7/dashboards.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ The Dashboard administration area provides a selection of tools to review applic
1212

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

1819
The following statistics are available for each thread type:
1920

‎docs/dataclassification/5.7/introduction/deployment/ndcserverandclient/dqsmode.md‎

Lines changed: 97 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,82 @@
11
---
22
title: "NDC Server Cluster"
3-
description: "Configuring NDC Servers Cluster and Load Balancing with DQS Mode"
3+
description: "Configuring an NDC Server Cluster and Load Balancing with DQS Mode"
44
sidebar_position: 10
55
---
66

7-
# Configuring NDC Servers Cluster and Load Balancing with DQS Mode
7+
# Configuring an NDC Server Cluster and Load Balancing with DQS Mode
88

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

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

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

2123
:::note
2224
All NDC Servers in the cluster will share a single NDC SQL database.
2325
:::
2426

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

26-
This functionality is implemented through the _QueryServer_ application installed together with NDC
27-
Server.
29+
## Configuring DQS Mode
2830

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

31-
DQS mode can be configured via the administrative web console.
33+
### Preparation
3234

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

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

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

44-
To arrange NDC Servers cluster and apply DQS mode
47+
### Enabling DQS Mode (Up to 5.7.9)
4548

4649
1. Install and configure the first Netwrix Data Classification Server as described in the
4750
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section.
48-
2. Open administrative web console.
49-
3. Navigate to Settings → Utilities → DQS.
51+
2. Open the administrative web console.
52+
3. Navigate to Settings → Config → Utilities → DQS.
5053
4. Select Enable DQS.
51-
52-
:::note
53-
Once the DQS mode is enabled, you cannot roll back your configuration. Netwrix
54-
strongly recommends to ensure that you have taken a full backup of your environment. If ready,
55-
confirm the DOS enablement operation when prompted.
56-
:::
57-
58-
59-
5. On the DQS tab, click Add to add servers you prepared, one by one.
54+
5. On the DQS tab, click Add to open the DQS addition menu, and input the details for the first additional NDC server.
6055

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

63-
Complete the following fields:
58+
Fill in the following fields:
6459

6560
| Setting | Value |
6661
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
67-
| Server | Provide the NDC Server name or IP address (name format is case-insensitive). |
68-
| QS Path | Path to the solution component responsible for DQS mode, residing on the server being added. Filled in automatically; leave the default value. |
69-
| Active | Select to enable clustering for the instance being added. |
70-
| Alternate Server | Netwrix recommends using default values. |
71-
| Alternate QS Path | Netwrix recommends using default values. |
72-
73-
6. Click **Save** to close the dialog.
74-
7. Prepare to install other Netwrix Data Classification Server instances, assuming each server
75-
requires a dedicated machine. Make sure they meet the
62+
| Server | The NDC Server name or IP address (name format is case-insensitive). |
63+
| 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. | |
64+
| Alternate Server | Optional, Netwrix recommends using default values. |
65+
| Alternate QS Path | Optional, Netwrix recommends using default values. |
66+
67+
6. Click **Save** to close the dialog. Repeat steps 5 and 6 for each server you intend to add.
68+
7. Prepare to install the other Netwrix Data Classification Server instances on their dedicated servers. To make best use of resources, each NDC server
69+
requires a dedicated machine. Make sure each server meets the
7670
[Hardware Requirements](/docs/dataclassification/5.7/introduction/requirements/hardwarerequirements.md) and general
7771
[Software Requirements](/docs/dataclassification/5.7/introduction/requirements/softwarerequirements.md)
7872
8. On each server, follow the installation steps as described in the
79-
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section until SQL Database
80-
configuration.
73+
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section up to the SQL Database
74+
configuration step.
8175
9. On the SQL Database step, provide the name of the SQL Server instance that hosts NDC SQL database
8276
you configured for the first NDC Server.
8377

8478
:::note
85-
Ignore the confirmation dialog on the existing schema in the selected SQL database.
79+
Ignore the confirmation dialog informing you of the existing schema in the selected SQL database.
8680
:::
8781

8882

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

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

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

99-
:::note
100-
To force re-distribution when necessary, you can use the Re-Collect command available
101-
after clicking **Run Cleaner** button on the **Settings > Core > Collector** tab.
102-
:::
91+
1. Install and configure the first Netwrix Data Classification Server as described in the
92+
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section.
93+
2. Open the administrative web console.
94+
3. Navigate to Settings → Config → Utilities → DQS.
95+
4. Select Enable DQS.
96+
5. Prepare to install other Netwrix Data Classification Server instances. Make sure each NDC server meets the
97+
[Hardware Requirements](/docs/dataclassification/5.7/introduction/requirements/hardwarerequirements.md) and general
98+
[Software Requirements](/docs/dataclassification/5.7/introduction/requirements/softwarerequirements.md)
99+
6. On each server, follow the installation steps as described in the
100+
[Install Netwrix Data Classification](/docs/dataclassification/5.7/introduction/install/overview.md) section up to the SQL Database
101+
configuration step.
102+
7. On the SQL Database step, provide the details of the SQL Server instance that hosts the NDC SQL database
103+
you configured for the first NDC Server.
104+
8. When you click next, a message box should appear stating that an NDC configuration was detected and
105+
that the new install will be added to the existing DQS environment - click OK.
106+
107+
:::note
108+
When upgrading an existing NDC instance the installer will attempt to resynchronise the DQS instances in the
109+
background and, if successful, will skip the DQS Synchronisation step. You can then skip ahead to step 13. The DQS Synchronisation
110+
step will only display for an upgrade if this process fails - this is not an issue, simply follow the steps below
111+
to resynchronise the NDC instance with the primary NDC server.
112+
:::
113+
114+
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)
115+
automatically inserted. If it is not present or is incorrect, enter the address from the QS Path column of the first row of
116+
the DQS table. Then click Connect to connect the installer to that server.
117+
10. Once the installer has successfully connected to the primary NDC server, it will generate an authentication
118+
code and display it in the Authentication Code field. Click Sync to open the NDC DQS settings page in a web browser.
119+
11. On the web page, click on Register/Resync. This will open the authentication code entry tab - the authentication code generated by the installer
120+
should be present in the input field. Click Submit to submit the authentication code.
121+
122+
:::note
123+
If the authentication code is not autofilled, click on the Authentication Code field in the installer to copy the
124+
value to your clipboard, then paste it in the authentication code field in the NDC UI.
125+
:::
126+
127+
12. The Register/Resync tab should now display an 8-digit verification code. Copy this, paste it into
128+
the Verification Code field in the installer, then click Join. The NDC installer will then perform
129+
the resynchronisation.
130+
13. Complete the installation.
131+
14. Repeat steps 6 - 13 for each other new NDC Server, then review the list of servers to make sure all new
132+
servers have been successfully added.
133+
134+
![dqs_servers_list_thumb_0_0](/images/dataclassification/5.7/requirements/dqs_servers_list_thumb_0_0.webp)
135+
136+
137+
If you were configuring the DQS mode for an existing NDC deployment, you will be prompted to
138+
re-collect data from the data sources in order to re-distribute the content index across all
139+
NDC Servers in the cluster. This will result in all data sources being recollected, which may
140+
take a significant amount of time.
141+
142+
:::note
143+
To force re-distribution when necessary, you can use the Re-Collect command available
144+
after clicking **Run Cleaner** button on the **Settings > Core > Collector** tab.
145+
:::
103146

104147

105148
To review system health and check your configuration, use the product dashboards.

‎docs/dataclassification/5.7/introduction/deployment/ndcserverandclient/ndcserverandclient.md‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ sidebar_position: 10
66

77
# NDC Server
88

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

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

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

@@ -26,10 +27,10 @@ machine image with pre-installed Netwrix Data Classification on Generalized Wind
2627

2728

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

32-
To balance the load while indexing and classifying data in the large-size and extra-large
33-
environments (i.e. with over ≥ 16 mln objects to process), it is strongly recommended to deploy
34-
several NDC Servers and configure **Distributed Query Server** mode for them.
33+
To balance processing load while collecting indexing and classifying data in large-size and extra-large
34+
environments (i.e. 16m+ objects to process), it is strongly recommended to deploy
35+
multiple NDC Servers and configure **Distributed Query Server** mode for them.
3536
[See Configuring NDC Servers Cluster and Load Balancing with DQS Mode for more information.](/docs/dataclassification/5.7/introduction/deployment/ndcserverandclient/dqsmode.md)

‎docs/dataclassification/5.7/introduction/initialconfiguration/healthalert.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 50
66

77
# Configure Health Alerting
88

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

1212
![initial_config_health](/images/dataclassification/5.7/install/initialconfiguration/initial_config_health.webp)
@@ -16,6 +16,6 @@ Complete the following fields:
1616
| Setting | Description |
1717
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1818
| 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) |
19-
| 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. |
20-
| 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) |
21-
| Should a daily health summary be sent? | Select whether you want to receive daily summary on the product health. |
19+
| 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. |
20+
| 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) |
21+
| Should a daily health summary be sent? | Select whether you want to receive daily summary on the current health status of NDC. |

‎docs/dataclassification/5.7/introduction/initialconfiguration/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 80
99
The Product Configuration Wizard allows you quickly configure basic Netwrix Data Classification
1010
settings such as processing mode, taxonomies, etc.
1111

12-
In your web browser, navigate to the following URL: http://hostname/conceptQS where hostname is the
12+
In your web browser, navigate to the following URL: http://hostname/NDC where hostname is the
1313
name or IP address of the computer where Netwrix Data Classification is installed and perform
1414
initial configuration steps.
1515

0 commit comments

Comments
 (0)