Merge branch 'master' of git://github.com/mongodb/docs into DOCS-396-minimum-glibc

Author: Ed Costello

draft/administration/production-notes.txt

@@ -426,6 +426,8 @@ the local database instance (e.g. ``127.0.0.1`` or ``localhost``) and
 create a database backup in a in the current directory named
 ``dump/``.
 
+.. include:: /includes/note-mongodump-compatibility-2.2.rst
+
 You can specify  database and collection as options to the
 :program:`mongodump` command to limit the amount of data included in the
 database dump. For example:

source/administration/backups.txt

@@ -65,6 +65,17 @@ resulting index.
    only creates an index if an index of the same specification does
    not already exist.
 
+Special Creation Options
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. note::
+
+   TTL collections use a special ``expire`` index option. See
+   :doc:`/tutorial/expire-data` for more information.
+
+.. TODO: insert link here to the geospatial index documents when
+   they're published.
+
 Sparse Indexes
 ``````````````
 
@@ -135,6 +146,46 @@ You can also enforce a unique constraint on :ref:`compound indexes
 These indexes enforce uniqueness for the *combination* of index keys
 and *not* for either key individually.
 
+Background
+``````````
+
+To create an index in the background you can specify :ref:`background
+construction <index-creation-background>`. Consider the following
+prototype invocation of :method:`db.collection.ensureIndex()`:
+
+.. code-block:: javascript
+
+   db.collection.ensureIndex( { a: 1 }, { background: true } )
+
+Consider the section on :ref:`background index construction
+<index-creation-background>` for more information about these indexes
+and their implications.
+
+Drop Duplicates
+```````````````
+
+To force the creation of a :ref:`unique index <index-type-unique>`
+index on a collection with duplicate values in the field you are
+indexing you can use the ``dropDups`` option. This will force MongoDB
+to create a *unique* index by deleting documents with duplicate values
+when building the index. Consider the following prototype invocation
+of :method:`db.collection.ensureIndex()`:
+
+.. code-block:: javascript
+
+   db.collection.ensureIndex( { a: 1 }, { dropDups: true } )
+
+See the full documentation of :ref:`duplicate dropping
+<index-creation-duplicate-dropping>` for more information.
+
+.. warning::
+
+   Specifying ``{ dropDups: true }`` may delete data from your
+   database. Use with extreme caution.
+      
+Refer to the :method:`ensureIndex() <db.collection.ensureIndex()>`
+documentation for additional index creation options.
+
 Removal
 ~~~~~~~
 
@@ -159,7 +210,7 @@ Where the value of ``nIndexesWas`` reflects the number of indexes
 for the :ref:`_id index <index-type-primary>` from a collection.
 
 These shell helpers provide wrappers around the
-:dbcommand:`deleteIndexes` :term:`database command`. Your :doc:`client
+:dbcommand:`dropIndexes` :term:`database command`. Your :doc:`client
 library </applications/drivers>` may have a different or additional
 interface for these operations.
 
@@ -203,54 +254,6 @@ may have a different or additional interface for this operation.
 
 .. include:: /includes/note-build-indexes-on-replica-sets.rst
 
-Special Creation Options
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. note::
-
-   TTL collections use a special ``expire`` index option. See
-   :doc:`/tutorial/expire-data` for more information.
-
-.. TODO: insert link here to the geospatial index documents when
-   they're published.
-
-Background
-``````````
-
-To create an index in the background you can specify :ref:`background
-construction <index-creation-background>`. Consider the following
-prototype invocation of :method:`db.collection.ensureIndex()`:
-
-.. code-block:: javascript
-
-   db.collection.ensureIndex( { a: 1 }, { background: true } )
-
-Consider the section on :ref:`background index construction
-<index-creation-background>` for more information about these indexes
-and their implications.
-
-Drop Duplicates
-```````````````
-
-To force the creation of a :ref:`unique index <index-type-unique>`
-index on a collection with duplicate values in the field you are
-indexing you can use the ``dropDups`` option. This will force MongoDB
-to create a *unique* index by deleting documents with duplicate values
-when building the index. Consider the following prototype invocation
-of :method:`db.collection.ensureIndex()`:
-
-.. code-block:: javascript
-
-   db.collection.ensureIndex( { a: 1 }, { dropDups: true } )
-
-See the full documentation of :ref:`duplicate dropping
-<index-creation-duplicate-dropping>` for more information.
-
-.. warning::
-
-   Specifying ``{ dropDups: true }`` may delete data from your
-   database. Use with extreme caution.
-
 .. _index-building-replica-sets:
 
 Building Indexes on Replica Sets

source/administration/indexes.txt

@@ -21,10 +21,13 @@ suggestions for administers of replica sets.
    The following tutorials provide task-oriented instructions for
    specific administrative tasks related to replica set operation.
 
