Skip to content

Commit 74c8a6d

Browse files
committed
REL-1300584: Addressed feedback changes
1 parent 3df1d56 commit 74c8a6d

1 file changed

Lines changed: 33 additions & 10 deletions

File tree

elastic-stack-setup/elastic-stack-setup-03-audit.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,35 @@ After installing the required Elastic components for Data Grid Audit, the integr
2323

2424
```powershell
2525
Test-NetConnection -ComputerName <relativity-hostname> -Port 443
26-
Test-NetConnection -ComputerName <elasticsearch-hostname> -Port 9200
26+
Test-NetConnection -ComputerName <elasticsearch-masternode-hostname> -Port 9200
27+
```
28+
29+
Example output:
30+
31+
```
32+
PS C:\Users\relserviceaccount> Test-NetConnection -ComputerName <relativity-hostname> -Port 443
33+
34+
ComputerName : <relativity-hostname>
35+
RemoteAddress : <relativity-ip-address>
36+
RemotePort : 443
37+
InterfaceAlias : Ethernet 3
38+
SourceAddress : <sql-primary-ip-address>
39+
TcpTestSucceeded : True
40+
41+
42+
PS C:\Users\relserviceaccount> Test-NetConnection -ComputerName <elasticsearch-masternode-hostname> -Port 9200
43+
44+
ComputerName : <elasticsearch-masternode-hostname>
45+
RemoteAddress : <elasticsearch-masternode-ip-address>
46+
RemotePort : 9200
47+
InterfaceAlias : Ethernet 3
48+
SourceAddress : <sql-primary-ip-address>
49+
TcpTestSucceeded : True
2750
```
2851

2952
Both must return `TcpTestSucceeded : True` before proceeding. If either fails, resolve the network or firewall issue before continuing.
3053

31-
5. **SSL/TLS certificate trust** — The SSL certificates for both Relativity (Kepler) and Elasticsearch must be trusted on the SQL Primary server. This is one of the most common causes of CLI setup failure, particularly when certificates are self-signed, issued by a private CA, or issued to a hostname that differs from the one provided as the URL input.
54+
5. **SSL/TLS certificate trust** — The SSL certificates for both Relativity (Kepler) and Elasticsearch must be trusted on the SQL Primary server.
3255

