Adds windows installation documentation #1825

kolchfa-aws · 2022-11-06T20:45:58Z

Fixes #1721

Checklist

[ x] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

peterzhuamazon

I have no issues with this document. Thanks @kolchfa-aws.

Need more approval from @CEHENKLE @bbarani @setiah.

Thanks.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

peterzhuamazon · 2022-11-11T22:46:54Z

After offline talk with @kolchfa-aws we will add instruction on the long path:

set-ItemProperty -Path HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem LongPathsEnabled -Type DWORD -Value 1 -Force

Run above in powershell and reboot windows, to enable long path support over 255-260 characters. Thanks.

vagimeli

Minimal edits/comments. LGTM.

vagimeli · 2022-11-11T21:50:23Z

_dashboards/install/windows.md

+
+   There are two ways of running OpenSearch Dashboards:
+
+   1. Run the batch script using the Windows UI:


Is Windows UI a proper name? Should UI be defined on first mention?

Windows Desktop Environment?
Not really sure how to call it as well, windows does categorize them as desktop vs server.

I'll spell out user interface

vagimeli · 2022-11-11T21:51:35Z

_dashboards/install/windows.md

+
+   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. 


Open "the" command prompt?

I am referring to the application, so I'll capitalize all instances of Command Prompt.

vagimeli · 2022-11-11T21:53:07Z

_dashboards/install/windows.md

+         .\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.


in "the" command prompt?

_opensearch/install/windows.md

vagimeli · 2022-11-11T23:56:17Z

_opensearch/install/windows.md

+   ```
+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.


Should "with" precede "an"?

_opensearch/install/windows.md

vagimeli · 2022-11-12T00:00:09Z

_opensearch/install/windows.md

+   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.<br>
+    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:


Insert comma after "memory"

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

cwillum · 2022-11-14T16:38:24Z

_dashboards/install/windows.md

+
+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:


Can you indent 4 times and use the {: .note } tag to put this in that formatting? Or is the note intended to be expressed like this? I think indenting 4x preserves the numbered list.
"path-length related error"

I can for this sentence, but it has related steps that follow, and it does not look good when the note is in the note format, and the steps are not... I can also make it 2 different notes, but that's an even more awkward-looking syntax.

I will bold the word "note"

cwillum · 2022-11-14T16:44:45Z

_dashboards/install/windows.md

+   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.


Is this to set general preferences for Dashboards? Tag on three or four words explaining this?

cwillum · 2022-11-14T16:50:45Z

_dashboards/install/windows.md

+
+Follow the steps below to install OpenSearch Dashboards on Windows.
+
+Make sure you have a zip utility installed.


You make this a prerequisite for OpenSearch installation. What do you think of changing this to a note instead of tip?

cwillum · 2022-11-14T17:04:09Z

_opensearch/install/windows.md

+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**.


If the System Properties dialog opens, got to the Advanced tab and select Environment Variables.
Read better?

The thing is - it opens already on the Advanced tab, so all you do is select EV. Will reword.

cwillum

LVVGTM

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

natebower

@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

natebower · 2022-11-14T17:18:06Z

_dashboards/install/windows.md

+
+Follow the steps below to install OpenSearch Dashboards on Windows.
+
+Make sure you have a zip utility installed.


Normally, zip is not capitalized.

natebower · 2022-11-14T17:19:08Z

_dashboards/install/windows.md

+
+# Run OpenSearch Dashboards on Windows
+
+Follow the steps below to install OpenSearch Dashboards on Windows.


Suggested change

Follow the steps below to install OpenSearch Dashboards on Windows.

Perform the following steps to install OpenSearch Dashboards on Windows.

natebower · 2022-11-14T17:20:20Z

_dashboards/install/windows.md

+
+   There are two ways of running OpenSearch Dashboards:
+
+   1. Run the batch script using the Windows user interface:


Suggested change

1. Run the batch script using the Windows user interface:

1. Run the batch script using the Windows UI:

natebower · 2022-11-14T17:20:40Z

_dashboards/install/windows.md

+
+   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.


Suggested change

1. Navigate to the top directory of your OpenSearch Dashboards install and open the `opensearch-dashboards-{{site.opensearch_version}}` folder.

1. Navigate to the top directory of your OpenSearch Dashboards installation and open the `opensearch-dashboards-{{site.opensearch_version}}` folder.

natebower · 2022-11-14T17:21:28Z

_dashboards/install/windows.md

+   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 to change the default OpenSearch Dasbhoards settings.


Suggested change

1. If desired, modify `opensearch_dashboards.yml` located in the `config` folder to change the default OpenSearch Dasbhoards settings.

1. If desired, modify `opensearch_dashboards.yml`, located in the `config` folder, to change the default OpenSearch Dashboards settings.

natebower · 2022-11-14T17:43:14Z

_opensearch/install/windows.md

+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 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.


Should this end in a colon?

natebower · 2022-11-14T17:43:23Z

_opensearch/install/windows.md

+         "tagline" : "The OpenSearch Project: https://opensearch.org/"
+      }
+      ```
+   - Query the plugins endpoint.


Should this end in a colon?

natebower · 2022-11-14T17:43:49Z

_opensearch/install/windows.md

+      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.


Suggested change

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.

natebower · 2022-11-14T17:45:17Z

_opensearch/install/windows.md

+
+1. Open the `opensearch-{{site.opensearch_version}}\config` folder.
+1. Open the `opensearch.yml` file with a text editor.
+1. Add the following lines.


Should this end in a colon?

