Skip to content

Commit 3df1d56

Browse files
committed
REL-1300584: Updated url and formatting
1 parent 65fd3f5 commit 3df1d56

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

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

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ After installing the required Elastic components for Data Grid Audit, the integr
4949
6. **Relativity admin account permissions** — The Relativity admin account used with the CLI must:
5050
- Be a member of the **System Administrators** group in Relativity.
5151
- Have read/write access to the **Secret Store**.
52-
- Use **Forms Authentication**. The CLI authenticates against the Relativity REST API using Forms Authentication credentials; other authentication providers are not supported.
5352
- **Not have two-factor authentication (2FA) enabled.** The CLI cannot complete an interactive 2FA challenge. Using an account with 2FA enforced will result in authentication failures during setup.
5453
5554
7. **Elasticsearch admin account** — The Elasticsearch credential provided to the CLI must have **superuser** privileges (or equivalent cluster-level read/write permissions). Using a limited-privilege account will result in `Unauthorized` errors during API key creation and index operations.
@@ -69,7 +68,7 @@ After installing the required Elastic components for Data Grid Audit, the integr
6968
- 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.
7069
- The default port is `9200`. The URL must use HTTPS if TLS is enabled on the cluster.
7170
- 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.
72-
- Example: `https://<elasticsearch-hostname:9200`
71+
- Example: `https://<elasticsearch-hostname>:9200`
7372
7473
> [!TIP]
7574
> 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.
@@ -98,7 +97,7 @@ Follow these steps to set up Data Grid Audit using the Relativity Server CLI. Al
9897
Confirm you would like to perform the 'DataGrid' setup [y/n] (y): y
9998
10099
Existing settings do not exist
101-
Enter the Relativity admin username (relativity.admin@kcura.com): relativity.admin@kcura.com
100+
Enter the Relativity admin username (<relativity-admin-username>): <relativity-admin-username>
102101
Enter the Relativity admin password: *********
103102
Enter the Relativity instance url (https://relativity.example.com/Relativity): https://relativity.example.com/Relativity
104103
Relativity instance is verified
@@ -110,7 +109,7 @@ Follow these steps to set up Data Grid Audit using the Relativity Server CLI. Al
110109
111110
| Parameter | Description | Example |
112111
| :--- | :--- | :--- |
113-
| Relativity admin username | The username of a Relativity System Administrator account. Must use Forms Authentication with two-factor authentication disabled. | `relativity.admin@kcura.com` |
112+
| Relativity admin username | The username of a Relativity System Administrator account. Must use Forms Authentication with two-factor authentication disabled. | `<relativity-admin-username>` |
114113
| Relativity admin password | The password for the Relativity admin account. | |
115114
| 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` |
116115
| Elasticsearch admin username | The username of an Elasticsearch account with superuser privileges. | `elastic` |
@@ -134,10 +133,9 @@ Follow these steps to set up Data Grid Audit using the Relativity Server CLI. Al
134133
135134
If the setup completes successfully, Datagrid is now configured for the environment.
136135
137-
> [!NOTE]
138-
> After setup completes, check whether the `NewDataGridMigratorToggleOverwrite` instance setting exists in your Relativity instance. If it is present, it must be set to `True`. If it is not present, no action is required.
139-
140136
4. Restart the Relativity services on all machines for the changes to take effect.
141137
138+
> [!NOTE]
139+
> After setup completes, check whether the `NewDataGridMigratorToggleOverwrite` instance setting exists in your Relativity instance. If it is present, it must be set to `True`. If it is not present, no action is required.
142140
143141
5. Verify Audit Dashboard - navigate to the Audit tab in the Relativity environment and confirm that the dashboard and its data are loading correctly.

0 commit comments

Comments
 (0)