(DOCS-10468): Revised Windows Install for MongoDB #3346

atsansone · 2018-06-19T16:55:03Z

@steveren : This is a total refactor.

steveren · 2018-06-19T17:28:43Z

source/includes/fact-install-windows-prereq.rst

+
+   .. code-block:: powershell
+
+      PS C:\> systeminfo | findstr /B /C:"OS Name" /C:"OS Version" /C:"System Type"


Need to remove the "PS C:>" part at the beginning for this command to be copy-pastable.

Agreed. Fixed.

steveren · 2018-06-19T17:33:41Z

source/includes/fact-install-windows-prereq.rst

+.. warning::
+
+   Do not expose :binary:`~bin.mongod.exe` to a public network without 
+   configuring authentication. MongoDB is designed to be run in 


I'd link "authentication" to the manual page.

Agreed. Fixed.

steveren · 2018-06-19T17:38:23Z

source/tutorial/install-mongodb-enterprise-on-windows.txt


-   wmic os get caption
-   wmic os get osarchitecture
+1. Press the :icon:`windows` key.


Nifty use of the Windows icon, but not all keyboards have that key (mine doesn't, for example, but I'm not really a Windows user). If you're confident that everyone reading this has a Windows key, leave it as is, but for total inclusivity I'd use an alternate method for bringing up cmd.exe.

Added point about Start menu.

steveren · 2018-06-19T17:51:46Z

source/includes/steps-install-mongodb-enterprise-on-windows-unattended.yaml

+
+  #. The Download Center should display the 
+     :guilabel:`Current Stable Release` and have the :icon:`windows` 
+     :guilabel:`Windows` tab selected. If that tab is not selected, 


You're describing the Community Server download center page here. The Enterprise Server download center UI looks different.

Fixed. Created new steps page to cover.

steveren · 2018-06-19T18:46:32Z

source/includes/steps-run-mongodb-on-windows.yaml

+
+  .. code-block:: shell
+
+     [initandlisten] waiting for connections


If you start mongod.exe with the --logpath option, all the [initandlisten] messages go to the logfile. There are two copyable commands here, and one uses --logpath and the other doesn't, which might lead to confusion.

Also, no need for the log message code block to be copyable.

steveren · 2018-06-19T18:51:09Z

source/includes/steps-create-manually-windows-service-for-mongodb.yaml

+  log:
+
+  .. code-block:: bat
+
      [SC] CreateService SUCCESS
 ---


Again, no need for this code block to be copyable. It seems like a nit, but I think it's helpful to distinguish copyable code blocks from log messages and such.

Agreed. Fixed.

steveren · 2018-06-19T18:56:24Z

source/includes/steps-create-manually-windows-service-for-mongodb.yaml

 ---
-stepnum: 6
+stepnum: 5
 source:
  file: steps-run-mongodb-on-linux.yaml


This file isn't part of the review, but as long as you've got it open you could add a period to the end of the title line, "Verify that MongoDB has started successfully"

Also that file has the code block with the [initandlisten] message, which should get (my pet peeve) the :copyable: false line.

Agreed. Fixed.

steveren · 2018-06-19T19:44:46Z

source/includes/steps-create-manually-windows-service-for-mongodb.yaml

+  to create the service:  
+
+  .. code-block:: bat
+
      sc.exe create MongoDB ^
        binPath= "\"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe\" ^
        --service --config=\"C:\Program Files\MongoDB\Server\{+version+}\mongod.cfg\"" ^
        DisplayName= "MongoDB" start= "auto"


This command didn't work for me in cmd.exe. I got this:

C:\WINDOWS\system32>sc.exe create MongoDB ^
More? binPath= ""C:\Program Files\MongoDB\Server\4.0\bin\mongod.exe" ^
[SC] CreateService SUCCESS

C:\WINDOWS\system32> --service --config="C:\Program Files\MongoDB\Server\4.0\mongod.cfg"" ^
'--service' is not recognized as an internal or external command,
operable program or batch file.

I also tried in Powershell (as administrator) and got a different error. Maybe retest?

Yeah. This is a tough one to cut and paste. Two lines is usually the limit. Fixed.

steveren · 2018-06-19T19:50:39Z