3356
**Relativity (Kepler) SSL certificate:**
3457
- The Kepler SSL certificate must be trusted on the SQL Primary server, and must be issued to the same hostname you provide as the Relativity instance URL. A mismatch between the certificate hostname and the URL will cause SSL validation to fail even if the certificate itself is valid.
@@ -41,7 +64,7 @@ After installing the required Elastic components for Data Grid Audit, the integr
4164
- The Elasticsearch cluster certificate must be trusted on the SQL Primary server.
4265
- To verify from the SQL Primary server:
4366
```powershell
44-
curl.exe -u <username>:<password> -X GET "https://<elasticsearch-hostname>:9200/"
67+
curl.exe -u <username>:<password> -X GET "https://<elasticsearch-masternode-hostname>:9200/"
4568
```
4669
4770
A successful response (without `-k`) for each confirms the certificate is trusted. If a command only succeeds with `-k` (skip verification), import the relevant CA certificate into the Windows **Trusted Root Certification Authorities** store on the SQL Primary before proceeding. See [SSL/TLS Certificate Issues](./troubleshooting/pre-requisite-troubleshooting.md#ssltls-certificate-issues) for import instructions.
@@ -59,16 +82,16 @@ After installing the required Elastic components for Data Grid Audit, the integr
5982
> Providing the wrong Relativity or Elasticsearch URL is one of the most common causes of setup failure. Review these requirements before running the CLI.
6083
6184
**Relativity instance URL:**
62-
- Use the **load balancer or primary web server hostname** that is reachable from the SQL Primary server, in the format `https://<hostname>/Relativity`.
85+
- Use the **load balancer or primary web server hostname** that is reachable from the SQL Primary server, in the format `https://<domainurl>/Relativity`.
6386
- Do **not** use a private or internal hostname that resolves differently from the SQL server than from workstations. The CLI makes REST API calls from the SQL Primary server, so the URL must resolve and be routable from that machine.
6487
- The URL must use HTTPS and the certificate at that hostname must be trusted on the SQL Primary server (see prerequisite 5).
65-
- Example: `https://relativity.example.com/Relativity`
88+
- Example: `https://<domainurl>/Relativity`
6689
6790
**Elasticsearch cluster endpoint URL:**
6891
- Use the **master node hostname** — do not use a data node URL. The CLI communicates with the cluster through the master/coordinating node, which handles cluster-level operations such as API key creation and index management.
6992
- The default port is `9200`. The URL must use HTTPS if TLS is enabled on the cluster.
7093
- Use a hostname that matches the **Subject Alternative Name (SAN) or Common Name (CN)** on the Elasticsearch TLS certificate. Using an IP address or alternate hostname not covered by the certificate will cause a certificate mismatch (SSL error) even if the certificate is otherwise trusted.
71-
- Example: `https://<elasticsearch-hostname>:9200`
94+
- Example: `https://<elasticsearch-masternode-hostname>:9200`
7295
7396
> [!TIP]
7497
> If your environment uses a load balancer in front of Elasticsearch, confirm that the load balancer certificate covers the hostname you are providing, and that the backend nodes are also individually accessible for certificate validation. When in doubt, use the individual node hostname that matches the certificate CN/SAN.
@@ -99,22 +122,22 @@ Follow these steps to set up Data Grid Audit using the Relativity Server CLI. Al
99122
Existing settings do not exist
100123
Enter the Relativity admin username (<relativity-admin-username>): <relativity-admin-username>
101124
Enter the Relativity admin password: *********
102-
Enter the Relativity instance url (https://relativity.example.com/Relativity): https://relativity.example.com/Relativity
125+
Enter the Relativity instance url (https://<domainurl>/Relativity): https://<domainurl>/Relativity
103126
Relativity instance is verified
104127
Enter the Elasticsearch admin username (elastic): elastic
105128
Enter the Elasticsearch admin password: *********
106-
Enter the Elasticsearch cluster endpoint URL (https://<elasticsearch-hostname>:9200): https://<elasticsearch-hostname>:9200
129+
Enter the Elasticsearch cluster endpoint URL (https://<elasticsearch-masternode-hostname>:9200): https://<elasticsearch-masternode-hostname>:9200
107130
108131
```
109132
110133
| Parameter | Description | Example |
111134
| :--- | :--- | :--- |
112135
| Relativity admin username | The username of a Relativity System Administrator account. Must use Forms Authentication with two-factor authentication disabled. | `<relativity-admin-username>` |
113136
| Relativity admin password | The password for the Relativity admin account. | |
114-
| Relativity instance URL | The HTTPS URL of the Relativity web server or load balancer, reachable from the SQL Primary server. Must end with `/Relativity`. | `https://relativity.example.com/Relativity` |
137+
| Relativity instance URL | The HTTPS URL of the Relativity web server or load balancer, reachable from the SQL Primary server. Must end with `/Relativity`. | `https://<domainurl>/Relativity` |
115138
| Elasticsearch admin username | The username of an Elasticsearch account with superuser privileges. | `elastic` |
116139
| Elasticsearch admin password | The password for the Elasticsearch admin account. | |
117-
| Elasticsearch cluster endpoint URL | The HTTPS URL of the Elasticsearch **master**. Do not use a data node URL. The hostname must match the CN/SAN on the Elasticsearch TLS certificate. Default port is `9200`. | `https://<elasticsearch-hostname>:9200` |
140+
| Elasticsearch cluster endpoint URL | The HTTPS URL of the Elasticsearch **master**. Do not use a data node URL. The hostname must match the CN/SAN on the Elasticsearch TLS certificate. Default port is `9200`. | `https://<elasticsearch-masternode-hostname>:9200` |
118141
119142
3. Wait for Setup to Complete.
120143

0 commit comments

Comments
 (0)