From 498d31d5abcb5e772b2daa7b826ad9a8ee3c4e41 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Sun, 6 Nov 2022 15:45:38 -0500 Subject: [PATCH 01/11] Adds windows installation documentation Signed-off-by: Fanit Kolchina --- _opensearch/install/windows.md | 267 +++++++++++++++++++++++++++++++++ 1 file changed, 267 insertions(+) create mode 100644 _opensearch/install/windows.md diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md new file mode 100644 index 0000000000..60fb0d6c51 --- /dev/null +++ b/_opensearch/install/windows.md @@ -0,0 +1,267 @@ +--- +layout: default +title: Windows +parent: Install OpenSearch +nav_order: 65 +--- + +# Install OpenSearch on Windows + +The following sections describe installing OpenSearch on Windows from a zip archive. + +Generally speaking, the installation of OpenSearch from a zip archive can be broken down into a few steps: + +1. **Download and unpack OpenSearch.** +1. **Review important system settings.** + - These settings are applied to the host before modifying any OpenSearch files. +1. **(Optional) Test OpenSearch.** + - Confirm that OpenSearch is able to run before you apply any custom configuration. + - This can be done without any security (no password, no certificates) or with a demo security configuration that can be applied by a packaged script. +1. **Configure OpenSearch for your environment.** + - Apply basic settings to OpenSearch and start using it in your environment. + +The Windows Opensearch archive is a self-contained directory with everything needed to run OpenSearch, including an integrated Java Development Kit (JDK). If you have your own Java installation and set the environment variable `JAVA_HOME`, OpenSearch will use that installation if the `OPENSEARCH_JAVA_HOME` environment variable is not set. To learn how to set the `OPENSEARCH_JAVA_HOME` environment variable, see [Step 4: Set up OpenSearch in your environment](#step-4-set-up-opensearch-in-your-environment). + +## Prerequisites + +Make sure you have a zip utility installed. + +## Step 1: Download and unpack OpenSearch + +Follow the steps below to install OpenSearch on Windows. + +1. Download the [`opensearch-{{site.opensearch_version}}-windows-x64.zip`](#prerequisites){:target='\_blank'} archive. +1. To extract the archive contents, right-click to select **Extract All**. + +## Step 2: Review important system settings + +Before launching OpenSearch you should review some [important system settings]({{site.url}}{{site.baseurl}}/opensearch/install/important-settings/){:target='\_blank'}. + +## Step 3: (Optional) Test OpenSearch + +Before proceeding with any configuration, you should test your installation of OpenSearch. Otherwise, it can be difficult to determine whether future problems are due to installation issues or custom settings you applied after installation. There are two quick methods for testing OpenSearch at this stage: + +1. **(Security enabled)** Apply a generic configuration using the batch script included in the Windows archive. +1. **(Security disabled)** Manually disable the security plugin and test the instance before applying your own custom security settings. + +The batch script will apply a generic configuration to your instance of OpenSearch. This configuration defines some environment variables and also applies self-signed TLS certificates. Alternatively, you can choose to configure these yourself. + +If you only want to verify that the service is properly configured and you intend to configure security settings yourself, then you may want to disable the security plugin and launch the service without encryption or authentication. + +An OpenSearch node in its default configuration (with demo certificates and users with default passwords) is not suitable for a production environment. If you plan to use the node in a production environment, you should, at a minimum, replace the demo TLS certificates with your own TLS certificates and [update the list of internal users and passwords]({{site.url}}{{site.baseurl}}/security-plugin/configuration/yaml). See [Security configuration]({{site.url}}{{site.baseurl}}/security-plugin/configuration/index/) for additional guidance to ensure that your nodes are configured according to your security requirements. +{: .warning} + +### Option 1: Test your OpenSearch settings with security enabled + +To test OpenSearch with security enabled, perform the following steps: + +1. **Run the batch script to start OpenSearch.** You can choose to run the script with default options, or with custom parameters. +1. **Send a request to your OpenSearch instance to verify that it's running**. + +**Step 1: Run the batch script to start OpenSearch** + +Run the batch script with either default options or custom parameters. + +#### Run the batch script with default options + +1. Open the `opensearch-{{site.opensearch_version}}` folder. +1. Run the default by double-clicking the `opensearch-windows-install.bat` file. This opens a command prompt with the OpenSearch instance running. + +#### Run the batch script with custom parameters + +1. Open command prompt by entering `cmd` in the search box next to **Start** on the taskbar. +1. Change to the top directory of your OpenSearch install. + ```bat + cd \path\to\opensearch-{{site.opensearch_version}} + ``` +1. Run the batch script with custom parameters. + ```bat + call .\opensearch-windows-install.bat "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" "OPENSEARCH_HOSTS=["http://opensearch-node1:9200","http://opensearch-node2:9200"]" + ``` + +**Step 2: Send a request to your OpenSearch instance to verify that it's running** + +1. Open a command prompt and send requests to the server to verify that OpenSearch is running. Note the use of the `--insecure` flag, which is required because the TLS certificates are self-signed. + - Send a request to port 9200. + ```bat + curl -X GET https://localhost:9200 -u 'admin:admin' --insecure + ``` + You should get a response that looks like this: + ```bat + { + "name" : "hostname", + "cluster_name" : "opensearch", + "cluster_uuid" : "6XNc9m2gTUSIoKDqJit0PA", + "version" : { + "distribution" : "opensearch", + "number" : "2.4.0", + "build_type" : "zip", + "build_hash" : "6f6e84ebc54af31a976f53af36a5c69d474a5140", + "build_date" : "2022-11-09T00:07:32.109283578Z", + "build_snapshot" : false, + "lucene_version" : "9.4.1", + "minimum_wire_compatibility_version" : "7.10.0", + "minimum_index_compatibility_version" : "7.0.0" + }, + "tagline" : "The OpenSearch Project: https://opensearch.org/" + } + ``` + - Query the plugins endpoint. + ```bat + curl -X GET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure + ``` + + The response should look like this: + ```bat + name component version + hostname opensearch-alerting 2.4.0.0 + hostname opensearch-anomaly-detection 2.4.0.0 + hostname opensearch-asynchronous-search 2.4.0.0 + hostname opensearch-cross-cluster-replication 2.4.0.0 + hostname opensearch-index-management 2.4.0.0 + hostname opensearch-job-scheduler 2.4.0.0 + hostname opensearch-knn 2.4.0.0 + hostname opensearch-ml 2.4.0.0 + hostname opensearch-notifications 2.4.0.0 + hostname opensearch-notifications-core 2.4.0.0 + hostname opensearch-observability 2.4.0.0 + hostname opensearch-performance-analyzer 2.4.0.0 + hostname opensearch-reports-scheduler 2.4.0.0 + hostname opensearch-security 2.4.0.0 + hostname opensearch-sql 2.4.0.0 + ``` + +### Option 2: Test your OpenSearch settings with security disabled + +1. Open the `opensearch-{{site.opensearch_version}}\config` folder. +1. Open the `opensearch.yml` file with a text editor. +1. Add the following line to disable the security plugin. + ```yaml + plugins.security.disabled: true + ``` +1. Save the change and close the file. +1. Navigate to the top directory of your OpenSearch install and open the `opensearch-{{site.opensearch_version}}` folder. +1. Run the default by double-clicking the `opensearch-windows-install.bat` file. This opens a command prompt an the OpenSearch instance running. +1. Open another command prompt and send requests to the server to verify that OpenSearch is running. Because the security plugin has been disabled, you will be sending commands using `HTTP` rather than `HTTPS`. + - Send a request to port 9200. + ```bat + curl -X GET http://localhost:9200 + ``` + You should get a response that looks like this: + ```bat + { + "name" : "hostname", + "cluster_name" : "opensearch", + "cluster_uuid" : "6XNc9m2gTUSIoKDqJit0PA", + "version" : { + "distribution" : "opensearch", + "number" : "2.4.0", + "build_type" : "zip", + "build_hash" : "6f6e84ebc54af31a976f53af36a5c69d474a5140", + "build_date" : "2022-11-09T00:07:32.109283578Z", + "build_snapshot" : false, + "lucene_version" : "9.4.1", + "minimum_wire_compatibility_version" : "7.10.0", + "minimum_index_compatibility_version" : "7.0.0" + }, + "tagline" : "The OpenSearch Project: https://opensearch.org/" + } + ``` + - Query the plugins endpoint. + ```bat + curl -X GET http://localhost:9200/_cat/plugins?v + ``` + + The response should look like this: + ```bat + name component version + hostname opensearch-alerting 2.4.0.0 + hostname opensearch-anomaly-detection 2.4.0.0 + hostname opensearch-asynchronous-search 2.4.0.0 + hostname opensearch-cross-cluster-replication 2.4.0.0 + hostname opensearch-index-management 2.4.0.0 + hostname opensearch-job-scheduler 2.4.0.0 + hostname opensearch-knn 2.4.0.0 + hostname opensearch-ml 2.4.0.0 + hostname opensearch-notifications 2.4.0.0 + hostname opensearch-notifications-core 2.4.0.0 + hostname opensearch-observability 2.4.0.0 + hostname opensearch-performance-analyzer 2.4.0.0 + hostname opensearch-reports-scheduler 2.4.0.0 + hostname opensearch-security 2.4.0.0 + hostname opensearch-sql 2.4.0.0 + ``` + +## Step 4: Set up OpenSearch in your environment + +Users who do not have prior experience with OpenSearch may want a list of recommended settings in order to get started with the service. By default, OpenSearch is not bound to a network interface and cannot be reached by external hosts. Additionally, security settings are either undefined (greenfield install) or populated by default usernames and passwords if you ran the security demo script by invoking `opensearch-windows-install.bat`. The following recommendations will enable a user to bind OpenSearch to a network interface. + +The following recommended settings will allow you to: + +- Bind OpenSearch to an IP or network interface on the host. +- Set initial and max JVM heap sizes. +- Define an environment variable that points to the bundled JDK. + +If you ran the security demo script, then you will need to manually reconfigure settings that were modified. Refer to [Security configuration]({{site.url}}{{site.baseurl}}/opensearch/configuration/) for guidance before proceeding. +{:.note} + +Before modifying any configuration files, it's always a good idea to save a backup copy before making changes. The backup file can be used to revert any issues caused by a bad configuration. +{:.tip} + +1. Open the `opensearch-{{site.opensearch_version}}\config` folder. +1. Open the `opensearch.yml` file with a text editor. +1. Add the following lines. + ```bash + # Bind OpenSearch to the correct network interface. Use 0.0.0.0 + # to include all available interfaces or specify an IP address + # assigned to a specific interface. + network.host: 0.0.0.0 + + # Unless you have already configured a cluster, you should set + # discovery.type to single-node, or the bootstrap checks will + # fail when you try to start the service. + discovery.type: single-node + + # If you previously disabled the security plugin in opensearch.yml, + # be sure to re-enable it. Otherwise you can skip this setting. + plugins.security.disabled: false + ``` +1. Save your changes and close the file. +1. Specify initial and max JVM heap sizes. + 1. Open the `opensearch-{{site.opensearch_version}}\config` folder. + 1. Open the `jvm.options` file with a text editor. + 1. Modify the values for initial and max heap sizes. As a starting point, you should set these values to half of the available system memory. For dedicated hosts this value can be increased based on your workflow requirements.
+ As an example, if the host machine has 8 GB of memory then you might want to set the initial and maximum heap sizes to 4 GB: + ```bash + -Xms4g + -Xmx4g + ``` + 1. Save your changes and close the file. +1. Specify the location of the included JDK. For example, on Windows 10, follow the steps below: + 1. In the search box next to **Start** on the taskbar, enter `edit environment variables`. + 1. Select **Edit environment variables for your account** or **Edit the system environment variables**. To edit the system environment variables, you need admin rights. User environment variables take precedence over system environment variables. + 1. Select **New**. + 1. In **Variable name**, enter `OPENSEARCH_JAVA_HOME`. + 1. In **Variable value**, enter `\path\to\opensearch-{{site.opensearch_version}}\jdk`. + 1. Select **OK** twice to close both dialogs. + +## k-NN plugin setup + +The libraries for the k-NN plugin reside in the `opensearch-{{site.opensearch_version}}\plugins\opensearch-knn\lib` folder. The `opensearch-windows-install.bat` script temporarily updates the `PATH` environment variable with the path to the libraries. You can also choose to update this path permanently on your machine. + +For example, on Windows 10, follow the steps below: + +1. In the search box next to **Start** on the taskbar, enter `edit environment variables`. +1. Select **Edit environment variables for your account** or **Edit the system environment variables**. To edit the system environment variables, you need admin rights. The user `PATH` is appended to the system `PATH`. +1. In the **Environment Variables** dialog, select **Path** and choose **Edit...**. +1. Select **New** and enter `%OPENSEARCH_HOME%\plugins\opensearch-knn\lib`. +1. Select **OK** twice to close both dialogs. + +You can move the `lib` folder into a directory of your choice and add the complete path to the `lib` folder (for example, `C:\\knn\lib`) to the `Path` variable. +{: .note} + +## Related links + +- [OpenSearch configuration]({{site.url}}{{site.baseurl}}/opensearch/configuration/) +- [OpenSearch plugin installation]({{site.url}}{{site.baseurl}}/opensearch/install/plugins/) +- [About the security plugin]({{site.url}}{{site.baseurl}}/security-plugin/index/) \ No newline at end of file From aa3bd651c4dffdcd486a5f728b435b2769972dd4 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Wed, 9 Nov 2022 11:28:22 -0500 Subject: [PATCH 02/11] Added the link to download the windows distribution Signed-off-by: Fanit Kolchina --- _opensearch/install/windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md index 60fb0d6c51..bc7e8a1b60 100644 --- a/_opensearch/install/windows.md +++ b/_opensearch/install/windows.md @@ -30,7 +30,7 @@ Make sure you have a zip utility installed. Follow the steps below to install OpenSearch on Windows. -1. Download the [`opensearch-{{site.opensearch_version}}-windows-x64.zip`](#prerequisites){:target='\_blank'} archive. +1. Download the [`opensearch-{{site.opensearch_version}}-windows-x64.zip`](https://artifacts.opensearch.org/releases/bundle/opensearch/{{site.opensearch_version}}/opensearch-{{site.opensearch_version}}-windows-x64.zip){:target='\_blank'} archive. 1. To extract the archive contents, right-click to select **Extract All**. ## Step 2: Review important system settings From 3bd017d1c4cc908ba6780f7e5ba539bc1b3c36a6 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Wed, 9 Nov 2022 14:20:08 -0500 Subject: [PATCH 03/11] Added windows server 2109 as a platform Signed-off-by: Fanit Kolchina --- _opensearch/install/compatibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_opensearch/install/compatibility.md b/_opensearch/install/compatibility.md index 9e897967a1..b8928509e5 100644 --- a/_opensearch/install/compatibility.md +++ b/_opensearch/install/compatibility.md @@ -7,7 +7,7 @@ nav_order: 2 # Operating system compatibility -We recommend installing OpenSearch on Red Hat Enterprise Linux (RHEL) or Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, and Ubuntu Long-Term Support (LTS). OpenSearch should work on most Linux distributions, but we only test a handful. We recommend RHEL 7 or 8, CentOS 7 or 8, Amazon Linux 2, Ubuntu 16.04, 18.04, or 20.04 for any version of OpenSearch. +We recommend installing OpenSearch on Red Hat Enterprise Linux (RHEL) or Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, and Ubuntu Long-Term Support (LTS). OpenSearch should work on most Linux distributions, but we only test a handful. We recommend RHEL 7 or 8, CentOS 7 or 8, Amazon Linux 2, Ubuntu 16.04, 18.04, or 20.04 for any version of OpenSearch. OpenSearch also supports Windows Server 2019. Avoid using a network file system for node storage in a production workflow. Using a network file system for node storage can cause performance issues in your cluster due to factors such as network conditions (like latency or limited throughput) or read/write speeds. You should use solid-state drives (SSDs) installed on the host for node storage where possible. {: .note} From 7a496fe4e6ffbb9f5915e90d26ab20c6504f5663 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Thu, 10 Nov 2022 18:51:16 -0500 Subject: [PATCH 04/11] Adds Windows installation documentation Signed-off-by: Fanit Kolchina --- _dashboards/install/windows.md | 43 +++++++++++++++++ _opensearch/install/windows.md | 84 ++++++++++++---------------------- 2 files changed, 71 insertions(+), 56 deletions(-) create mode 100644 _dashboards/install/windows.md diff --git a/_dashboards/install/windows.md b/_dashboards/install/windows.md new file mode 100644 index 0000000000..4c4c2587c9 --- /dev/null +++ b/_dashboards/install/windows.md @@ -0,0 +1,43 @@ +--- +layout: default +title: Windows +parent: Install OpenSearch Dashboards +nav_order: 37 +--- + +# Run OpenSearch Dashboards on Windows + +Follow the steps below to install OpenSearch Dashboards on Windows. + +Make sure you have a zip utility installed. +{: .tip } + +1. Download the [`opensearch-dashboards-{{site.opensearch_version}}-windows-x64.zip`](https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/{{site.opensearch_version}}/opensearch-dashboards-{{site.opensearch_version}}-windows-x64.zip){:target='\_blank'} archive. + +1. To extract the archive contents, right-click to select **Extract All**. + +1. Run OpenSearch Dashboards. + + There are two ways of running OpenSearch Dashboards: + + 1. Run the batch script using the Windows UI: + + 1. Navigate to the top directory of your OpenSearch Dashboards install and open the `opensearch-dashboards-{{site.opensearch_version}}` folder. + 1. If desired, modify `opensearch_dashboards.yml` located in the `config` folder. + 1. Open the `bin` folder and run the batch script by double-clicking the `opensearch-dashboards.bat` file. This opens a command prompt with an OpenSearch Dashboards instance running. + + 1. Run the batch script from a command prompt or Powershell: + + 1. Open command prompt by entering `cmd`, or Powershell by entering `powershell`, in the search box next to **Start** on the taskbar. + 1. Change to the top directory of your OpenSearch Dashboards install. + ```bat + cd \path\to\opensearch-dashboards-{{site.opensearch_version}} + ``` + 1. If desired, modify `config\opensearch_dashboards.yml`. + 1. Run the batch script to start OpenSearch Dashboards. + ```bat + .\bin\opensearch-dashboards.bat + ``` + +To stop OpenSearch Dashboards, press `Ctrl+C` in command prompt or Powershell, or simply close the command prompt or Powershell window. +{: .tip} \ No newline at end of file diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md index bc7e8a1b60..64bfab6df2 100644 --- a/_opensearch/install/windows.md +++ b/_opensearch/install/windows.md @@ -12,15 +12,13 @@ The following sections describe installing OpenSearch on Windows from a zip arch Generally speaking, the installation of OpenSearch from a zip archive can be broken down into a few steps: 1. **Download and unpack OpenSearch.** -1. **Review important system settings.** - - These settings are applied to the host before modifying any OpenSearch files. 1. **(Optional) Test OpenSearch.** - Confirm that OpenSearch is able to run before you apply any custom configuration. - This can be done without any security (no password, no certificates) or with a demo security configuration that can be applied by a packaged script. 1. **Configure OpenSearch for your environment.** - Apply basic settings to OpenSearch and start using it in your environment. -The Windows Opensearch archive is a self-contained directory with everything needed to run OpenSearch, including an integrated Java Development Kit (JDK). If you have your own Java installation and set the environment variable `JAVA_HOME`, OpenSearch will use that installation if the `OPENSEARCH_JAVA_HOME` environment variable is not set. To learn how to set the `OPENSEARCH_JAVA_HOME` environment variable, see [Step 4: Set up OpenSearch in your environment](#step-4-set-up-opensearch-in-your-environment). +The Windows OpenSearch archive is a self-contained directory with everything needed to run OpenSearch, including an integrated Java Development Kit (JDK). If you have your own Java installation and set the environment variable `JAVA_HOME`, OpenSearch will use that installation if the `OPENSEARCH_JAVA_HOME` environment variable is not set. ## Prerequisites @@ -33,11 +31,7 @@ Follow the steps below to install OpenSearch on Windows. 1. Download the [`opensearch-{{site.opensearch_version}}-windows-x64.zip`](https://artifacts.opensearch.org/releases/bundle/opensearch/{{site.opensearch_version}}/opensearch-{{site.opensearch_version}}-windows-x64.zip){:target='\_blank'} archive. 1. To extract the archive contents, right-click to select **Extract All**. -## Step 2: Review important system settings - -Before launching OpenSearch you should review some [important system settings]({{site.url}}{{site.baseurl}}/opensearch/install/important-settings/){:target='\_blank'}. - -## Step 3: (Optional) Test OpenSearch +## Step 2: (Optional) Test OpenSearch Before proceeding with any configuration, you should test your installation of OpenSearch. Otherwise, it can be difficult to determine whether future problems are due to installation issues or custom settings you applied after installation. There are two quick methods for testing OpenSearch at this stage: @@ -53,35 +47,28 @@ An OpenSearch node in its default configuration (with demo certificates and user ### Option 1: Test your OpenSearch settings with security enabled -To test OpenSearch with security enabled, perform the following steps: - -1. **Run the batch script to start OpenSearch.** You can choose to run the script with default options, or with custom parameters. -1. **Send a request to your OpenSearch instance to verify that it's running**. +1. Run the demo batch script. -**Step 1: Run the batch script to start OpenSearch** + There are two ways of running the batch script: -Run the batch script with either default options or custom parameters. + 1. Run the batch script using the Windows UI: -#### Run the batch script with default options + 1. Navigate to the top directory of your OpenSearch install and open the `opensearch-{{site.opensearch_version}}` folder. + 1. Run the batch script by double-clicking the `opensearch-windows-install.bat` file. This opens a command prompt with an OpenSearch instance running. -1. Open the `opensearch-{{site.opensearch_version}}` folder. -1. Run the default by double-clicking the `opensearch-windows-install.bat` file. This opens a command prompt with the OpenSearch instance running. + 1. Run the batch script from a command prompt or Powershell: -#### Run the batch script with custom parameters - -1. Open command prompt by entering `cmd` in the search box next to **Start** on the taskbar. -1. Change to the top directory of your OpenSearch install. - ```bat - cd \path\to\opensearch-{{site.opensearch_version}} - ``` -1. Run the batch script with custom parameters. - ```bat - call .\opensearch-windows-install.bat "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" "OPENSEARCH_HOSTS=["http://opensearch-node1:9200","http://opensearch-node2:9200"]" - ``` + 1. Open command prompt by entering `cmd`, or Powershell by entering `powershell`, in the search box next to **Start** on the taskbar. + 1. Change to the top directory of your OpenSearch install. + ```bat + cd \path\to\opensearch-{{site.opensearch_version}} + ``` + 1. Run the batch script. + ```bat + .\opensearch-windows-install.bat + ``` -**Step 2: Send a request to your OpenSearch instance to verify that it's running** - -1. Open a command prompt and send requests to the server to verify that OpenSearch is running. Note the use of the `--insecure` flag, which is required because the TLS certificates are self-signed. +1. Open a new command prompt and send requests to the server to verify that OpenSearch is running. Note the use of the `--insecure` flag, which is required because the TLS certificates are self-signed. - Send a request to port 9200. ```bat curl -X GET https://localhost:9200 -u 'admin:admin' --insecure @@ -125,7 +112,6 @@ Run the batch script with either default options or custom parameters. hostname opensearch-notifications 2.4.0.0 hostname opensearch-notifications-core 2.4.0.0 hostname opensearch-observability 2.4.0.0 - hostname opensearch-performance-analyzer 2.4.0.0 hostname opensearch-reports-scheduler 2.4.0.0 hostname opensearch-security 2.4.0.0 hostname opensearch-sql 2.4.0.0 @@ -142,7 +128,7 @@ Run the batch script with either default options or custom parameters. 1. Save the change and close the file. 1. Navigate to the top directory of your OpenSearch install and open the `opensearch-{{site.opensearch_version}}` folder. 1. Run the default by double-clicking the `opensearch-windows-install.bat` file. This opens a command prompt an the OpenSearch instance running. -1. Open another command prompt and send requests to the server to verify that OpenSearch is running. Because the security plugin has been disabled, you will be sending commands using `HTTP` rather than `HTTPS`. +1. Open a new command prompt and send requests to the server to verify that OpenSearch is running. Because the security plugin has been disabled, you will be sending commands using `HTTP` rather than `HTTPS`. - Send a request to port 9200. ```bat curl -X GET http://localhost:9200 @@ -186,15 +172,17 @@ Run the batch script with either default options or custom parameters. hostname opensearch-notifications 2.4.0.0 hostname opensearch-notifications-core 2.4.0.0 hostname opensearch-observability 2.4.0.0 - hostname opensearch-performance-analyzer 2.4.0.0 hostname opensearch-reports-scheduler 2.4.0.0 hostname opensearch-security 2.4.0.0 hostname opensearch-sql 2.4.0.0 ``` -## Step 4: Set up OpenSearch in your environment +To stop OpenSearch, press `Ctrl+C` in command prompt or Powershell, or simply close the command prompt or Powershell window. +{: .tip} + +## Step 3: Set up OpenSearch in your environment -Users who do not have prior experience with OpenSearch may want a list of recommended settings in order to get started with the service. By default, OpenSearch is not bound to a network interface and cannot be reached by external hosts. Additionally, security settings are either undefined (greenfield install) or populated by default usernames and passwords if you ran the security demo script by invoking `opensearch-windows-install.bat`. The following recommendations will enable a user to bind OpenSearch to a network interface. +Users who do not have prior experience with OpenSearch may want a list of recommended settings in order to get started with the service. By default, OpenSearch is not bound to a network interface and cannot be reached by external hosts. Additionally, security settings are either undefined (greenfield install) or populated by default usernames and passwords if you ran the security demo script by invoking `opensearch-windows-install.bat`. The following recommendations will enable a user to bind OpenSearch to a network interface. The following recommended settings will allow you to: @@ -237,28 +225,12 @@ Before modifying any configuration files, it's always a good idea to save a back -Xmx4g ``` 1. Save your changes and close the file. -1. Specify the location of the included JDK. For example, on Windows 10, follow the steps below: - 1. In the search box next to **Start** on the taskbar, enter `edit environment variables`. - 1. Select **Edit environment variables for your account** or **Edit the system environment variables**. To edit the system environment variables, you need admin rights. User environment variables take precedence over system environment variables. - 1. Select **New**. - 1. In **Variable name**, enter `OPENSEARCH_JAVA_HOME`. - 1. In **Variable value**, enter `\path\to\opensearch-{{site.opensearch_version}}\jdk`. - 1. Select **OK** twice to close both dialogs. - -## k-NN plugin setup - -The libraries for the k-NN plugin reside in the `opensearch-{{site.opensearch_version}}\plugins\opensearch-knn\lib` folder. The `opensearch-windows-install.bat` script temporarily updates the `PATH` environment variable with the path to the libraries. You can also choose to update this path permanently on your machine. - -For example, on Windows 10, follow the steps below: +1. Specify the location of the included JDK. + - Set the `OPENSEARCH_JAVA_HOME` environment variable to `\path\to\opensearch-{{site.opensearch_version}}\jdk`. -1. In the search box next to **Start** on the taskbar, enter `edit environment variables`. -1. Select **Edit environment variables for your account** or **Edit the system environment variables**. To edit the system environment variables, you need admin rights. The user `PATH` is appended to the system `PATH`. -1. In the **Environment Variables** dialog, select **Path** and choose **Edit...**. -1. Select **New** and enter `%OPENSEARCH_HOME%\plugins\opensearch-knn\lib`. -1. Select **OK** twice to close both dialogs. +## Plugin compatibility -You can move the `lib` folder into a directory of your choice and add the complete path to the `lib` folder (for example, `C:\\knn\lib`) to the `Path` variable. -{: .note} +The Performance Analyzer plugin is not available on Windows. All other OpenSearch plugins, including the k-NN plugin, are available. For a complete list of plugins, see [Available plugins]({{site.url}}{{site.baseurl}}/opensearch/install/plugins/#available-plugins). ## Related links From 5878064114619b1accf8ce48875346a22fef37de Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Thu, 10 Nov 2022 20:40:42 -0500 Subject: [PATCH 05/11] Updated responses Signed-off-by: Fanit Kolchina --- _opensearch/install/windows.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md index 64bfab6df2..b7ac8b9742 100644 --- a/_opensearch/install/windows.md +++ b/_opensearch/install/windows.md @@ -76,15 +76,15 @@ An OpenSearch node in its default configuration (with demo certificates and user You should get a response that looks like this: ```bat { - "name" : "hostname", + "name" : "SEA-1801411382", "cluster_name" : "opensearch", - "cluster_uuid" : "6XNc9m2gTUSIoKDqJit0PA", + "cluster_uuid" : "7Nqtr0LrQTOveFcBb7Kufw", "version" : { "distribution" : "opensearch", "number" : "2.4.0", "build_type" : "zip", - "build_hash" : "6f6e84ebc54af31a976f53af36a5c69d474a5140", - "build_date" : "2022-11-09T00:07:32.109283578Z", + "build_hash" : "77ef9e304dd6ee95a600720a387a9735bbcf7bc9", + "build_date" : "2022-11-05T05:50:15.404072800Z", "build_snapshot" : false, "lucene_version" : "9.4.1", "minimum_wire_compatibility_version" : "7.10.0", @@ -100,20 +100,22 @@ An OpenSearch node in its default configuration (with demo certificates and user The response should look like this: ```bat - name component version hostname opensearch-alerting 2.4.0.0 hostname opensearch-anomaly-detection 2.4.0.0 hostname opensearch-asynchronous-search 2.4.0.0 hostname opensearch-cross-cluster-replication 2.4.0.0 + hostname opensearch-geospatial 2.4.0.0 hostname opensearch-index-management 2.4.0.0 hostname opensearch-job-scheduler 2.4.0.0 hostname opensearch-knn 2.4.0.0 hostname opensearch-ml 2.4.0.0 + hostname opensearch-neural-search 2.4.0.0 hostname opensearch-notifications 2.4.0.0 hostname opensearch-notifications-core 2.4.0.0 hostname opensearch-observability 2.4.0.0 hostname opensearch-reports-scheduler 2.4.0.0 hostname opensearch-security 2.4.0.0 + hostname opensearch-security-analytics 2.4.0.0 hostname opensearch-sql 2.4.0.0 ``` @@ -136,15 +138,15 @@ An OpenSearch node in its default configuration (with demo certificates and user You should get a response that looks like this: ```bat { - "name" : "hostname", + "name" : "SEA-1801411382", "cluster_name" : "opensearch", - "cluster_uuid" : "6XNc9m2gTUSIoKDqJit0PA", + "cluster_uuid" : "7Nqtr0LrQTOveFcBb7Kufw", "version" : { "distribution" : "opensearch", "number" : "2.4.0", "build_type" : "zip", - "build_hash" : "6f6e84ebc54af31a976f53af36a5c69d474a5140", - "build_date" : "2022-11-09T00:07:32.109283578Z", + "build_hash" : "77ef9e304dd6ee95a600720a387a9735bbcf7bc9", + "build_date" : "2022-11-05T05:50:15.404072800Z", "build_snapshot" : false, "lucene_version" : "9.4.1", "minimum_wire_compatibility_version" : "7.10.0", @@ -160,20 +162,22 @@ An OpenSearch node in its default configuration (with demo certificates and user The response should look like this: ```bat - name component version hostname opensearch-alerting 2.4.0.0 hostname opensearch-anomaly-detection 2.4.0.0 hostname opensearch-asynchronous-search 2.4.0.0 hostname opensearch-cross-cluster-replication 2.4.0.0 + hostname opensearch-geospatial 2.4.0.0 hostname opensearch-index-management 2.4.0.0 hostname opensearch-job-scheduler 2.4.0.0 hostname opensearch-knn 2.4.0.0 hostname opensearch-ml 2.4.0.0 + hostname opensearch-neural-search 2.4.0.0 hostname opensearch-notifications 2.4.0.0 hostname opensearch-notifications-core 2.4.0.0 hostname opensearch-observability 2.4.0.0 hostname opensearch-reports-scheduler 2.4.0.0 hostname opensearch-security 2.4.0.0 + hostname opensearch-security-analytics 2.4.0.0 hostname opensearch-sql 2.4.0.0 ``` From 2182de0c17e52951dc37354c20bd7eb8407e34be Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Thu, 10 Nov 2022 20:42:18 -0500 Subject: [PATCH 06/11] Updated responses Signed-off-by: Fanit Kolchina --- _opensearch/install/windows.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md index b7ac8b9742..6f509adf7e 100644 --- a/_opensearch/install/windows.md +++ b/_opensearch/install/windows.md @@ -76,7 +76,7 @@ An OpenSearch node in its default configuration (with demo certificates and user You should get a response that looks like this: ```bat { - "name" : "SEA-1801411382", + "name" : "hostname-here", "cluster_name" : "opensearch", "cluster_uuid" : "7Nqtr0LrQTOveFcBb7Kufw", "version" : { @@ -138,7 +138,7 @@ An OpenSearch node in its default configuration (with demo certificates and user You should get a response that looks like this: ```bat { - "name" : "SEA-1801411382", + "name" : "hostname-here", "cluster_name" : "opensearch", "cluster_uuid" : "7Nqtr0LrQTOveFcBb7Kufw", "version" : { From cfde65a87280e2fc988c1acb13c9d4b11c7ae41b Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Thu, 10 Nov 2022 20:52:00 -0500 Subject: [PATCH 07/11] Added curl.exe Signed-off-by: Fanit Kolchina --- _opensearch/install/windows.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md index 6f509adf7e..692bfe99b7 100644 --- a/_opensearch/install/windows.md +++ b/_opensearch/install/windows.md @@ -71,7 +71,7 @@ An OpenSearch node in its default configuration (with demo certificates and user 1. Open a new command prompt and send requests to the server to verify that OpenSearch is running. Note the use of the `--insecure` flag, which is required because the TLS certificates are self-signed. - Send a request to port 9200. ```bat - curl -X GET https://localhost:9200 -u 'admin:admin' --insecure + curl.exe -X GET https://localhost:9200 -u 'admin:admin' --insecure ``` You should get a response that looks like this: ```bat @@ -95,7 +95,7 @@ An OpenSearch node in its default configuration (with demo certificates and user ``` - Query the plugins endpoint. ```bat - curl -X GET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure + curl.exe -X GET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure ``` The response should look like this: @@ -133,7 +133,7 @@ An OpenSearch node in its default configuration (with demo certificates and user 1. Open a new command prompt and send requests to the server to verify that OpenSearch is running. Because the security plugin has been disabled, you will be sending commands using `HTTP` rather than `HTTPS`. - Send a request to port 9200. ```bat - curl -X GET http://localhost:9200 + curl.exe -X GET http://localhost:9200 ``` You should get a response that looks like this: ```bat @@ -157,7 +157,7 @@ An OpenSearch node in its default configuration (with demo certificates and user ``` - Query the plugins endpoint. ```bat - curl -X GET http://localhost:9200/_cat/plugins?v + curl.exe -X GET http://localhost:9200/_cat/plugins?v ``` The response should look like this: From dc408579a6cdaf83a260fde50a3574cad8d3a616 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Fri, 11 Nov 2022 14:47:30 -0500 Subject: [PATCH 08/11] Added steps to set environment variables Signed-off-by: Fanit Kolchina --- _opensearch/install/windows.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md index 692bfe99b7..f1e7d72ea7 100644 --- a/_opensearch/install/windows.md +++ b/_opensearch/install/windows.md @@ -18,7 +18,7 @@ Generally speaking, the installation of OpenSearch from a zip archive can be bro 1. **Configure OpenSearch for your environment.** - Apply basic settings to OpenSearch and start using it in your environment. -The Windows OpenSearch archive is a self-contained directory with everything needed to run OpenSearch, including an integrated Java Development Kit (JDK). If you have your own Java installation and set the environment variable `JAVA_HOME`, OpenSearch will use that installation if the `OPENSEARCH_JAVA_HOME` environment variable is not set. +The Windows OpenSearch archive is a self-contained directory with everything needed to run OpenSearch, including an integrated Java Development Kit (JDK). If you have your own Java installation and set the environment variable `JAVA_HOME`, OpenSearch will use that installation if the `OPENSEARCH_JAVA_HOME` environment variable is not set. To learn how to set the `OPENSEARCH_JAVA_HOME` environment variable, see [Step 3: Set up OpenSearch in your environment](#step-3-set-up-opensearch-in-your-environment). ## Prerequisites @@ -230,7 +230,13 @@ Before modifying any configuration files, it's always a good idea to save a back ``` 1. Save your changes and close the file. 1. Specify the location of the included JDK. - - Set the `OPENSEARCH_JAVA_HOME` environment variable to `\path\to\opensearch-{{site.opensearch_version}}\jdk`. + 1. In the search box next to **Start** on the taskbar, enter `edit environment variables for your account` or `edit the system environment variables`. To edit the system environment variables, you need admin rights. User environment variables take precedence over system environment variables. + 1. Select **Edit environment variables for your account** or **Edit the system environment variables**. + 1. If the **System Properties** dialog comes up, in the **Advanced** tab, select **Environment Variables**. + 1. Under **User variables** or **System variables**, select **New**. + 1. In **Variable name**, enter `OPENSEARCH_JAVA_HOME`. + 1. In **Variable value**, enter `\path\to\opensearch-{{site.opensearch_version}}\jdk`. + 1. Select **OK** to close all dialogs. ## Plugin compatibility From dbee470d162b526f7a855714f3e41cdddb24ac4e Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Mon, 14 Nov 2022 09:29:51 -0500 Subject: [PATCH 09/11] Added statement about long path and doc review Signed-off-by: Fanit Kolchina --- _dashboards/install/windows.md | 17 +++++++++++++---- _opensearch/install/windows.md | 4 ++-- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/_dashboards/install/windows.md b/_dashboards/install/windows.md index 4c4c2587c9..904a78aeba 100644 --- a/_dashboards/install/windows.md +++ b/_dashboards/install/windows.md @@ -15,20 +15,29 @@ Make sure you have a zip utility installed. 1. Download the [`opensearch-dashboards-{{site.opensearch_version}}-windows-x64.zip`](https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/{{site.opensearch_version}}/opensearch-dashboards-{{site.opensearch_version}}-windows-x64.zip){:target='\_blank'} archive. 1. To extract the archive contents, right-click to select **Extract All**. + + Note: Some versions of the Windows operating system limit the file path length. If you encounter a path length-related error when unzipping the archive, perform the following steps to enable long path support: + + 1. Open Powershell by entering `powershell` in the search box next to **Start** on the taskbar. + 1. Run the following command in Powershell: + ```bat + Set-ItemProperty -Path HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem LongPathsEnabled -Type DWORD -Value 1 -Force + ``` + 1. Restart your computer. 1. Run OpenSearch Dashboards. There are two ways of running OpenSearch Dashboards: - 1. Run the batch script using the Windows UI: + 1. Run the batch script using the Windows user interface: 1. Navigate to the top directory of your OpenSearch Dashboards install and open the `opensearch-dashboards-{{site.opensearch_version}}` folder. 1. If desired, modify `opensearch_dashboards.yml` located in the `config` folder. 1. Open the `bin` folder and run the batch script by double-clicking the `opensearch-dashboards.bat` file. This opens a command prompt with an OpenSearch Dashboards instance running. - 1. Run the batch script from a command prompt or Powershell: + 1. Run the batch script from Command Prompt or Powershell: - 1. Open command prompt by entering `cmd`, or Powershell by entering `powershell`, in the search box next to **Start** on the taskbar. + 1. Open Command Prompt by entering `cmd`, or Powershell by entering `powershell`, in the search box next to **Start** on the taskbar. 1. Change to the top directory of your OpenSearch Dashboards install. ```bat cd \path\to\opensearch-dashboards-{{site.opensearch_version}} @@ -39,5 +48,5 @@ Make sure you have a zip utility installed. .\bin\opensearch-dashboards.bat ``` -To stop OpenSearch Dashboards, press `Ctrl+C` in command prompt or Powershell, or simply close the command prompt or Powershell window. +To stop OpenSearch Dashboards, press `Ctrl+C` in Command Prompt or Powershell, or simply close the Command Prompt or Powershell window. {: .tip} \ No newline at end of file diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md index f1e7d72ea7..bef5ec2ff2 100644 --- a/_opensearch/install/windows.md +++ b/_opensearch/install/windows.md @@ -129,7 +129,7 @@ An OpenSearch node in its default configuration (with demo certificates and user ``` 1. Save the change and close the file. 1. Navigate to the top directory of your OpenSearch install and open the `opensearch-{{site.opensearch_version}}` folder. -1. Run the default by double-clicking the `opensearch-windows-install.bat` file. This opens a command prompt an the OpenSearch instance running. +1. Run the default by double-clicking the `opensearch-windows-install.bat` file. This opens a command prompt with an OpenSearch instance running. 1. Open a new command prompt and send requests to the server to verify that OpenSearch is running. Because the security plugin has been disabled, you will be sending commands using `HTTP` rather than `HTTPS`. - Send a request to port 9200. ```bat @@ -223,7 +223,7 @@ Before modifying any configuration files, it's always a good idea to save a back 1. Open the `opensearch-{{site.opensearch_version}}\config` folder. 1. Open the `jvm.options` file with a text editor. 1. Modify the values for initial and max heap sizes. As a starting point, you should set these values to half of the available system memory. For dedicated hosts this value can be increased based on your workflow requirements.
- As an example, if the host machine has 8 GB of memory then you might want to set the initial and maximum heap sizes to 4 GB: + As an example, if the host machine has 8 GB of memory, then you might want to set the initial and maximum heap sizes to 4 GB: ```bash -Xms4g -Xmx4g From 6a82e258178d1ac07750311fddb02a8d3b880004 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Mon, 14 Nov 2022 12:11:00 -0500 Subject: [PATCH 10/11] Incorporated doc review comments Signed-off-by: Fanit Kolchina --- _dashboards/install/windows.md | 6 +++--- _opensearch/install/windows.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/_dashboards/install/windows.md b/_dashboards/install/windows.md index 904a78aeba..01af882b6d 100644 --- a/_dashboards/install/windows.md +++ b/_dashboards/install/windows.md @@ -10,13 +10,13 @@ nav_order: 37 Follow the steps below to install OpenSearch Dashboards on Windows. Make sure you have a zip utility installed. -{: .tip } +{: .note } 1. Download the [`opensearch-dashboards-{{site.opensearch_version}}-windows-x64.zip`](https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/{{site.opensearch_version}}/opensearch-dashboards-{{site.opensearch_version}}-windows-x64.zip){:target='\_blank'} archive. 1. To extract the archive contents, right-click to select **Extract All**. - Note: Some versions of the Windows operating system limit the file path length. If you encounter a path length-related error when unzipping the archive, perform the following steps to enable long path support: + **Note**: Some versions of the Windows operating system limit the file path length. If you encounter a path-length-related error when unzipping the archive, perform the following steps to enable long path support: 1. Open Powershell by entering `powershell` in the search box next to **Start** on the taskbar. 1. Run the following command in Powershell: @@ -32,7 +32,7 @@ Make sure you have a zip utility installed. 1. Run the batch script using the Windows user interface: 1. Navigate to the top directory of your OpenSearch Dashboards install and open the `opensearch-dashboards-{{site.opensearch_version}}` folder. - 1. If desired, modify `opensearch_dashboards.yml` located in the `config` folder. + 1. If desired, modify `opensearch_dashboards.yml` located in the `config` folder to change the default OpenSearch Dasbhoards settings. 1. Open the `bin` folder and run the batch script by double-clicking the `opensearch-dashboards.bat` file. This opens a command prompt with an OpenSearch Dashboards instance running. 1. Run the batch script from Command Prompt or Powershell: diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md index bef5ec2ff2..b1c7ca4471 100644 --- a/_opensearch/install/windows.md +++ b/_opensearch/install/windows.md @@ -232,7 +232,7 @@ Before modifying any configuration files, it's always a good idea to save a back 1. Specify the location of the included JDK. 1. In the search box next to **Start** on the taskbar, enter `edit environment variables for your account` or `edit the system environment variables`. To edit the system environment variables, you need admin rights. User environment variables take precedence over system environment variables. 1. Select **Edit environment variables for your account** or **Edit the system environment variables**. - 1. If the **System Properties** dialog comes up, in the **Advanced** tab, select **Environment Variables**. + 1. If the **System Properties** dialog opens, in the **Advanced** tab, select **Environment Variables**. 1. Under **User variables** or **System variables**, select **New**. 1. In **Variable name**, enter `OPENSEARCH_JAVA_HOME`. 1. In **Variable value**, enter `\path\to\opensearch-{{site.opensearch_version}}\jdk`. From 3b2c3a5d71028992e1b1749d1baace7fc0a88f00 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Mon, 14 Nov 2022 14:26:28 -0500 Subject: [PATCH 11/11] Implemented editorial feedback Signed-off-by: Fanit Kolchina --- _dashboards/install/windows.md | 10 ++++----- _opensearch/install/compatibility.md | 2 +- _opensearch/install/windows.md | 32 ++++++++++++++-------------- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/_dashboards/install/windows.md b/_dashboards/install/windows.md index 01af882b6d..58659c351e 100644 --- a/_dashboards/install/windows.md +++ b/_dashboards/install/windows.md @@ -7,7 +7,7 @@ nav_order: 37 # Run OpenSearch Dashboards on Windows -Follow the steps below to install OpenSearch Dashboards on Windows. +Perform the following steps to install OpenSearch Dashboards on Windows. Make sure you have a zip utility installed. {: .note } @@ -29,16 +29,16 @@ Make sure you have a zip utility installed. There are two ways of running OpenSearch Dashboards: - 1. Run the batch script using the Windows user interface: + 1. Run the batch script using the Windows UI: - 1. Navigate to the top directory of your OpenSearch Dashboards install and open the `opensearch-dashboards-{{site.opensearch_version}}` folder. - 1. If desired, modify `opensearch_dashboards.yml` located in the `config` folder to change the default OpenSearch Dasbhoards settings. + 1. Navigate to the top directory of your OpenSearch Dashboards installation and open the `opensearch-dashboards-{{site.opensearch_version}}` folder. + 1. If desired, modify `opensearch_dashboards.yml` located in the `config` folder, to change the default OpenSearch Dashboards settings. 1. Open the `bin` folder and run the batch script by double-clicking the `opensearch-dashboards.bat` file. This opens a command prompt with an OpenSearch Dashboards instance running. 1. Run the batch script from Command Prompt or Powershell: 1. Open Command Prompt by entering `cmd`, or Powershell by entering `powershell`, in the search box next to **Start** on the taskbar. - 1. Change to the top directory of your OpenSearch Dashboards install. + 1. Change to the top directory of your OpenSearch Dashboards installation. ```bat cd \path\to\opensearch-dashboards-{{site.opensearch_version}} ``` diff --git a/_opensearch/install/compatibility.md b/_opensearch/install/compatibility.md index b8928509e5..424d9404db 100644 --- a/_opensearch/install/compatibility.md +++ b/_opensearch/install/compatibility.md @@ -7,7 +7,7 @@ nav_order: 2 # Operating system compatibility -We recommend installing OpenSearch on Red Hat Enterprise Linux (RHEL) or Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, and Ubuntu Long-Term Support (LTS). OpenSearch should work on most Linux distributions, but we only test a handful. We recommend RHEL 7 or 8, CentOS 7 or 8, Amazon Linux 2, Ubuntu 16.04, 18.04, or 20.04 for any version of OpenSearch. OpenSearch also supports Windows Server 2019. +We recommend installing OpenSearch on Red Hat Enterprise Linux (RHEL) or Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, or Ubuntu Long-Term Support (LTS). OpenSearch should work on most Linux distributions, but we only test a handful. We recommend RHEL 7 or 8, CentOS 7 or 8, Amazon Linux 2, or Ubuntu 16.04, 18.04, or 20.04 for any version of OpenSearch. OpenSearch also supports Windows Server 2019. Avoid using a network file system for node storage in a production workflow. Using a network file system for node storage can cause performance issues in your cluster due to factors such as network conditions (like latency or limited throughput) or read/write speeds. You should use solid-state drives (SSDs) installed on the host for node storage where possible. {: .note} diff --git a/_opensearch/install/windows.md b/_opensearch/install/windows.md index b1c7ca4471..1f5e3c49a3 100644 --- a/_opensearch/install/windows.md +++ b/_opensearch/install/windows.md @@ -26,7 +26,7 @@ Make sure you have a zip utility installed. ## Step 1: Download and unpack OpenSearch -Follow the steps below to install OpenSearch on Windows. +Perform the following steps to install OpenSearch on Windows. 1. Download the [`opensearch-{{site.opensearch_version}}-windows-x64.zip`](https://artifacts.opensearch.org/releases/bundle/opensearch/{{site.opensearch_version}}/opensearch-{{site.opensearch_version}}-windows-x64.zip){:target='\_blank'} archive. 1. To extract the archive contents, right-click to select **Extract All**. @@ -53,13 +53,13 @@ An OpenSearch node in its default configuration (with demo certificates and user 1. Run the batch script using the Windows UI: - 1. Navigate to the top directory of your OpenSearch install and open the `opensearch-{{site.opensearch_version}}` folder. + 1. Navigate to the top directory of your OpenSearch installation and open the `opensearch-{{site.opensearch_version}}` folder. 1. Run the batch script by double-clicking the `opensearch-windows-install.bat` file. This opens a command prompt with an OpenSearch instance running. - 1. Run the batch script from a command prompt or Powershell: + 1. Run the batch script from Command prompt or Powershell: - 1. Open command prompt by entering `cmd`, or Powershell by entering `powershell`, in the search box next to **Start** on the taskbar. - 1. Change to the top directory of your OpenSearch install. + 1. Open Command Prompt by entering `cmd`, or Powershell by entering `powershell`, in the search box next to **Start** on the taskbar. + 1. Change to the top directory of your OpenSearch installation. ```bat cd \path\to\opensearch-{{site.opensearch_version}} ``` @@ -69,7 +69,7 @@ An OpenSearch node in its default configuration (with demo certificates and user ``` 1. Open a new command prompt and send requests to the server to verify that OpenSearch is running. Note the use of the `--insecure` flag, which is required because the TLS certificates are self-signed. - - Send a request to port 9200. + - Send a request to port 9200: ```bat curl.exe -X GET https://localhost:9200 -u 'admin:admin' --insecure ``` @@ -93,7 +93,7 @@ An OpenSearch node in its default configuration (with demo certificates and user "tagline" : "The OpenSearch Project: https://opensearch.org/" } ``` - - Query the plugins endpoint. + - Query the plugins endpoint: ```bat curl.exe -X GET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure ``` @@ -123,15 +123,15 @@ An OpenSearch node in its default configuration (with demo certificates and user 1. Open the `opensearch-{{site.opensearch_version}}\config` folder. 1. Open the `opensearch.yml` file with a text editor. -1. Add the following line to disable the security plugin. +1. Add the following line to disable the security plugin: ```yaml plugins.security.disabled: true ``` 1. Save the change and close the file. -1. Navigate to the top directory of your OpenSearch install and open the `opensearch-{{site.opensearch_version}}` folder. +1. Navigate to the top directory of your OpenSearch installation and open the `opensearch-{{site.opensearch_version}}` folder. 1. Run the default by double-clicking the `opensearch-windows-install.bat` file. This opens a command prompt with an OpenSearch instance running. 1. Open a new command prompt and send requests to the server to verify that OpenSearch is running. Because the security plugin has been disabled, you will be sending commands using `HTTP` rather than `HTTPS`. - - Send a request to port 9200. + - Send a request to port 9200: ```bat curl.exe -X GET http://localhost:9200 ``` @@ -155,7 +155,7 @@ An OpenSearch node in its default configuration (with demo certificates and user "tagline" : "The OpenSearch Project: https://opensearch.org/" } ``` - - Query the plugins endpoint. + - Query the plugins endpoint: ```bat curl.exe -X GET http://localhost:9200/_cat/plugins?v ``` @@ -181,7 +181,7 @@ An OpenSearch node in its default configuration (with demo certificates and user hostname opensearch-sql 2.4.0.0 ``` -To stop OpenSearch, press `Ctrl+C` in command prompt or Powershell, or simply close the command prompt or Powershell window. +To stop OpenSearch, press `Ctrl+C` in Command Prompt or Powershell, or simply close the Command Prompt or Powershell window. {: .tip} ## Step 3: Set up OpenSearch in your environment @@ -191,7 +191,7 @@ Users who do not have prior experience with OpenSearch may want a list of recomm The following recommended settings will allow you to: - Bind OpenSearch to an IP or network interface on the host. -- Set initial and max JVM heap sizes. +- Set initial and maximum JVM heap sizes. - Define an environment variable that points to the bundled JDK. If you ran the security demo script, then you will need to manually reconfigure settings that were modified. Refer to [Security configuration]({{site.url}}{{site.baseurl}}/opensearch/configuration/) for guidance before proceeding. @@ -202,7 +202,7 @@ Before modifying any configuration files, it's always a good idea to save a back 1. Open the `opensearch-{{site.opensearch_version}}\config` folder. 1. Open the `opensearch.yml` file with a text editor. -1. Add the following lines. +1. Add the following lines: ```bash # Bind OpenSearch to the correct network interface. Use 0.0.0.0 # to include all available interfaces or specify an IP address @@ -219,10 +219,10 @@ Before modifying any configuration files, it's always a good idea to save a back plugins.security.disabled: false ``` 1. Save your changes and close the file. -1. Specify initial and max JVM heap sizes. +1. Specify initial and maximum JVM heap sizes. 1. Open the `opensearch-{{site.opensearch_version}}\config` folder. 1. Open the `jvm.options` file with a text editor. - 1. Modify the values for initial and max heap sizes. As a starting point, you should set these values to half of the available system memory. For dedicated hosts this value can be increased based on your workflow requirements.
+ 1. Modify the values for initial and maximum heap sizes. As a starting point, you should set these values to half of the available system memory. For dedicated hosts this value can be increased based on your workflow requirements.
As an example, if the host machine has 8 GB of memory, then you might want to set the initial and maximum heap sizes to 4 GB: ```bash -Xms4g