-   - :doc:`/tutorial/deploy-replica-set`
-   - :doc:`/tutorial/expand-replica-set`
+   - :doc:`/tutorial/change-hostnames-in-a-replica-set`
+   - :doc:`/tutorial/change-oplog-size`
    - :doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster`
+   - :doc:`/tutorial/convert-secondary-into-arbiter`
    - :doc:`/tutorial/deploy-geographically-distributed-replica-set`
+   - :doc:`/tutorial/deploy-replica-set`
+   - :doc:`/tutorial/expand-replica-set`
 
 .. _replica-set-node-configurations:
 .. _replica-set-member-configurations:
@@ -57,8 +60,8 @@ configurations.
 .. _replica-set-secondary-only-members:
 .. _replica-set-secondary-only-configuration:
 
-Secondary-Only
-~~~~~~~~~~~~~~
+Secondary-Only Members
+~~~~~~~~~~~~~~~~~~~~~~
 
 The secondary-only configuration prevents a :term:`secondary` member in a
 :term:`replica set` from ever becoming a :term:`primary` in a
@@ -119,8 +122,8 @@ This sets the following:
 .. _replica-set-hidden-members:
 .. _replica-set-hidden-configuration:
 
-Hidden
-~~~~~~
+Hidden Members
+~~~~~~~~~~~~~~
 
 Hidden members are part of a replica set but cannot become
 primary and are invisible to client applications. *However,*
@@ -164,8 +167,8 @@ other members in the set will not advertise the hidden member in the
 .. _replica-set-delayed-members:
 .. _replica-set-delayed-configuration:
 
-Delayed
-~~~~~~~
+Delayed Members
+~~~~~~~~~~~~~~~
 
 Delayed members copy and apply operations from the primary's :term:`oplog` with
 a specified delay. If a member has a delay of one hour, then
@@ -220,12 +223,10 @@ queries in normal operations.
    <members[n].slaveDelay>` window, the delayed member cannot
    successfully replicate operations.
 
-.. see:: For more information about delayed members, see the
-   section on :ref:`Delayed Replication <replica-set-delayed-members>`.
-   Additionally consider the following resources:
-  :data:`members[n].slaveDelay`, :ref:`Replica Set Reconfiguration
-  <replica-set-reconfiguration-usage>`, :ref:`Oplog Sizing
-  <replica-set-oplog-sizing>`, and :doc:`/tutorial/change-oplog-size`.
+.. seealso:: :data:`members[n].slaveDelay`, :ref:`Replica Set Reconfiguration
+   <replica-set-reconfiguration-usage>`, :ref:`replica-set-oplog-sizing`,
+   :ref:`replica-set-procedure-change-oplog-size` in this document,
+   and the :doc:`/tutorial/change-oplog-size` tutorial.
 
 .. index:: replica set members; arbiters
 .. _replica-set-arbiters:
@@ -289,8 +290,8 @@ hostname and the port.
 .. _replica-set-non-voting-members:
 .. _replica-set-non-voting-configuration:
 
-Non-Voting
-~~~~~~~~~~
+Non-Voting Members
+~~~~~~~~~~~~~~~~~~
 
 You may choose to change the number of votes that each member has in
 :ref:`elections <replica-set-elections>` for :term:`primary`. In general, all
@@ -492,30 +493,11 @@ of the member with the highest :data:`members[n].priority` setting.
 Changing Oplog Size
 ~~~~~~~~~~~~~~~~~~~
 
-The :term:`oplog` exists internally as a :term:`capped collection`, so
-you cannot modify its size in the course of normal operations. In most
-cases the :ref:`default oplog size <replica-set-oplog-sizing>` is an
-acceptable size; however, in some situations you may need a larger or
-smaller oplog. To resize the oplog, follow these steps:
-
-#. Restart the current :term:`primary` instance in the :term:`replica set` in
-   "standalone" mode, running on a different port.
-
-#. Save the last entry from the old (current) oplog and create a
-   backup of the oplog.
-
-#. Drop the existing oplog and create a new oplog of a different size.
-
-#. Insert the previously saved last entry from the old oplog into the
-   new oplog.
-
-#. Restart the server as a member of the replica set on its usual
-   port.
+The following is an overview of the procedure for changing the size of the oplog:
 
-#. Apply this procedure to any other member of the replica set that
-   *could become* primary.
+.. include:: /includes/procedure-change-oplog-size.rst
 
-.. seealso:: The :doc:`/tutorial/change-oplog-size` tutorial.
+For a detailed procedure, see :doc:`/tutorial/change-oplog-size`.
 
 .. _replica-set-security:
 
@@ -657,10 +639,11 @@ Possible causes of replication lag include:
 
   For more information see:
 
-  - the :ref:`Replication Write Concern <replica-set-write-concern>` section,
-  - the :ref:`replica-set-oplog` documentation,
-  - the :ref:`Oplog Sizing <replica-set-oplog-sizing>` section, and
-  - the :doc:`/tutorial/change-oplog-size` tutorial.
+  - :ref:`replica-set-write-concern`.
+  - The :ref:`replica-set-oplog-sizing` topic in the :doc:`/core/replication` document.
+  - The :ref:`replica-set-oplog` topic in the :doc:`/core/replication-internals` document.
+  - The :ref:`replica-set-procedure-change-oplog-size` topic this document.
+  - The :doc:`/tutorial/change-oplog-size` tutorial.
 
 .. index:: pair: replica set; failover
 .. _replica-set-failover-administration:

