Skip to content

DOCS-1930: Document Windows Enterprise #1389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions source/core/access-control.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,16 @@ details, see :doc:`/tutorial/enable-authentication`.
.. versionadded 2.0: Before 2.0, sharded clusters *had* to run with
trusted applications and a trusted networking configuration.

For MongoDB Enterprise installations, authentication using a Kerberos
service is available. See
For MongoDB Enterprise installations, authentication
using a Kerberos service is available. For Linux, see
:doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication`.

.. versionadded:: 2.5.3
MongoDB Enterprise now supports Windows systems, which includes
support for Kerberos.

.. see-also:: :doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication-under-windows`.

.. important::
You can authenticate as only one user for a given database. If you
authenticate to a database as one user and later authenticate on the
Expand Down Expand Up @@ -118,3 +124,4 @@ MongoDB stores each user's role assignments in the ``admin`` database's
manage data in this collection, MongoDB provides :ref:`user management
commands <user-management-commands>`, which require proper
authorization to use in order to prevent privilege escalation attacks.

9 changes: 8 additions & 1 deletion source/core/security-introduction.txt
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,16 @@ In addition, consider the strategies listed in
:doc:`/core/security-interface` to reduce interface-related risks for
the :program:`mongo` shell, HTTP status interface and the REST API.

MongoDB Enterprise supports authentication using Kerberos. See
MongoDB Enterprise supports authentication
using Kerberos. For Linux systems, see
:doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication`.

.. versionadded:: 2.5.3
MongoDB Enterprise now supports Windows systems, which includes
support for Kerberos.

.. see-also:: :doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication-under-windows`.

Vulnerability Notification
--------------------------

Expand Down
7 changes: 6 additions & 1 deletion source/includes/toc-security-core-landing.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,9 @@ file: /core/auditing
description: |
Audit server and client activity for :program:`mongod` and
:program:`mongos` instances.
...
---
file: /core/kerberos
description: |
Discusses integrating MongoDB with a Kerberos-based authentication
system.
...
8 changes: 7 additions & 1 deletion source/includes/toc-security-tutorials-access-control.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,13 @@ description: |
---
file: /tutorial/control-access-to-mongodb-with-kerberos-authentication
description: |
Describes the process, for MongoDB Enterprise, used to enable and
For MongoDB Enterprise Linux, describes the process used to enable and
implement a Kerberos-based authentication system for MongoDB
deployments.
---
file: /tutorial/control-access-to-mongodb-with-kerberos-authentication-under-windows
description: |
For MongoDB Windows Enterprise, describes the process used to enable and
implement a Kerberos-based authentication system for MongoDB
deployments.
---
Expand Down
2 changes: 2 additions & 0 deletions source/includes/toc-spec-security-landing.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ files:
level: 2
- file: /core/auditing
level: 2
- file: /core/kerberos
level: 2
- file: /administration/security
level: 1
- file: /tutorial/create-a-vulnerability-report
Expand Down
13 changes: 4 additions & 9 deletions source/reference/glossary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,10 @@ Glossary
data. MongoDB uses md5 to identify chunks of data for
:term:`GridFS`. See :doc:`/reference/command/filemd5`.

MIB
Management Information Base. MongoDB uses MIB files to define the type of
data tracked by SNMP in the MongoDB Enterprise edition.

MIME
Multipurpose Internet Mail Extensions. A standard set of type and
encoding definitions used to declare the encoding and type of data
Expand Down Expand Up @@ -771,15 +775,6 @@ Glossary
state electronics for persistence, as opposed to the rotating platters
and movable read/write heads used by traditional mechanical hard drives.

stale
Refers to the amount of time a :term:`secondary` member of a
:term:`replica set` trails behind the current state of the
:term:`primary's <primary>`\ :term:`oplog`. If a secondary
becomes too stale, it can no longer use replication to catch up
to the current state of the primary. See
:doc:`/core/replica-set-oplog` and :doc:`/core/replica-set-sync`
for more information.

standalone
An instance of :program:`mongod` that is running as a single
server and not as part of a :term:`replica set`. To convert a
Expand Down
10 changes: 8 additions & 2 deletions source/reference/parameters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,16 @@ Parameters

.. note::