source/tutorial/install-mongodb-enterprise-on-windows.txt


-.. include:: /includes/steps/run-mongodb-on-windows.rst
+         .. include:: /includes/steps/install-mongodb-enterprise-on-windows-unattended.rst



The command msiexec.exe /q /i mongodb-win32-x86_64-enterprise-windows-64-4.0.0-rc5-signed.msi worked for me, but I had to adjust the name of the .msi file. We might want to either use a placeholder value or just note that users should run msiexec.exe on their downloaded .msi file.

It's using the variable for the most recent release. That works against us when testing.

steveren · 2018-06-19T20:00:29Z

source/tutorial/install-mongodb-enterprise-on-windows.txt

@@ -10,90 +10,107 @@ Install MongoDB Enterprise on Windows
   :depth: 1
   :class: singlecol

+.. |mdb-edition| replace:: MongoDB Enterprise Edition
+.. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/download-center#enterprise>`__
+
 .. versionadded:: 2.6


Does this still need to be here?

Nah. Deleted.

markbenvenuto · 2018-06-19T21:04:42Z

source/includes/fact-install-windows-prereq.rst

+     an issue with memory mapped files on Windows.
+
+The Windows installer (``.msi``) file includes all other
+software dependencies and automatically upgrades any previous version 


It only upgrades patch level in the same release

Automatic Upgrade: 3.4.1 -> 3.4.2
Not Upgrade, treated as two separate installs: 3.4.1 -> 3.6.0

markbenvenuto · 2018-06-19T21:05:48Z

source/includes/fact-install-windows.rst

+
+   During the installation process you will be given the option to
+   install :ref:`MongoDB Compass <compass-index>` after installing
+   MongoDB Server. Clear the checkbox for this option. At this time, 


We back ported the fix to be in 3.6. It was fixed for 4.0

markbenvenuto · 2018-06-19T21:06:16Z

source/includes/release-base.yaml

+copyable: true
+language: bat
+code: |
+  msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^


use enterprise file instead of ssl in example

still needs to be fixed

markbenvenuto · 2018-06-19T21:08:31Z

source/includes/steps-install-mongodb-on-windows-interactive.yaml

+
+      During the installation process you will be given the option to
+      install :ref:`MongoDB Compass <compass-index>` after installing
+      MongoDB Server. Clear the checkbox for this option. At this 


see other note

markbenvenuto · 2018-06-19T21:11:07Z

Also, does this documentation account for the fact that the MSI now installs the service in 4.0?

atsansone

@steveren : Made the changes. Back to you.

atsansone · 2018-06-19T20:53:42Z

source/includes/fact-install-windows-prereq.rst

+
+   .. code-block:: powershell
+
+      PS C:\> systeminfo | findstr /B /C:"OS Name" /C:"OS Version" /C:"System Type"


Agreed. Fixed.

atsansone · 2018-06-19T20:54:39Z

source/includes/fact-install-windows-prereq.rst

+.. warning::
+
+   Do not expose :binary:`~bin.mongod.exe` to a public network without 
+   configuring authentication. MongoDB is designed to be run in 


Agreed. Fixed.

atsansone · 2018-06-19T21:13:45Z

source/includes/steps-create-manually-windows-service-for-mongodb.yaml

+  to create the service:  
+
+  .. code-block:: bat
+
      sc.exe create MongoDB ^
        binPath= "\"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe\" ^
        --service --config=\"C:\Program Files\MongoDB\Server\{+version+}\mongod.cfg\"" ^
        DisplayName= "MongoDB" start= "auto"


Yeah. This is a tough one to cut and paste. Two lines is usually the limit. Fixed.

atsansone · 2018-06-19T21:15:22Z

source/includes/steps-create-manually-windows-service-for-mongodb.yaml

+  log:
+
+  .. code-block:: bat
+
      [SC] CreateService SUCCESS
 ---


Agreed. Fixed.

atsansone · 2018-06-19T21:16:41Z

source/includes/steps-create-manually-windows-service-for-mongodb.yaml

 ---
-stepnum: 6
+stepnum: 5
 source:
  file: steps-run-mongodb-on-linux.yaml


Agreed. Fixed.

