Skip to content

Commit a16306b

Browse files
authored
Merge pull request #32 from relativitydev/REL-1143044-Port-Diagram
Rel 1143044 port diagram
2 parents 9aa6bec + f69700b commit a16306b

File tree

6 files changed

+171
-62
lines changed

6 files changed

+171
-62
lines changed

docs/elasticsearch_setup.md renamed to docs/elasticsearch_pre_installation_overview.md

Lines changed: 151 additions & 59 deletions
Large diffs are not rendered by default.

docs/environment-watch/Elastic Stack Port Diagram 01.svg

Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
![alt text](<Elastic Stack Port Diagram 01.svg>)

docs/environment_watch_installation.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,22 @@ Environment Watch installation is comprised of the following four stages. **Stag
1414

1515
![alt text](../resources/stage_environmentwatch01.png)
1616

17-
<table><tbody><tr><th><p><strong>Stage</strong></p></th><th><p><strong>Name</strong></p></th><th><p><strong>Applicable For</strong></p></th><th><p><strong>Description</strong></p></th><th><p><strong>Environment Watch Bundle Assets</strong></p></th></tr><tr><td><p>1</p></td><td><p>Elasticsearch, Kibana, and APM Server</p></td><td><p>Environment Watch and Data Grid Audit</p></td><td><p>During this step you will install the Elastic stack software that is used for Environment Watch and/or Kibana (Elasticsearch, Kibana, and APM Server).</p><div class="note">APM Server is only used for Environment Watch.</div></td><td><ul> N/A</ul></td></tr><tr><td><p>2</p></td><td><p>Use the Relativity Server CLI to set up Environment Watch and/or Data Grid Audit</p></td><td><p>Environment Watch and Data Grid Audit</p></td><td><p>During this step you will configure the integration between Elastic and Relativity for Environment Watch and/or Data Grid Audit.</p><p>If you are setting up Environment Watch, the Relativity Server CLI also imports all of the Kibana objects (indexes, alerts, saved searches, dashboards, etc.) that Relativity has created and packaged as part of Environment Watch.</p></td><td><ul><li>Relativity.Server.CLI</li></ul></td></tr><tr><td><p>3</p></td><td><p>Install Environment Watch on all hosts</p></td><td><p>Environment Watch only</p></td><td><p>During this step you will install and verify Environment Watch on SQL Primary. Once verified, proceed with installing EW on all hosts that you want to monitor in your Relativity Server environment. The installer package contains a monitoring agent (rel-infrawatch-agent.exe) that collects and transmits telemetry data to Elastic and a Windows service (rel-envwatch-service.exe) that enables the monitoring agent upgrade process.</p></td><td><ul><li>Relativity.EnvironmentWatch.Installer</li><li>Rel-infrawarch-agent</li></ul></td></tr><tr><td><p>4</p></td><td><p>Install/upgrade the Relativity Alerts application</p></td><td><p>Environment Watch only</p></td><td><p>During this step you will install or upgrade the Relativity Alert application (RAP) that provides the Environment Watch in-app alert notifications within Relativity.</p></td><td><ul><li>Relativity.Alerts.VERSION.rap</li></ul></td></tr></tbody></table>
17+
<table><tbody>
18+
<tr>
19+
<th><p><strong>Stage</strong></p></th>
20+
<th><p><strong>Name</strong></p></th>
21+
<th><p><strong>Applicable For</strong></p></th>
22+
<th><p><strong>Description</strong></p></th>
23+
<th><p><strong>Environment Watch Bundle Assets</strong></p></th>
24+
</tr>
25+
<tr><td><p>1</p></td><td><p>Install Elasticsearch, Kibana, and APM Server</p></td><td><p>Environment Watch and Data Grid Audit</p></td><td><p>Install the Elastic stack software required for Environment Watch and/or Data Grid Audit (Elasticsearch, Kibana, and APM Server).</p><div class="note">APM Server is only used for Environment Watch.</div></td><td><ul><li>N/A</li></ul></td></tr>
26+
<tr><td><p>2</p></td><td><p>Enable Environment Watch and/or Data Grid/Audit</p></td><td><p>Environment Watch and Data Grid Audit</p></td><td><p>Configure security, monitoring, and API key generation for Elasticsearch, Kibana, and APM Server. Ensure all Elastic components are ready for integration.</p></td><td><ul><li>N/A</li></ul></td></tr>
27+
<tr><td><p>3</p></td><td><p>Install Environment Watch Monitoring Agents</p></td><td><p>Environment Watch and Data Grid Audit</p></td><td><p>Use Relativity Server CLI to set up integration between Elastic and Relativity. Import Kibana objects for Environment Watch and Data Grid Audit.</p></td><td><ul><li>Relativity.Server.CLI</li></ul></td></tr>
28+
<tr><td><p>4</p></td><td><p>Install Other Integrations</p></td><td><p>Environment Watch only</p></td><td><p>Install and configure required integrations and supporting services for Environment Watch, including InfraWatch Services.</p></td><td><ul><li>Relativity.EnvironmentWatch.Installer</li></ul></td></tr>
29+
<tr><td><p>5</p></td><td><p>Post-Install Verification</p></td><td><p>Environment Watch only</p></td><td><p>Install Environment Watch agents on all hosts to be monitored in your Relativity Server environment.</p></td><td><ul><li>Rel-infrawatch-agent</li></ul></td></tr>
30+
<tr><td><p>6</p></td><td><p>Install Relativity Alerts</p></td><td><p>Environment Watch only</p></td><td><p>Install or upgrade the Relativity Alerts application (RAP) for in-app alert notifications within Relativity.</p></td><td><ul><li>Relativity.Alerts.VERSION.rap</li></ul></td></tr>
31+
<tr><td><p>7</p></td><td><p>Create Kibana Users and Assign Roles</p></td><td><p>Environment Watch and Data Grid Audit</p></td><td><p>Verify all components, integrations, and monitoring are working as expected. Finalize configuration and perform any required troubleshooting.</p></td><td><ul><li>N/A</li></ul></td></tr>
32+
</tbody></table>
1833

1934
## Next
20-
Proceed to stage 1: [Installing Elasticsearch, Kibana, and APM Server](elasticsearch_setup.md)
35+
Proceed to stage 1: [Installing Elasticsearch, Kibana, and APM Server](elasticsearch_pre_installation_overview.md)

docs/environment_watch_installer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,5 +126,5 @@ During the installation process, two log files are created in the `%TEMP%` direc
126126
## Handling errors
127127
If any errors are encountered during the installation process, please refer to the [troubleshooting guide](/docs/environment_watch_troubleshooting.md#troubleshooting-environment-watch-installer-on-windows) to resolve the issues.
128128

129-
## Next steps
129+
## Next
130130
Click [here](relativity_alerts_installation.md) to Install Relativity Alerts Application

resources/setup_stage.png

35.9 KB
Loading

0 commit comments

Comments
 (0)