source/administration/replica-sets.txt

@@ -60,7 +60,7 @@ and the ``.pem`` certificate, use the following command:
 
 .. code-block:: sh
 
-   cat mongodb-cert.crt mongodb-cert.pem > mongodb.pem
+   cat mongodb-cert.key mongodb-cert.pem > mongodb.pem
 
 Clients
 -------
@@ -89,7 +89,7 @@ stats.  Because the agent already utilizes SSL for its communications
 to the MMS servers, this is just a matter of enabling SSL support in
 MMS itself on a per host basis.
 
-Use the “Edit” host button (i.e. the pencil) on the Hosts page in the
+Use the "Edit" host button (i.e. the pencil) on the Hosts page in the
 MMS console and is currently enabled on a group by group basis by
 10gen.
 
@@ -164,18 +164,18 @@ Then connect to a standalone instance, using the following form:
 
 .. code-block:: javascript
 
-   require ‘rubygems’
-   require ‘mongo’
+   require 'rubygems'
+   require 'mongo'
 
-   connection = Mongo::Connection.new(‘localhost’, 27017, :ssl => true)
+   connection = Mongo::Connection.new('localhost', 27017, :ssl => true)
 
 Replace ``connection`` with the following if you're connecting to a
 replica set:
 
 .. code-block:: ruby
 
-   connection = Mongo::ReplSetConnection.new([‘localhost, 27017’],
-                                             [‘localhost’, 27018],
+   connection = Mongo::ReplSetConnection.new(['localhost:27017'],
+                                             ['localhost:27018'],
                                              :ssl => true)
 
 Here, :program:`mongod` instance run on "``localhost:27017``" and

source/administration/ssl.txt

@@ -120,14 +120,14 @@ using the following format:
 .. code-block:: javascript
 
    {
-    title : “this is my title” ,
-    author : “bob” ,
+    title : "this is my title" ,
+    author : "bob" ,
     posted : new Date () ,
     pageViews : 5 ,
-    tags : [ “fun” , “good” , “fun” ] ,
+    tags : [ "fun" , "good" , "fun" ] ,
     comments : [
-                { author :“joe” , text : “this is cool” } ,
-                { author :“sam” , text : “this is bad” }
+                { author :"joe" , text : "this is cool" } ,
+                { author :"sam" , text : "this is bad" }
     ],
     other : { foo : 5 }
    }
@@ -144,10 +144,10 @@ command:
         author : 1,
         tags : 1,
      } },
-     { $unwind : “$tags” },
+     { $unwind : "$tags" },
      { $group : {
         _id : { tags : "$tags" },
-        authors : { $addToSet : “$author” }
+        authors : { $addToSet : "$author" }
      } }
    );
 

source/applications/aggregation.txt

@@ -18,7 +18,7 @@ troubleshooting and for further understanding MongoDB's behavior and approach.
 Oplog
 -----
 
-For an explanation of the oplog, see the :ref:`oplog <replica-set-oplog-sizing>`
+For an explanation of the oplog, see the :ref:`replica-set-oplog-sizing`
 topic in the :doc:`/core/replication` document.
 
 Under various exceptional

source/core/replication-internals.txt

@@ -279,7 +279,7 @@ on the :term:`primary` and then records the operations on the primary's
 oplog. The :term:`secondary` members then replicate this log and apply
 the operations to themselves in an asynchronous process. All replica set
 members contain a copy of the oplog, allowing them to maintain the
-current state of the database.
+current state of the database. Operations in the oplog are :term:`idempotent`.
 
 By default, the size of the oplog is as follows:
 
@@ -296,17 +296,16 @@ By default, the size of the oplog is as follows:
   the oplog.
 
 Before oplog creation, you can specify the size of your oplog with the
-:setting:`oplogSize` option. Once the oplog is created, you can only
-change the size of the oplog by using the :ref:`oplog resizing procedure
-<replica-set-procedure-change-oplog-size>`.
-
-.. QUESTION: SK, Can the next graph be rewritten? It's unclear to me. BG
-
-For example, if an oplog fits 24 hours of operations, then members can
-stop copying entries from the oplog for 24 hours before they require
-full resyncing *and* the disk will be full in 19 days. If this were
-the case, you would have a very high-volume member. In many
-circumstances, the default oplog can hold days of operations.
+:setting:`oplogSize` option. After you start a replica set member for
+the first time, you can only change the size of the oplog by using the
+:doc:`/tutorial/change-oplog-size` tutorial.
+
+In most cases, the default oplog size is sufficient. For example, if an
+oplog that is 5% of free disk space fills up in 24 hours of operations, then
+secondaries can stop copying entries from the oplog for 24 hours before
+they require full resyncing. However, most replica sets have much
+lower operation volumes, and their oplogs can hold a much larger
+number of operations.
 
 The following factors affect how MongoDB uses space in the oplog:
 

source/core/replication.txt

@@ -0,0 +1,5 @@
+.. note::
+
+   If you use the :program:`mongodump` tool from the 2.2 distribution to
+   create a dump of a database, you can restore that dump only to a 2.2
+   database.