atsansone · 2018-06-19T21:21:12Z

source/includes/steps-install-mongodb-enterprise-on-windows-unattended.yaml

+
+  #. The Download Center should display the 
+     :guilabel:`Current Stable Release` and have the :icon:`windows` 
+     :guilabel:`Windows` tab selected. If that tab is not selected, 


Fixed. Created new steps page to cover.

atsansone · 2018-06-19T21:23:05Z

source/tutorial/install-mongodb-enterprise-on-windows.txt

@@ -10,90 +10,107 @@ Install MongoDB Enterprise on Windows
   :depth: 1
   :class: singlecol

+.. |mdb-edition| replace:: MongoDB Enterprise Edition
+.. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/download-center#enterprise>`__
+
 .. versionadded:: 2.6


Nah. Deleted.

atsansone · 2018-06-19T21:24:33Z

source/tutorial/install-mongodb-enterprise-on-windows.txt


-   wmic os get caption
-   wmic os get osarchitecture
+1. Press the :icon:`windows` key.


Added point about Start menu.

atsansone · 2018-06-19T21:30:15Z

source/tutorial/install-mongodb-enterprise-on-windows.txt


-.. include:: /includes/steps/run-mongodb-on-windows.rst
+         .. include:: /includes/steps/install-mongodb-enterprise-on-windows-unattended.rst



It's using the variable for the most recent release. That works against us when testing.

steveren

LGTM!

markbenvenuto

Still needs one minor fix

markbenvenuto · 2018-06-20T02:46:11Z

source/includes/release-base.yaml

+copyable: true
+language: bat
+code: |
+  msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^


still needs to be fixed

atsansone · 2018-06-20T06:20:57Z

@kay-kim : RFM for v3.6 and master. Once it is merged into master, I will make the v4.0 changes.

* DOCS-16154 Fixes typo in Server Parameters * Fixes build issue

atsansone added the Copy Review label Jun 19, 2018

atsansone assigned steveren Jun 19, 2018

atsansone requested a review from steveren June 19, 2018 16:55

steveren suggested changes Jun 19, 2018

View reviewed changes

markbenvenuto reviewed Jun 19, 2018

View reviewed changes

atsansone commented Jun 19, 2018

View reviewed changes

steveren approved these changes Jun 19, 2018

View reviewed changes

atsansone added Tech Review and removed Copy Review labels Jun 20, 2018

atsansone unassigned steveren Jun 20, 2018

Anthony Sansone added 2 commits June 19, 2018 21:10

(DOCSP-10468): Update Windows install.

15cad66

Updated per @steveren review.

795c15f

atsansone force-pushed the DOCS-10468 branch from 358897e to 0fa41b8 Compare June 20, 2018 02:10

markbenvenuto approved these changes Jun 20, 2018

View reviewed changes

Updated per @markbenvenuto review.

c700d30

atsansone force-pushed the DOCS-10468 branch from 0fa41b8 to c700d30 Compare June 20, 2018 06:18

atsansone assigned kay-kim Jun 20, 2018

atsansone added RFM and removed Tech Review labels Jun 20, 2018

kay-kim merged commit 73896d6 into mongodb:master Jun 20, 2018

mongo-cr-bot pushed a commit that referenced this pull request Jun 14, 2023

DOCS-16154 Fixes typo in Server Parameters (#3203) (#3346)

74cfd9f

* DOCS-16154 Fixes typo in Server Parameters * Fixes build issue


		.. code-block:: powershell

		PS C:\> systeminfo \| findstr /B /C:"OS Name" /C:"OS Version" /C:"System Type"


		.. code-block:: shell

		[initandlisten] waiting for connections


		.. include:: /includes/steps/run-mongodb-on-windows.rst
		.. include:: /includes/steps/install-mongodb-enterprise-on-windows-unattended.rst

(DOCS-10468): Revised Windows Install for MongoDB #3346

(DOCS-10468): Revised Windows Install for MongoDB #3346

Uh oh!

Conversation

atsansone commented Jun 19, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

markbenvenuto commented Jun 19, 2018

Uh oh!

atsansone left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

steveren left a comment

Choose a reason for hiding this comment

Uh oh!