From 5d93dc08c91ce45dafdc0638329cfbddd93b6ac3 Mon Sep 17 00:00:00 2001 From: Gianfranco Palumbo Date: Thu, 13 Jun 2013 19:13:01 +0200 Subject: [PATCH] Fix grammar and typos in 2.5/2.6 release notes --- source/release-notes/2.6.txt | 392 +++++++++++++++++------------------ 1 file changed, 196 insertions(+), 196 deletions(-) diff --git a/source/release-notes/2.6.txt b/source/release-notes/2.6.txt index 2a13382be21..3c7aabe5016 100644 --- a/source/release-notes/2.6.txt +++ b/source/release-notes/2.6.txt @@ -1,196 +1,196 @@ -:orphan: - -======================================================== -Release Notes for MongoDB 2.6 (Development Series 2.5.x) -======================================================== - -.. default-domain:: mongodb - -MongoDB 2.6 is currently in development, as part of the 2.5 -development release series. While 2.5-series releases are currently -available, these versions of MongoDB, including the 2.6 release -candidate builds, are for **testing only and -not for production use**. - -This document will eventually contain the full release notes for -MongoDB 2.6; before its release this document covers the 2.5 -development series as a work-in-progress. - -.. contents:: See the :doc:`full index of this page <2.6-changes>` for - a complete list of changes included in 2.6 (Development - Series 2.5.x). - :backlinks: none - :local: - :depth: 2 - -Downloading ------------ - -You can download the 2.6 release candidate on the `downloads page`_ in the -:guilabel:`Development Release (Unstable)` section. There are no -distribution packages for development releases, but you can use the -binaries provided for testing purposes. See -:doc:`/tutorial/install-mongodb-on-linux`, -:doc:`/tutorial/install-mongodb-on-windows`, or -:doc:`/tutorial/install-mongodb-on-os-x` for the basic installation -process. - -.. _`downloads page`: http://www.mongodb.org/downloads - -Changes -------- - -SASL Library Change -~~~~~~~~~~~~~~~~~~~ - -MongoDB Enterprise uses Cyrus SASL instead of GNU SASL (``libgsasl``). -This change has the following SASL2 and Cyrus SASL library and GSSAPI -plugin dependencies: - -For Debian or Ubuntu, install the following: - -.. code-block:: sh - - sudo apt-get install cyrus-sasl2-dbg cyrus-sasl2-mit-dbg libsasl2-2 libsasl2-dev libsasl2-modules libsasl2-modules-gssapi-mit - - -For CentOS, Red Hat Enterprise Linux, and Amazon AMI, install the -following: - -.. code-block:: sh - - sudo yum install cyrus-sasl cyrus-sasl-lib cyrus-sasl-devel cyrus-sasl-gssapi - -For SUSE, install the following: - -.. code-block:: sh - - sudo zypper install cyrus-sasl cyrus-sasl-devel cyrus-sasl-gssapi - -LDAP Support for Authentication -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -MongoDB Enterprise provides support for proxy authentication of users. This -change allows administrators to configure a MongoDB cluster to authenticate -users via Linux PAM or by proxying authentication requests to a specified LDAP -service. - -.. warning:: - - Because this change uses ``SASL PLAIN`` mechanism to transmit the - user password to the MongoDB server, you should, in general, use - only on a trusted channel (VPN, SSL, trusted wired network). - -Configuration -````````````` - -LDAP support for user authentication requires proper configuration of -the ``saslauthd`` daemon process as well as introduces a new server -parameter, ``saslauthdPath``. ``saslauthdPath`` is the path to the Unix -Domain Socket of the ``saslauthd`` instance to use for proxy -authentication. - -``saslauthd`` Configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To use with ActiveDirectory, start ``saslauthd`` with the following -config file contents: - -.. code-block:: none - - ldap_servers: - ldap_use_sasl: yes - ldap_mech: DIGEST-MD5 - ldap_auth_method: fastbind - -MongoDB Server Configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Configure the MongoDB server with the ``saslauthdPath`` parameter using -either the command line option -:option:`--setParameter ` or the -:doc:`configuration file `: - -- If ``saslauthd`` has a socket path of ``///saslauthd``, - set the ``saslauthdPath`` parameter to - ``///saslauthd/mux``, as in the following command line - example: - - .. code-block:: sh - - mongod --setParameter saslauthdPath=///saslauthd/mux - - Or to set the configuration in the :doc:`configuration file - `, add the parameter: - - .. code-block:: sh - - setParameter=saslauthdPath=///saslauthd/mux - -- Otherwise, set the ``saslauthdPath`` to the empty string to use the - library's default value, as in the following command line example: - - .. code-block:: sh - - mongod --setParameter saslauthdPath="" - - Or to set the configuration in the :doc:`configuration file - `, add the parameter: - - .. code-block:: sh - - setParameter=saslauthdPath="" - -Authenticate in the ``mongo`` Shell -``````````````````````````````````` - -To use this authentication mechanism in the :program:`mongo` shell, you -**must** pass ``digestPassword: false`` to :method:`db.auth()` when -authenticating on the ``$external`` database, since the server must -receive an undigested password to forward on to ``saslauthd``, as in -the following example: - -.. code-block:: javascript - - use $external - db.auth( - { - mechanism: "PLAIN", - user: "application/reporting@EXAMPLE.NET", - pwd: "some1nterestingPwd", - digestPassword: false - } - ) - -Background Index Builds Replicate to Secondaries -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Starting in MongoDB 2.5.0, if you initiate a :ref:`background index -build ` on a :term:`primary`, the -secondaries will replicate the index build in the background. -In previous versions of MongoDB, secondaries built all indexes in the -foreground, even if the primary built an index in the background. - -For all index builds, secondaries will not begin building indexes -until the primary has successfully completed the index build. - -``mongod`` Automatically Continues in Progress Index Builds Following Restart -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If your :program:`mongod` instance was building an index when it -shutdown or terminated, :program:`mongod` will now continue building -the index when the :program:`mongod` restarts. Previously, the index -build *had* to finish building before :program:`mongod` shutdown. - -To disable this behavior the 2.5 series adds a new run time option, -:setting:`noIndexBuildRetry` (or via, ``--noIndexBuildRetry`` on the -command line,) for :program:`mongod`. :setting:`noIndexBuildRetry` -prevents :program:`mongod` from continuing rebuilding indexes that did -were not finished building when the :program:`mongod` last shut down. - -.. setting:: noIndexBuildRetry - - By default, :program:`mongod` will attempt to rebuild indexes upon - start-up *if* :program:`mongod` shuts down or stops in the middle - of an index build. When enabled, run time option prevents this - behavior. +:orphan: + +======================================================== +Release Notes for MongoDB 2.6 (Development Series 2.5.x) +======================================================== + +.. default-domain:: mongodb + +MongoDB 2.6 is currently in development, as part of the 2.5 +development release series. While 2.5-series releases are currently +available, these versions of MongoDB, including the 2.6 release +candidate builds, are for **testing only and +not for production use**. + +This document will eventually contain the full release notes for +MongoDB 2.6; before its release this document covers the 2.5 +development series as a work-in-progress. + +.. contents:: See the :doc:`full index of this page <2.6-changes>` for + a complete list of changes included in 2.6 (Development + Series 2.5.x). + :backlinks: none + :local: + :depth: 2 + +Downloading +----------- + +You can download the 2.6 release candidate on the `downloads page`_ in the +:guilabel:`Development Release (Unstable)` section. There are no +distribution packages for development releases, but you can use the +binaries provided for testing purposes. See +:doc:`/tutorial/install-mongodb-on-linux`, +:doc:`/tutorial/install-mongodb-on-windows`, or +:doc:`/tutorial/install-mongodb-on-os-x` for the basic installation +process. + +.. _`downloads page`: http://www.mongodb.org/downloads + +Changes +------- + +SASL Library Change +~~~~~~~~~~~~~~~~~~~ + +MongoDB Enterprise uses Cyrus SASL instead of GNU SASL (``libgsasl``). +This change has the following SASL2 and Cyrus SASL library and GSSAPI +plugin dependencies: + +For Debian or Ubuntu, install the following: + +.. code-block:: sh + + sudo apt-get install cyrus-sasl2-dbg cyrus-sasl2-mit-dbg libsasl2-2 libsasl2-dev libsasl2-modules libsasl2-modules-gssapi-mit + + +For CentOS, Red Hat Enterprise Linux, and Amazon AMI, install the +following: + +.. code-block:: sh + + sudo yum install cyrus-sasl cyrus-sasl-lib cyrus-sasl-devel cyrus-sasl-gssapi + +For SUSE, install the following: + +.. code-block:: sh + + sudo zypper install cyrus-sasl cyrus-sasl-devel cyrus-sasl-gssapi + +LDAP Support for Authentication +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +MongoDB Enterprise provides support for proxy authentication of users. This +change allows administrators to configure a MongoDB cluster to authenticate +users via Linux PAM or by proxying authentication requests to a specified LDAP +service. + +.. warning:: + + Because this change uses ``SASL PLAIN`` mechanism to transmit the + user password to the MongoDB server, you should, in general, use + only on a trusted channel (VPN, SSL, trusted wired network). + +Configuration +````````````` + +LDAP support for user authentication requires proper configuration of +the ``saslauthd`` daemon process as well as introduces a new server +parameter, ``saslauthdPath``. ``saslauthdPath`` is the path to the Unix +Domain Socket of the ``saslauthd`` instance to use for proxy +authentication. + +``saslauthd`` Configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To use with ActiveDirectory, start ``saslauthd`` with the following +config file contents: + +.. code-block:: none + + ldap_servers: + ldap_use_sasl: yes + ldap_mech: DIGEST-MD5 + ldap_auth_method: fastbind + +MongoDB Server Configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Configure the MongoDB server with the ``saslauthdPath`` parameter using +either the command line option +:option:`--setParameter ` or the +:doc:`configuration file `: + +- If ``saslauthd`` has a socket path of ``///saslauthd``, + set the ``saslauthdPath`` parameter to + ``///saslauthd/mux``, as in the following command line + example: + + .. code-block:: sh + + mongod --setParameter saslauthdPath=///saslauthd/mux + + Or to set the configuration in the :doc:`configuration file + `, add the parameter: + + .. code-block:: sh + + setParameter=saslauthdPath=///saslauthd/mux + +- Otherwise, set the ``saslauthdPath`` to the empty string to use the + library's default value, as in the following command line example: + + .. code-block:: sh + + mongod --setParameter saslauthdPath="" + + Or to set the configuration in the :doc:`configuration file + `, add the parameter: + + .. code-block:: sh + + setParameter=saslauthdPath="" + +Authenticate in the ``mongo`` Shell +``````````````````````````````````` + +To use this authentication mechanism in the :program:`mongo` shell, you +**must** pass ``digestPassword: false`` to :method:`db.auth()` when +authenticating on the ``$external`` database, since the server must +receive an undigested password to forward on to ``saslauthd``, as in +the following example: + +.. code-block:: javascript + + use $external + db.auth( + { + mechanism: "PLAIN", + user: "application/reporting@EXAMPLE.NET", + pwd: "some1nterestingPwd", + digestPassword: false + } + ) + +Background Index Builds Replicate to Secondaries +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Starting in MongoDB 2.5.0, if you initiate a :ref:`background index +build ` on a :term:`primary`, the +secondaries will replicate the index build in the background. +In previous versions of MongoDB, secondaries built all indexes in the +foreground, even if the primary built an index in the background. + +For all index builds, secondaries will not begin building indexes +until the primary has successfully completed the index build. + +``mongod`` Automatically Continues in Progress Index Builds Following Restart +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If your :program:`mongod` instance was building an index when it +shutdown or terminated, :program:`mongod` will now continue building +the index when the :program:`mongod` restarts. Previously, the index +build *had* to finish building before :program:`mongod` shutdown. + +To disable this behavior the 2.5 series adds a new run time option, +:setting:`noIndexBuildRetry` (or via, ``--noIndexBuildRetry`` on the +command line,) for :program:`mongod`. :setting:`noIndexBuildRetry` +prevents :program:`mongod` from continuing rebuilding indexes that did +not finished building when the :program:`mongod` last shut down. + +.. setting:: noIndexBuildRetry + + By default, :program:`mongod` will attempt to rebuild indexes upon + start-up *if* :program:`mongod` shuts down or stops in the middle + of an index build. When enabled, this option prevents this + behavior.