Skip to content

Commit bea52c4

Browse files
Merge pull request #38 from relativitydev/REL-1158490_doc_review_comments
REL-1158490: Addressed PR review comments:
2 parents 8546e11 + 115dd99 commit bea52c4

5 files changed

Lines changed: 16 additions & 11 deletions

docs/datagrid_audit_setup.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,14 @@
33
![Setup Stage](../resources/enable_environmentwatch.png)
44

55
> [!NOTE]
6-
> This section applies to Datagrid Only.
7-
8-
After installing the required Elastic components for Data Grid Audit, the integration between Elastic and Relativity is configured by running the Relativity Server CLI on the Primary SQL Server.
9-
10-
> [!NOTE]
6+
> This section applies to Datagrid Only and the Audit setup via CLI should be run only once per environment.
117
> Please review the following important information before proceeding:
128
> * **For Existing Data Grid Audit Customers:** You must be on Elasticsearch 7.17 when initially running this setup. After the setup is complete, you can upgrade to Elasticsearch 8.17.3.
139
> * Before upgrading to Elasticsearch 8.17.3, the `ESIndexCreationSetting` may need to be updated. For details, refer to the [Instance setting Details](https://help.relativity.com/Server2024/Content/System_Guides/Instance_Setting_Guide/Instance_setting_descriptions.htm#ESIndexCreationSettings).
1410
> * Always verify the minimum required Elasticsearch version in your specific release bundle, as it may differ from the versions mentioned here.
1511
12+
After installing the required Elastic components for Data Grid Audit, the integration between Elastic and Relativity is configured by running the Relativity Server CLI. It is recommended to run the CLI from the Primary SQL Server.
13+
1614
### Prerequisites
1715

1816

docs/environment_watch_upgrade.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ This document provides the necessary steps to upgrade the Environment Watch comp
44

55
## Upgrade CLI
66

7-
This section guides you through upgrading Environment Watch using the Relativity Server CLI.
7+
This section guides you through upgrading Environment Watch using the Relativity Server CLI. It is recommended to run the CLI from the Primary SQL Server.
8+
9+
> [!NOTE]
10+
> The Environment Watch upgrade via CLI should be run only once per environment. The upgrade performs tasks such as importing and updating Kibana resources including alerts, dashboards, saved searches and defect fixes.
811
912
### Prerequisites
1013

@@ -72,7 +75,10 @@ Refer to the [Troubleshooting Guide](troubleshooting/relativity-server-cli.md) i
7275

7376
## Upgrade Environment Watch Installer
7477

75-
This document outlines the steps to upgrade the Environment Watch monitoring agent. It is recommended to first upgrade the agent on the SQL Primary server, verify the installation, and then repeat the steps for all other servers in the environment.
78+
> [!NOTE]
79+
> The Environment Watch installer upgrade should start on the SQL Primary server and then be applied to other servers in the environment. This ensures proper upgrade sequence and validation before deploying across all servers.
80+
81+
This document outlines the steps to upgrade the Environment Watch monitoring agent.
7682

7783
### Prerequisites
7884

docs/install_environment_watch_monitoring_agents.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
> [!NOTE]
66
> This step is required for Environment Watch.
7+
>The Environment Watch monitoring agent installation should start on the SQL Primary server, verify the installation, and then be applied to other servers in the environment. This ensures proper setup and validation before deploying across all servers.
78
8-
9-
This document outlines the steps to install the Environment Watch monitoring agent. It is recommended to first install the agent on the SQL Primary server, verify the installation, and then repeat the steps for all other servers in the environment.
9+
This document outlines the steps to install the Environment Watch monitoring agent.
1010

1111
### Prerequisites
1212

docs/relativity_server_cli_setup.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
![Setup Stage](../resources/enable_environmentwatch.png)
44

55
> [!NOTE]
6-
> This step is required for Environment Watch.
6+
> This step is required for Environment Watch. The Environment Watch setup via CLI should be run only **once** per environment. The setup performs tasks such as importing and updating Kibana resources including alerts, dashboards, saved searches and defect fixes.
77
88
# Set up Environment Watch using the Relativity Server CLI
99

10+
It is recommended to run the CLI from the Primary SQL Server.
1011

1112
### Prerequisites
1213

docs/troubleshooting/pre-requisite-troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The following table summarizes the default ports used by the Elastic Stack and E
1717

1818
| Component | Port | Protocol | Inbound | Outbound | Purpose |
1919
| :--- | :--- | :--- | :---: | :---: | :--- |
20-
| Elasticsearch | 9200 | HTTP/HTTPS || | Client communication and REST API |
20+
| Elasticsearch | 9200 | HTTP/HTTPS || | Client communication and REST API |
2121
| | 9300 | TCP ||| Inter-node communication |
2222
| Kibana | 5601 | HTTP/HTTPS || | Kibana web interface |
2323
| APM Server | 8200 | HTTP/HTTPS || | APM agent data ingestion |

0 commit comments

Comments
 (0)