Skip to content

Commit dea0309

Browse files
MariekeGOMariekeGO
authored
Merge pull request SkylineCommunications#4558 from SkylineCommunications/BrokerGateway-RNs
BrokerGateway release notes
2 parents d7332d7 + 7f7a8d9 commit dea0309

2 files changed

Lines changed: 133 additions & 38 deletions

File tree

‎release-notes/General/General_Feature_Release_10.5/General_Feature_Release_10.5.5.md‎

Lines changed: 82 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ uid: General_Feature_Release_10.5.5
2424
2525
## Highlights
2626

27-
*No highlights have been selected yet.*
27+
- [Migration from SLNet-managed NATS solution to BrokerGateway [ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)
2828

2929
## New features
3030

@@ -37,10 +37,67 @@ Up to now, when you stopped and restarted an SNMP manager, all open alarms would
3737
> [!NOTE]
3838
> This new *Enable tracking to avoid duplicate inform acknowledgments (ACKs)* option is not selected by default and is not compatible with the existing *Resend all active alarms every:* option. It is also not compatible with the *Resend...* command, which in DataMiner Cube can be selected after right-clicking an SNMP manager in the *SNMP forwarding* section of *System Center*.
3939
40+
#### Migration from SLNet-managed NATS solution to BrokerGateway [ID 42019] [ID 42020] [ID 42573]
41+
42+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 -->
43+
44+
It is now possible to migrate from the SLNet-managed NATS solution (NAS and NATS services) to the BrokerGateway-managed NATS solution (nats-server service). Previously, starting from DataMiner 10.5.0/10.5.2, this feature was available in [soft launch](xref:SoftLaunchOptions).
45+
46+
BrokerGateway will manage NATS communication based on a single source of truth that has the complete knowledge of the cluster, resulting in more robust, carefree NATS communication. In addition, TLS will be configured automatically, and a newer version of NATS will be used that has better performance and is easier to upgrade.
47+
48+
Before you start the migration, the entire cluster must have been running smoothly for some time. A BPA test is available that allows you to easily verify this ([Verify NATS Migration Prerequisites](xref:BPA_NATS_Migration_Prerequisites)).
49+
50+
You can then run the migration by opening a remote desktop connection to all DMAs at the same time, opening a command prompt as administrator, and running the executable *C:\Skyline DataMiner\Tools\NATSMigration.exe*. This must happen on each DMA in the cluster within a 10-minute timeframe. For more detailed information, refer to [Migrating to BrokerGateway](xref:BrokerGateway_Migration).
51+
52+
Note that when you add a DataMiner Agent to a DataMiner System, it will have to use the same NATS solution as the DataMiner System. This means that if the DMS has been migrated to BrokerGateway, the DMA you add also needs to be migrated to BrokerGateway, but if the DMS still uses the SLNet-managed NATS solution, the DMA you add also has to use this solution.
53+
54+
#### GQI DxM will now look for missing dependencies in the Automation script libraries folder [ID 42468]
55+
56+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 -->
57+
58+
GQI extensions use the Automation engine to create DLL libraries that are then loaded by GQI to add ad hoc data sources, custom operators, etc.
59+
60+
GQI will now look for missing dependencies in the *C:\\Skyline DataMiner\\Scripts\\Libraries* folder. This will allow GQI extension scripts to find the Automation script library at runtime.
61+
62+
> [!IMPORTANT]
63+
> If the referenced Automation script library has dependencies of its own, these will also need to be added as dependencies in the GQI extension scripts.
64+
65+
#### GQI DxM: New life cycle method allows ad hoc data sources to optimize sort operators [ID 42528]
66+
67+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 -->
68+
69+
A new optional life cycle method has been introduced for ad hoc data sources running in the GQI DxM. It will allow to optimize or modify sort operators added to the query.
70+
71+
You can use this life cycle by implementing the `Skyline.DataMiner.Analytics.GenericInterface.IGQIOptimizeableDataSource` interface, which has one method:
72+
73+
```csharp
74+
IGQIQueryNode Optimize(IGQIDataSourceNode currentNode, IGQICoreOperator nextOperator)
75+
```
76+
77+
- `currentNode` is the query node that represents the current ad hoc data source.
78+
- `nextOperator` represents the next operator appended to the query.
79+
80+
This method should return the query node that represents the result of applying the next operator to the current ad hoc data source node. Similar to the custom operator implementation, the ad hoc data source implementation can decide to do the following:
81+
82+
- Append the `nextOperator` to the `currentNode` (i.e. the default behavior when this life cycle method is not implemented).
83+
- Remove/ignore the `nextOperator`, usually taking responsibility of the operation internally.
84+
- Modify/add operators.
85+
86+
> [!NOTE]
87+
>
88+
> - This life cycle method will only be called when the `nextOperator` is a filter or a sort operator.
89+
> - This life cycle method can be called multiple times if there is a new `nextOperator`.
90+
4091
## Changes
4192

4293
### Enhancements
4394

95+
#### BrokerGateway files collected by SLLogCollector [ID 40299]
96+
97+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 - previously available in soft-launch starting from 10.4.9/10.5.0-->
98+
99+
In case the DataMiner System uses the BrokerGateway-managed NATS solution (see [[ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)), SLLogCollector will now collect files related BrokerGateway.
100+
44101
#### DataMiner recycle bin enhancements [ID 40565]
45102

46103
<!-- MR 10.6.0 - FR 10.5.5 -->
@@ -93,6 +150,24 @@ For example, if a view is renamed or moved in the Surveyor, a zip file will be c
93150
> [!CAUTION]
94151
> Always be extremely careful when using this functionality, as it can have far-reaching consequences on your DataMiner System.
95152
153+
#### VerifyNatsIsRunning BPA test updated with BrokerGateway prerequisite [ID 40641]
154+
155+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 - previously available in soft-launch starting from 10.4.11/10.5.0-->
156+
157+
In case the DataMiner System uses the BrokerGateway-managed NATS solution (see [[ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)), and the automatic NATS configuration has not been disabled (using [NATSForceManualConfig](xref:SLNetClientTest_disabling_automatic_nats_config)), the *VerifyNatsIsRunning* prerequisite check will now verify if the single source of truth for the NATS communication (i.e. ClusterEndpointConfiguration.json) is present and contains at least one viable endpoint entry.
158+
159+
#### Factory reset tool: New ResetBrokerGatewayNATS action [ID 40759]
160+
161+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 - previously available in soft-launch starting from 10.4.11/10.5.0-->
162+
163+
The *SLReset* factory reset tool will now also reset the DataMiner Agent to use the SLNet-managed NATS solution in case it had been migrated to BrokerGateway (see [[ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)).
164+
165+
#### Notices generated in case local NATS server is not responding [ID 41289]
166+
167+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 - previously available in soft-launch starting from 10.5.0/10.5.1 -->
168+
169+
In case the DataMiner System uses the BrokerGateway-managed NATS solution (see [[ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)), SLNet will now generate notices in case the local NATS server is not responding. The connectivity will be checked at a random interval between 3 and 10 minutes.
170+
96171
#### BPA test 'Check Deprecated MySQL DLL' renamed to 'Check Deprecated DLL Usage' [ID 42057]
97172

98173
<!-- MR 10.6.0 - FR 10.5.5 -->
@@ -122,6 +197,12 @@ From now on, it will clone the reservation object in the cache, make the change,
122197

123198
A number of security enhancements have been made.
124199

200+
#### NATS repair tool [ID 42328]
201+
202+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 -->
203+
204+
A repair tool, *NATSRepair.exe*, will now be included in the *C:\Skyline DataMiner\Tools\\* folder. You can use this to repair the BrokerGateway-managed NATS cluster in case you encounter any issues.
205+
125206
#### DataMiner Object Model: An error will now be returned when a FieldValue was added for a non-existing FieldDescriptor [ID 42358]
126207

127208
<!-- MR 10.6.0 - FR 10.5.5 -->
@@ -185,17 +266,6 @@ The output will be stored in the following file:
185266

186267
*\\Logs\\Windows\\.NET runtimes\\cmd.exe _c dotnet --list-runtimes.txt*
187268

188-
#### GQI DxM will now look for missing dependencies in the Automation script libraries folder [ID 42468]
189-
190-
<!-- MR 10.5.0 [CU2] - FR 10.5.5 -->
191-
192-
GQI extensions use the Automation engine to create DLL libraries that are then loaded by GQI to add ad hoc data sources, custom operators, etc.
193-
194-
GQI will now look for missing dependencies in the *C:\\Skyline DataMiner\\Scripts\\Libraries* folder. This will allow GQI extension scripts to find the Automation script library at runtime.
195-
196-
> [!IMPORTANT]
197-
> If the referenced Automation script library has dependencies of its own, these will also need to be added as dependencies in the GQI extension scripts.
198-
199269
#### GQI recording removed from GQI DxM [ID 42470]
200270

201271
<!-- MR 10.5.0 [CU2] - FR 10.5.5 -->
@@ -246,32 +316,6 @@ Also, a status label will now indicate whether debug logging is enabled or disab
246316
> - The above-mentioned status label will show "Enabled" when a level-6 override is present. If all log files have level 6 by default, the status label will show "Disabled" until you add an override.
247317
> - Enabling debug logging may significantly increase the amount of logging that is written to disk.
248318
249-
#### GQI DxM: New life cycle method allows ad hoc data sources to optimize sort operators [ID 42528]
250-
251-
<!-- MR 10.5.0 [CU2] - FR 10.5.5 -->
252-
253-
A new optional life cycle method has been introduced for ad hoc data sources running in the GQI DxM. It will allow to optimize or modify sort operators added to the query.
254-
255-
You can use this life cycle by implementing the `Skyline.DataMiner.Analytics.GenericInterface.IGQIOptimizeableDataSource` interface, which has one method:
256-
257-
```csharp
258-
IGQIQueryNode Optimize(IGQIDataSourceNode currentNode, IGQICoreOperator nextOperator)
259-
```
260-
261-
- `currentNode` is the query node that represents the current ad hoc data source.
262-
- `nextOperator` represents the next operator appended to the query.
263-
264-
This method should return the query node that represents the result of applying the next operator to the current ad hoc data source node. Similar to the custom operator implementation, the ad hoc data source implementation can decide to do the following:
265-
266-
- Append the `nextOperator` to the `currentNode` (i.e. the default behavior when this life cycle method is not implemented).
267-
- Remove/ignore the `nextOperator`, usually taking responsibility of the operation internally.
268-
- Modify/add operators.
269-
270-
> [!NOTE]
271-
>
272-
> - This life cycle method will only be called when the `nextOperator` is a filter or a sort operator.
273-
> - This life cycle method can be called multiple times if there is a new `nextOperator`.
274-
275319
#### New log viewer web page [ID 42533]
276320

277321
<!-- MR 10.4.0 [CU14]/10.5.0 [CU2] - FR 10.5.5 -->

‎release-notes/General/General_Main_Release_10.5/General_Main_Release_10.5.0_CU2.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,39 @@ uid: General_Main_Release_10.5.0_CU2
1313
> - For release notes related to the DataMiner web applications, see [DataMiner web apps Main Release 10.5.0 CU2](xref:Web_apps_Main_Release_10.5.0_CU2).
1414
> - For information on how to upgrade DataMiner, see [Upgrading a DataMiner Agent](xref:Upgrading_a_DataMiner_Agent).
1515
16+
### Highlights
17+
18+
- [New option to prevent an SNMP manager from resending SNMP inform messages [ID 41884]](#snmp-forwarding-new-option-to-prevent-an-snmp-manager-from-resending-snmp-inform-messages-id-41884)
19+
- [GQI DxM will now look for missing dependencies in the Automation script libraries folder [ID 42468]](#gqi-dxm-will-now-look-for-missing-dependencies-in-the-automation-script-libraries-folder-id-42468)
20+
- [GQI DxM: New life cycle method allows ad hoc data sources to optimize sort operators [ID 42528]](#gqi-dxm-new-life-cycle-method-allows-ad-hoc-data-sources-to-optimize-sort-operators-id-42528)
21+
- [Migration from SLNet-managed NATS solution to BrokerGateway [ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)
22+
1623
### Enhancements
1724

25+
#### BrokerGateway files collected by SLLogCollector [ID 40299]
26+
27+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 - previously available in soft-launch starting from 10.4.9/10.5.0-->
28+
29+
In case the DataMiner System uses the BrokerGateway-managed NATS solution (see [[ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)), SLLogCollector will now collect files related BrokerGateway.
30+
31+
#### VerifyNatsIsRunning BPA test updated with BrokerGateway prerequisite [ID 40641]
32+
33+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 - previously available in soft-launch starting from 10.4.11/10.5.0-->
34+
35+
In case the DataMiner System uses the BrokerGateway-managed NATS solution (see [[ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)), and the automatic NATS configuration has not been disabled (using [NATSForceManualConfig](xref:SLNetClientTest_disabling_automatic_nats_config)), the *VerifyNatsIsRunning* prerequisite check will now verify if the single source of truth for the NATS communication (i.e. ClusterEndpointConfiguration.json) is present and contains at least one viable endpoint entry.
36+
37+
#### Factory reset tool: New ResetBrokerGatewayNATS action [ID 40759]
38+
39+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 - previously available in soft-launch starting from 10.4.11/10.5.0-->
40+
41+
The *SLReset* factory reset tool will now also reset the DataMiner Agent to use the SLNet-managed NATS solution in case it had been migrated to BrokerGateway (see [[ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)).
42+
43+
#### Notices generated in case local NATS server is not responding [ID 41289]
44+
45+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 - previously available in soft-launch starting from 10.5.0/10.5.1 -->
46+
47+
In case the DataMiner System uses the BrokerGateway-managed NATS solution (see [[ID 42573]](#migration-from-slnet-managed-nats-solution-to-brokergateway-id-42019-id-42020-id-42573)), SLNet will now generate notices in case the local NATS server is not responding. The connectivity will be checked at a random interval between 3 and 10 minutes.
48+
1849
#### SNMP forwarding: New option to prevent an SNMP manager from resending SNMP inform messages [ID 41884]
1950

2051
<!-- MR 10.4.0 [CU14]/10.5.0 [CU2] - FR 10.5.5 -->
@@ -30,6 +61,12 @@ Up to now, when you stopped and restarted an SNMP manager, all open alarms would
3061

3162
A number of security enhancements have been made.
3263

64+
#### NATS repair tool [ID 42328]
65+
66+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 -->
67+
68+
A repair tool, *NATSRepair.exe*, will now be included in the *C:\Skyline DataMiner\Tools\\* folder. You can use this to repair the BrokerGateway-managed NATS cluster in case you encounter any issues.
69+
3370
#### Reduced memory usage when updating a large number of parameters in bulk [ID 42385]
3471

3572
<!-- MR 10.4.0 [CU14]/10.5.0 [CU2] - FR 10.5.5 -->
@@ -149,6 +186,20 @@ Up to now, client applications like DataMiner Cube used the *ViewLog.asp* web pa
149186

150187
This new log viewer page has improved compatibility with Failover setups and better error handling for HTTPS certificates.
151188

189+
#### Migration from SLNet-managed NATS solution to BrokerGateway [ID 42019] [ID 42020] [ID 42573]
190+
191+
<!-- MR 10.5.0 [CU2] - FR 10.5.5 -->
192+
193+
It is now possible to migrate from the SLNet-managed NATS solution (NAS and NATS services) to the BrokerGateway-managed NATS solution (nats-server service). Previously, starting from DataMiner 10.5.0/10.5.2, this feature was available in [soft launch](xref:SoftLaunchOptions).
194+
195+
BrokerGateway will manage NATS communication based on a single source of truth that has the complete knowledge of the cluster, resulting in more robust, carefree NATS communication. In addition, TLS will be configured automatically, and a newer version of NATS will be used that has better performance and is easier to upgrade.
196+
197+
Before you start the migration, the entire cluster must have been running smoothly for some time. A BPA test is available that allows you to easily verify this ([Verify NATS Migration Prerequisites](xref:BPA_NATS_Migration_Prerequisites)).
198+
199+
You can then run the migration by opening a remote desktop connection to all DMAs at the same time, opening a command prompt as administrator, and running the executable *C:\Skyline DataMiner\Tools\NATSMigration.exe*. This must happen on each DMA in the cluster within a 10-minute timeframe. For more detailed information, refer to [Migrating to BrokerGateway](xref:BrokerGateway_Migration).
200+
201+
Note that when you add a DataMiner Agent to a DataMiner System, it will have to use the same NATS solution as the DataMiner System. This means that if the DMS has been migrated to BrokerGateway, the DMA you add also needs to be migrated to BrokerGateway, but if the DMS still uses the SLNet-managed NATS solution, the DMA you add also has to use this solution.
202+
152203
#### DataMiner IDP license notice will no longer appear [ID 42574]
153204

154205
<!-- MR 10.4.0 [CU14]/10.5.0 [CU2] - FR 10.5.5 -->

0 commit comments

Comments
 (0)