diff --git a/docs/datagrid_audit_setup.md b/docs/datagrid_audit_setup.md index 935472e3..78c30467 100644 --- a/docs/datagrid_audit_setup.md +++ b/docs/datagrid_audit_setup.md @@ -9,8 +9,8 @@ After installing the required Elastic components for Data Grid Audit, the integr > Please review the following important information before proceeding: -> * **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. -> * 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). +> * **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.x or 9.x. +> * Before upgrading to Elasticsearch 8.x or 9.x, 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). > * Always verify the minimum required Elasticsearch version in your specific release bundle, as it may differ from the versions mentioned here. ### Prerequisites diff --git a/docs/elasticsearch_pre_installation_overview.md b/docs/elasticsearch_pre_installation_overview.md index 8d5ca380..6f1bf3da 100644 --- a/docs/elasticsearch_pre_installation_overview.md +++ b/docs/elasticsearch_pre_installation_overview.md @@ -282,7 +282,7 @@ If you have used Elasticsearch for the optional Data Grid Audit feature on Relat https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry#enable-long-paths-in-windows-10-version-1607-and-later -3. **Verify the minimum supported version of Elastic** - All Relativity products have been certified with Elastic Stack 8.17.x, though Data Grid Audit alone is supported on 7.17.x. If you intend to use a single cluster for both, you must install the same version of Elasticsearch on all nodes in the cluster, and that version must be the higher of the minimum versions for Environment Watch and Data Grid Audit, if different. +3. **Verify the minimum supported version of Elastic** - All Relativity products have been certified with Elastic Stack 8.x or 9.x, though Data Grid Audit alone is supported on 7.17.x. If you intend to use a single cluster for both, you must install the same version of Elasticsearch on all nodes in the cluster, and that version must be the higher of the minimum versions for Environment Watch and Data Grid Audit, if different. 4. **At least the minimum Relativity major version and patch** specified in the Environment Watch bundle you intend to deploy is installed on all servers in the environment. See the [System Requirements](../README.md) for the minimum version required. diff --git a/docs/elasticsearch_setup_development.md b/docs/elasticsearch_setup_development.md index ce77490e..8e921749 100644 --- a/docs/elasticsearch_setup_development.md +++ b/docs/elasticsearch_setup_development.md @@ -14,16 +14,16 @@ If you download a .zip or other file from the internet, Windows may block the fi ![Unblock file screenshot](../resources/troubleshooting-images/unblocked.png) -### Step 1: Download and Install Elasticsearch 8.17.3 on one server -1. Download Elasticsearch 8.17.3 +### Step 1: Download and Install the Windows .zip package for Elasticsearch version 8.x or 9.x on one server +1. Download Elasticsearch 8.x or 9.x 1. Visit [Elastic’s official download page](https://www.elastic.co/downloads/elasticsearch). - 2. Download the 8.17.3 Windows .zip version. + 2. Download the 8.x or 9.x Windows .zip version. 3. Before extracting, see [How to Unblock Downloaded Files](#how-to-unblock-downloaded-files). 4. Extract the files to `C:\elastic` -2. Install and Configure Elasticsearch 8.17.3 +2. Install and Configure Elasticsearch 8.x or 9.x 1. Open an elevated PowerShell and run the following command to start Elasticsearch and perform the auto installation steps: ``` - C:\elastic\elasticsearch-8.17.3\bin\elasticsearch.bat + C:\elastic\elasticsearch-{version}\bin\elasticsearch.bat ``` @@ -42,7 +42,7 @@ If you download a .zip or other file from the internet, Windows may block the fi 3. Open an elevated PowerShell and run the following command to install Elasticsearch as a Windows service: ``` - C:\elastic\elasticsearch-8.17.3\bin\elasticsearch-service.bat install + C:\elastic\elasticsearch-{version}\bin\elasticsearch-service.bat install ``` The output will look similar to: ``` @@ -53,7 +53,7 @@ If you download a .zip or other file from the internet, Windows may block the fi 3. Run Elasticsearch as a Windows Service 1. Open an elevated PowerShell and run the following command to start the Elasticsearch service: ``` - C:\elastic\elasticsearch-8.17.3\bin\elasticsearch-service.bat start + C:\elastic\elasticsearch-{version}\bin\elasticsearch-service.bat start ``` The output will look similar to: ``` @@ -61,7 +61,7 @@ If you download a .zip or other file from the internet, Windows may block the fi The service 'elasticsearch-service-x64' has been started. ``` 4. Enable Stack Monitoring - 1. Navigate to the Elasticsearch configuration folder (e.g., `C:\elastic\elasticsearch-8.17.3\config`) and open the **elasticsearch.yml** file. + 1. Navigate to the Elasticsearch configuration folder (e.g., `C:\elastic\elasticsearch-{version}\config`) and open the **elasticsearch.yml** file. 2. Add the following line to enable Stack Monitoring: ``` xpack.monitoring.collection.enabled: true @@ -72,7 +72,7 @@ If you download a .zip or other file from the internet, Windows may block the fi ``` 5. Reset the Elastic (Admin) User Password 1. The following command resets the password for the `elastic` user, which is the default superuser (admin) account in Elasticsearch. This account is required for logging in to Kibana and for performing administrative tasks such as managing users, roles, and system settings. - 2. Navigate to ElasticSearch's bin folder(`C:\elastic\elasticsearch-8.17.3\bin`) + 2. Navigate to ElasticSearch's bin folder(`C:\elastic\elasticsearch-{version}\bin`) 3. Open an elevated PowerShell and run the following command: ``` .\elasticsearch-reset-password -u elastic @@ -88,11 +88,11 @@ If you download a .zip or other file from the internet, Windows may block the fi 6. Install the 'mapper-size' plugin 1. Open an elevated PowerShell and run the following command to install the 'mapper-size' plugin: ``` - C:\elastic\elasticsearch-8.17.3\bin\elasticsearch-plugin install mapper-size + C:\elastic\elasticsearch-{version}\bin\elasticsearch-plugin install mapper-size ``` 2. To verify the 'mapper-size' plugin is installed, run: ``` - C:\elastic\elasticsearch-8.17.3\bin\elasticsearch-plugin list + C:\elastic\elasticsearch-{version}\bin\elasticsearch-plugin list ``` 3. Restart the Elasticsearch Service. To restart the Elasticsearch service, run the following in an elevated PowerShell session: ``` @@ -100,7 +100,7 @@ If you download a .zip or other file from the internet, Windows may block the fi ``` The output will look similar to: ``` - WARNING: Waiting for service 'Elasticsearch 8.17.3 (elasticsearch-service-x64) (elasticsearch-service-x64)' to stop... + WARNING: Waiting for service 'Elasticsearch 8.x or 9.x (elasticsearch-service-x64) (elasticsearch-service-x64)' to stop... ``` 7. Verify Elasticsearch Server @@ -137,15 +137,15 @@ If you download a .zip or other file from the internet, Windows may block the fi ### Step 2: Install and Configure Kibana -1. Download Kibana 8.17.3 - 1. Download and extract the 8.17.3 Windows .zip version of Kibana from [Elastic’s official Kibana download page](https://www.elastic.co/downloads/kibana). +1. Download Kibana 8.x or 9.x + 1. Download and extract the 8.x or 9.x Windows .zip version of Kibana from [Elastic’s official Kibana download page](https://www.elastic.co/downloads/kibana). 2. Before extracting, see [How to Unblock Downloaded Files](#how-to-unblock-downloaded-files). 2. Start Kibana from the command line 1. Navigate to Kibana's `bin` folder (e.g., `C:\elastic\kibana\bin`). 2. Open an elevated PowerShell and run the following command: ``` - C:\Kibana\kibana-8.17.3\bin\kibana.bat + C:\Kibana\kibana-{version}\bin\kibana.bat ``` 3. If successful, you should see output indicating that the Kibana server has started and is listening on port 5601. Look for lines similar to: ``` @@ -158,9 +158,9 @@ If you download a .zip or other file from the internet, Windows may block the fi 1. In your terminal, click the generated link to open Kibana in your browser. 2. In your browser, paste the enrollment token that was generated in the terminal when you started Elasticsearch, then click the Configure Elastic button to connect your Kibana instance with Elasticsearch. [See where the enrollment token is generated.](#enrollment-token-generation) - 3. If the token has expired, generate a new one by running the following command in the Elasticsearch's bin folder (e.g., `C:\elastic\elasticsearch-8.17.3\bin`). + 3. If the token has expired, generate a new one by running the following command in the Elasticsearch's bin folder (e.g., `C:\elastic\elasticsearch-{version}\bin`). ``` - C:\elastic\elasticsearch-8.17.3\bin\elasticsearch-create-enrollment-token --scope kibana + C:\elastic\elasticsearch-{version}\bin\elasticsearch-create-enrollment-token --scope kibana ```
Sample output @@ -177,7 +177,7 @@ If you download a .zip or other file from the internet, Windows may block the fi 1. Open an elevated PowerShell and run the following command: ``` - C:\Kibana\kibana-8.17.3\bin\kibana-encryption-keys generate + C:\Kibana\kibana-{version}\bin\kibana-encryption-keys generate ``` 2. If successful, you will see output showing the generated encryption keys. For example: @@ -193,7 +193,7 @@ If you download a .zip or other file from the internet, Windows may block the fi
- 3. Copy the generated encryption keys and paste them at the end of your `kibana.yml` file (e.g., `C:\Kibana\kibana-8.17.3\config\kibana.yml`). The configuration should look similar to: + 3. Copy the generated encryption keys and paste them at the end of your `kibana.yml` file (e.g., `C:\Kibana\kibana-{version}\config\kibana.yml`). The configuration should look similar to:
Sample kibana.yml configuration @@ -208,7 +208,7 @@ If you download a .zip or other file from the internet, Windows may block the fi 4. Restart the Kibana service, by opening an elevated PowerShell and run the following command: ``` - C:\Kibana\kibana-8.17.3\bin\kibana.bat + C:\Kibana\kibana-{version}\bin\kibana.bat ``` 5. To verify success, check the terminal output for lines indicating that Kibana has started successfully. You can also refer to the screenshots below: @@ -229,7 +229,7 @@ If you download a .zip or other file from the internet, Windows may block the fi > Only use NSSM if you want Kibana to start automatically as a service on Windows. If you do not wish to use NSSM, simply run `kibana.bat` manually. > > ``` - > C:\Kibana\kibana-8.17.3\bin\kibana.bat + > C:\Kibana\kibana-{version}\bin\kibana.bat > ``` 1. Download the latest NSSM executable from https://nssm.cc/download and place it in the C drive (e.g., `C:\nssm-2.24`). @@ -253,7 +253,7 @@ If you download a .zip or other file from the internet, Windows may block the fi > If you accidentally install the Kibana service before completing your configuration (for example, by pressing Return too early in the NSSM dialog), you can easily edit the service properties afterward. This allows you to update the application path, log file settings, or other options without reinstalling the service. > To edit the service properties, open an elevated PowerShell and run the following command: `C:\nssm-2.24\win64\nssm.exe edit kibana` - 4. In the I/O tab, enter the full path of a log file where the service logs will be stored. For example, create a folder in the Kibana directory (e.g., `C:\Kibana\kibana-8.17.3\service_logs`) and a blank log file (e.g., `C:\Kibana\kibana-8.17.3\service_logs\kibana_service.log`). + 4. In the I/O tab, enter the full path of a log file where the service logs will be stored. For example, create a folder in the Kibana directory (e.g., `C:\Kibana\kibana-{version}\service_logs`) and a blank log file (e.g., `C:\Kibana\kibana-{version}\service_logs\kibana_service.log`). 5. Copy the full log file path into the stdout and stderr sections: @@ -285,13 +285,13 @@ If you download a .zip or other file from the internet, Windows may block the fi 1. Prerequisites to setup APM Server - Elastic and Kibana should be configured and services should be up and running. -2. Download APM Server 8.17.3 +2. Download APM Server 8.x or 9.x 1. Visit [Elastic’s APM Server page](https://www.elastic.co/downloads/apm). - 2. Download and extract the 8.17.3 Windows .zip file. + 2. Download and extract the 8.x or 9.x Windows .zip file. 3. Before extracting, see [How to Unblock Downloaded Files](#how-to-unblock-downloaded-files). 4. Extract the files to `C:\`. -3. Configure APM Server (`C:\apm-server-8.17.3-windows-x86_64\apm-server.yml`) +3. Configure APM Server (`C:\apm-server-{version}-windows-x86_64\apm-server.yml`) 1. An API key is required for configuring both APM and Beats. To create an API key: 1. Log in to Kibana (`http://:5601`) using the `elastic` credential. @@ -306,7 +306,7 @@ If you download a .zip or other file from the internet, Windows may block the fi > Copy and save `id` and `api_key` values immediately and store them securely according to your organization’s credential management and security policies. - 2. Navigate to the apm-server folder (e.g., `C:\apm-server-8.17.3-windows-x86_64`) and open the `apm-server.yml` file using a text editor. + 2. Navigate to the apm-server folder (e.g., `C:\apm-server-{version}-windows-x86_64`) and open the `apm-server.yml` file using a text editor. 3. Update the `apm-server.yml` file to match the following sample configuration. Replace the placeholder values (``, ``, ``, ``) as needed for your environment. Below is a sample configuration: @@ -333,7 +333,7 @@ If you download a .zip or other file from the internet, Windows may block the fi 2. Run the following command to install the APM Server as a Windows service: ``` - PowerShell.exe -ExecutionPolicy UnRestricted -File C:\apm-server-8.17.3-windows-x86_64\install-service.ps1 + PowerShell.exe -ExecutionPolicy UnRestricted -File C:\apm-server-{version}-windows-x86_64\install-service.ps1 ``` The output will look similar to: diff --git a/docs/environment-watch/post-install-verification/elasticsearch-cluster-health.md b/docs/environment-watch/post-install-verification/elasticsearch-cluster-health.md index 4324ab7c..ff3657bb 100644 --- a/docs/environment-watch/post-install-verification/elasticsearch-cluster-health.md +++ b/docs/environment-watch/post-install-verification/elasticsearch-cluster-health.md @@ -33,12 +33,14 @@ Confirm cluster health status, total nodes, shards, indices, and document count - Data size. **Expected Result:** -- Cluster health is **Green (Healthy)**. +- Under any Data Store Dashboard, click on Cluster Overview link. +- Verify cluster health is **Green (Healthy)**. - Nodes, shards, indices, and documents display current, non-zero values. - No unassigned shards. - Data size is displayed accurately. **Screenshot:** +![Screenshot: Cluster Overview](../../../resources/post-install-verification-images/elasticsearch-cluster-health/cluster-overview.png) ![Screenshot: Cluster Health Summary](../../../resources/post-install-verification-images/elasticsearch-cluster-health/cluster-health-summary.png) diff --git a/docs/troubleshooting/elasticsearch.md b/docs/troubleshooting/elasticsearch.md index 26f2295e..ba34a5df 100644 --- a/docs/troubleshooting/elasticsearch.md +++ b/docs/troubleshooting/elasticsearch.md @@ -73,7 +73,7 @@ This document provides troubleshooting guidance for common Elasticsearch issues ``` 3. Check Elasticsearch Logs: - 1. Navigate to the log directory (default: `C:\elastic\elasticsearch-8.17.3\logs\`). + 1. Navigate to the log directory (default: `C:\elastic\elasticsearch-{version}\logs\`). 2. Review the Elasticsearch log file (`elasticsearch.log`) for error messages. 3. Check the slow logs and garbage collection logs if present. 4. For every error in the Elasticsearch log, provide troubleshooting for that specific error. diff --git a/resources/Installer_hostmetric.png b/resources/Installer_hostmetric.png index dd13eb5e..41ba7d16 100644 Binary files a/resources/Installer_hostmetric.png and b/resources/Installer_hostmetric.png differ diff --git a/resources/environment_watch_product_overview_008.png b/resources/environment_watch_product_overview_008.png index 57780553..41ba7d16 100644 Binary files a/resources/environment_watch_product_overview_008.png and b/resources/environment_watch_product_overview_008.png differ diff --git a/resources/post-install-verification-images/elasticsearch-cluster-health/cluster-overview.png b/resources/post-install-verification-images/elasticsearch-cluster-health/cluster-overview.png new file mode 100644 index 00000000..b7d148ce Binary files /dev/null and b/resources/post-install-verification-images/elasticsearch-cluster-health/cluster-overview.png differ diff --git a/resources/post-install-verification-images/elasticsearch-cluster-health/monitoring-agent.png b/resources/post-install-verification-images/elasticsearch-cluster-health/monitoring-agent.png new file mode 100644 index 00000000..7e97c440 Binary files /dev/null and b/resources/post-install-verification-images/elasticsearch-cluster-health/monitoring-agent.png differ diff --git a/resources/post-install-verification-images/monitoring-agents/data-populated.png b/resources/post-install-verification-images/monitoring-agents/data-populated.png index c8ee8388..68dd17c9 100644 Binary files a/resources/post-install-verification-images/monitoring-agents/data-populated.png and b/resources/post-install-verification-images/monitoring-agents/data-populated.png differ diff --git a/resources/post-install-verification-images/monitoring-agents/explore-discover-view.png b/resources/post-install-verification-images/monitoring-agents/explore-discover-view.png index 7d412cd0..0fed8778 100644 Binary files a/resources/post-install-verification-images/monitoring-agents/explore-discover-view.png and b/resources/post-install-verification-images/monitoring-agents/explore-discover-view.png differ diff --git a/resources/post-install-verification-images/monitoring-agents/filter-dropdown-populated.png b/resources/post-install-verification-images/monitoring-agents/filter-dropdown-populated.png index 685f19bc..6f51c036 100644 Binary files a/resources/post-install-verification-images/monitoring-agents/filter-dropdown-populated.png and b/resources/post-install-verification-images/monitoring-agents/filter-dropdown-populated.png differ diff --git a/resources/post-install-verification-images/monitoring-agents/hosts-agent-versions.png b/resources/post-install-verification-images/monitoring-agents/hosts-agent-versions.png index f4f1a2bf..0097728d 100644 Binary files a/resources/post-install-verification-images/monitoring-agents/hosts-agent-versions.png and b/resources/post-install-verification-images/monitoring-agents/hosts-agent-versions.png differ diff --git a/resources/relativity_alerts_verification_003_003.png b/resources/relativity_alerts_verification_003_003.png index 29c99f53..fe10d747 100644 Binary files a/resources/relativity_alerts_verification_003_003.png and b/resources/relativity_alerts_verification_003_003.png differ diff --git a/resources/troubleshooting-images/unblocked.png b/resources/troubleshooting-images/unblocked.png index f566ae72..59cb2542 100644 Binary files a/resources/troubleshooting-images/unblocked.png and b/resources/troubleshooting-images/unblocked.png differ