:parameter:`saslHostName` supports Kerberos authentication and
is only included in MongoDB Enterprise. See
:parameter:`saslHostName` supports Kerberos authentication and is
only included in MongoDB Enterprise. For Linux systems, see
:doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication`
for more information.

.. versionadded:: 2.5.3
MongoDB Enterprise now supports Windows systems,
which includes support for Kerberos. See also
:doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication-under-windows`.

.. parameter:: supportCompatibilityFormPrivilegeDocuments

.. versionadded:: 2.4
Expand Down Expand Up @@ -354,3 +359,4 @@ Parameters
.. code-block:: sh

db.getSiblingDB('admin').runCommand( { setParameter: 1, clusterAuthMode: "sendX509" } )

8 changes: 7 additions & 1 deletion source/tutorial/install-mongodb-enterprise.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,15 @@ Install MongoDB Enterprise

`MongoDB Enterprise
<http://www.mongodb.com/products/mongodb-enterprise>`_ is available on
four platforms and contains support for several features related to
select platforms and contains support for several features related to
security and monitoring.

.. versionadded:: 2.5.3
MongoDB Enterprise now supports Windows systems, which includes
support for Kerberos.

.. see-also:: :doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication-under-windows`.

.. _required-packages:

Required Packages
Expand Down
16 changes: 13 additions & 3 deletions source/tutorial/install-mongodb-on-windows.txt
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,16 @@ Create this folder using the :guilabel:`Command Prompt`. Go to the
md data
md data\db

You can specify an alternate path for data files using the
:option:`--dbpath <mongod --dbpath>` option to :program:`mongod.exe`.
You can specify an alternate path for data files
using the :option:`--dbpath <mongod --dbpath>` option to
:program:`mongod.exe`. If your path includes spaces, enclose the
entire path in double quotes, for example:

.. code-block:: powershell

C:\mongodb\bin\mongod.exe --dbpath "d:\test\mongo db data"

.. start-include-for-enterprise-tutorial

Start MongoDB
~~~~~~~~~~~~~
Expand Down Expand Up @@ -139,7 +147,7 @@ following example:
C:\mongodb\bin\mongod.exe --dbpath d:\test\mongodb\data

If your path includes spaces, enclose the entire path in double
quotations, for example:
quotes, for example:

.. code-block:: powershell

Expand Down Expand Up @@ -177,6 +185,8 @@ insert a record in the ``test`` :term:`collection` of the default
of :ecosystem:`C# and MongoDB </drivers/csharp>` for more
information.

.. end-include-for-enterprise-tutorial

.. _tutorial-mongod-as-windows-service:

MongoDB as a Windows Service
Expand Down
60 changes: 60 additions & 0 deletions source/tutorial/install-mongodb-windows-enterprise.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
==================================
Install MongoDB Windows Enterprise
==================================

.. versionadded:: 2.5.3

.. default-domain:: mongodb

`MongoDB Enterprise
<http://www.mongodb.com/products/mongodb-enterprise>`_ is available on
select platforms and contains support for several features related to
security and monitoring.

To install MongoDB Enterprise on other platforms, see
:doc:`tutorial/install-mongodb-enterprise`.

.. _required-packages:

Required Packages
-----------------

MongoDB Windows Enterprise requires Windows Server 2008 R2 or later.

All other dependencies are included in the installation package.

Install MongoDB Enterprise Binaries
-----------------------------------

When you have `downloaded the Enterprise MSI package file
<http://www.mongodb.com/products/mongodb-enterprise>`_, run the
MSI file to start the standard Windows installation wizard.

Follow the prompts to install the components you need. Available components
include:

- *Core*: needed for all MongoDB deployments.

- *Mongos*: needed for all sharded deployments.

- *Support tools*: needed for maintaining and debugging MongoDB deployments.

- *C++ driver*: needed for writing your own C++ programs that interface with
MongoDB.

Running and Using MongoDB
-------------------------

.. include:: /tutorial/install-mongodb-on-windows.txt
:start-after: start-include-for-enterprise-tutorial
:end-before: end-include-for-enterprise-tutorial

Further Reading
---------------

As you begin to use MongoDB, consider the
:doc:`/tutorial/getting-started` and :doc:`/tutorial` resources. To
read about features only available in MongoDB Enterprise,
consider: :doc:`/tutorial/monitor-with-snmp-under-windows` and
:doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication-under-windows`.