natebower · 2022-11-14T17:46:15Z

_opensearch/install/windows.md

+   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.<br>
+    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:


We use "maximum" here but have used "max" in all previous instances. Please make consistent.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds windows installation documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added the link to download the windows distribution Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added windows server 2109 as a platform Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Adds Windows installation documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated responses Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated responses Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added curl.exe Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added steps to set environment variables Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added statement about long path and doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Incorporated doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented editorial feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> (cherry picked from commit bf4ad6b)

* Adds windows installation documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added the link to download the windows distribution Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added windows server 2109 as a platform Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Adds Windows installation documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated responses Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated responses Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added curl.exe Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added steps to set environment variables Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added statement about long path and doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Incorporated doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented editorial feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> (cherry picked from commit bf4ad6b) Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Adds windows installation documentation

498d31d

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws self-assigned this Nov 6, 2022

kolchfa-aws added 3 - Tech review PR: Tech review in progress v2.4.0 'Issues and PRs related to version v2.4.0' labels Nov 6, 2022

kolchfa-aws added 5 commits November 9, 2022 11:28

Added the link to download the windows distribution

aa3bd65

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Added windows server 2109 as a platform

3bd017d

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Adds Windows installation documentation

7a496fe

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Updated responses

5878064

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Updated responses

2182de0

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

peterzhuamazon mentioned this pull request Nov 11, 2022

[RELEASE] Release version 2.4.0 opensearch-project/opensearch-build#2649

Closed

52 tasks

Added curl.exe

cfde65a

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

peterzhuamazon requested review from zelinh and peterzhuamazon November 11, 2022 04:31

peterzhuamazon reviewed Nov 11, 2022

View reviewed changes

Added steps to set environment variables

dc40857

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

vagimeli approved these changes Nov 12, 2022

View reviewed changes

Added statement about long path and doc review

dbee470

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

cwillum reviewed Nov 14, 2022

View reviewed changes

cwillum approved these changes Nov 14, 2022

View reviewed changes

Incorporated doc review comments

6a82e25

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

natebower reviewed Nov 14, 2022

View reviewed changes

Implemented editorial feedback

3b2c3a5

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

peterzhuamazon approved these changes Nov 14, 2022

View reviewed changes

kolchfa-aws marked this pull request as ready for review November 15, 2022 16:04

kolchfa-aws requested a review from a team as a code owner November 15, 2022 16:04

kolchfa-aws merged commit bf4ad6b into main Nov 15, 2022

kolchfa-aws mentioned this pull request Nov 22, 2022

[DOC]: OpenSearch Installation on Windows #1721

Closed

4 tasks

Naarcha-AWS deleted the Fix1721-windows-install branch December 13, 2022 19:57

kolchfa-aws added the backport 1.3 PR: Backport label for v1.3.x label Dec 13, 2022

opensearch-trigger-bot bot mentioned this pull request Dec 13, 2022

[Backport 1.3] Adds windows installation documentation #2200

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds windows installation documentation #1825

Adds windows installation documentation #1825

kolchfa-aws commented Nov 6, 2022 •

edited

Loading

peterzhuamazon left a comment

peterzhuamazon commented Nov 11, 2022 •

edited

Loading

vagimeli left a comment

vagimeli Nov 11, 2022 •

edited

Loading

peterzhuamazon Nov 12, 2022

kolchfa-aws Nov 14, 2022

vagimeli Nov 11, 2022

kolchfa-aws Nov 14, 2022

vagimeli Nov 11, 2022

vagimeli Nov 11, 2022

vagimeli Nov 12, 2022

cwillum Nov 14, 2022

kolchfa-aws Nov 14, 2022

kolchfa-aws Nov 14, 2022

cwillum Nov 14, 2022

cwillum Nov 14, 2022

cwillum Nov 14, 2022

kolchfa-aws Nov 14, 2022

cwillum left a comment

natebower left a comment

natebower Nov 14, 2022

kolchfa-aws Nov 14, 2022

natebower Nov 14, 2022

natebower Nov 14, 2022

natebower Nov 14, 2022

natebower Nov 14, 2022

natebower Nov 14, 2022

natebower Nov 14, 2022

natebower Nov 14, 2022

natebower Nov 14, 2022

natebower Nov 14, 2022


		There are two ways of running OpenSearch Dashboards:

		1. Run the batch script using the Windows UI:


		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. 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:


		Follow the steps below to install OpenSearch Dashboards on Windows.

		Make sure you have a zip utility installed.


		# Run OpenSearch Dashboards on Windows

		Follow the steps below to install OpenSearch Dashboards on Windows.

	Follow the steps below to install OpenSearch Dashboards on Windows.
	Perform the following steps to install OpenSearch Dashboards on Windows.


		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 to change the default OpenSearch Dasbhoards settings.
	1. If desired, modify `opensearch_dashboards.yml`, located in the `config` folder, to change the default OpenSearch Dashboards settings.

	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.

Adds windows installation documentation #1825

Adds windows installation documentation #1825

Conversation

kolchfa-aws commented Nov 6, 2022 • edited Loading

Checklist

peterzhuamazon left a comment

Choose a reason for hiding this comment

peterzhuamazon commented Nov 11, 2022 • edited Loading

vagimeli left a comment

Choose a reason for hiding this comment

vagimeli Nov 11, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwillum left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kolchfa-aws commented Nov 6, 2022 •

edited

Loading

peterzhuamazon commented Nov 11, 2022 •

edited

Loading

vagimeli Nov 11, 2022 •

edited

Loading