Skip to content

fix all references to settings to point to new names #1742

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
32 changes: 12 additions & 20 deletions source/administration/configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@ For most standalone servers, this is a sufficient base
configuration. It makes several assumptions, but consider the
following explanation:

- :setting:`fork` is ``true``, which enables a
- :setting:`~processManagement.fork` is ``true``, which enables a
:term:`daemon` mode for :program:`mongod`, which detaches (i.e. "forks")
the MongoDB from the current session and allows you to run the
database as a conventional server.

- :setting:`bind_ip` is ``127.0.0.1``, which forces the
- :setting:`~net.bindIp` is ``127.0.0.1``, which forces the
server to only listen for requests on the localhost IP. Only bind to
secure interfaces that the application-level systems can access with
access control provided by system network filtering
Expand Down Expand Up @@ -99,7 +99,7 @@ following explanation:
this value, :program:`mongod` writes all output to standard output
(e.g. ``stdout``.)

- :setting:`logappend` is ``true``, which ensures that
- :setting:`~systemLog.logAppend` is ``true``, which ensures that
:program:`mongod` does not overwrite an existing log file
following the server start operation.

Expand All @@ -124,12 +124,11 @@ following:
.. code-block:: cfg

bind_ip = 127.0.0.1,10.8.0.10,192.168.4.24
nounixsocket = true
auth = true

Consider the following explanation for these configuration decisions:

- ":setting:`bind_ip`" has three values: ``127.0.0.1``, the localhost
- ":setting:`~net.bindIp`" has three values: ``127.0.0.1``, the localhost
interface; ``10.8.0.10``, a private IP address typically used for
local networks and VPN interfaces; and ``192.168.4.24``, a private
network interface typically used for local networks.
Expand All @@ -140,7 +139,7 @@ Consider the following explanation for these configuration decisions:
servers. At the same time it's important to limit these interfaces
to interfaces controlled and protected at the network layer.

- ":setting:`nounixsocket`" to ``true`` disables the
- ":setting:`~net.unixDomainSocket.enabled`" to ``false`` disables the
UNIX Socket, which is otherwise enabled by default. This limits
access on the local system. This is desirable when running MongoDB
on systems with shared access, but in most situations has minimal impact.
Expand Down Expand Up @@ -229,9 +228,9 @@ This creates a config server running on the private IP address
conflicts, and that your config server is accessible from all of your
:program:`mongos` and :program:`mongod` instances.

To set up shards, configure two or more :program:`mongod` instance
using your :ref:`base configuration <base-config>`, adding the
:setting:`shardsvr` setting:
To set up shards, configure two or more :program:`mongod` instance using
your :ref:`base configuration <base-config>`, with the ``shardsvr`` value
for the :setting:`~sharding.clusterRole` setting:

.. code-block:: cfg

Expand Down Expand Up @@ -278,7 +277,7 @@ instance, but consider the following configuration values:
The :setting:`~storage.dbPath` value controls the location of the
:program:`mongod` instance's data directory. Ensure that each database
has a distinct and well labeled data directory. The
:setting:`pidfilepath` controls where :program:`mongod` process
:setting:`~processManagement.pidFilePath` controls where :program:`mongod` process
places it's :term:`process id <pid>` file. As this tracks the specific
:program:`mongod` file, it is crucial that file be unique and well
labeled to make it easy to start and stop these processes.
Expand Down Expand Up @@ -306,7 +305,6 @@ values that tuned for general production purposes:
profile = 3
verbose = true
objcheck = true
cpu = true

Use the :ref:`base configuration <base-config>` and add these options
if you are experiencing some unknown issue or performance problem as
Expand All @@ -318,24 +316,18 @@ needed:
return useful results. See :doc:`/administration/optimization`
for more information on optimizing operations in MongoDB.

- :setting:`profile` sets the :term:`database profiler`
- :setting:`~operationProfiling.mode` sets the :term:`database profiler`
level. The profiler is not active by default because of the possible
impact on the profiler itself on performance. Unless this setting
has a value, queries are not profiled.

- :setting:`verbose` controls the amount of logging output that
- :setting:`~systemLog.verbosity` controls the amount of logging output that
:program:`mongod` write to the log. Only use this option if you are
experiencing an issue that is not reflected in the normal logging
level.

- :setting:`objcheck` forces :program:`mongod` to validate all
- :setting:`~net.wireObjectCheck` forces :program:`mongod` to validate all
requests from clients upon receipt. Use this option to ensure that
invalid requests are not causing errors, particularly when running a
database with untrusted clients. This option may affect database
performance.

- :setting:`cpu` forces :program:`mongod` to report the percentage of
the last interval spent in :term:`write lock`. The interval is
typically 4 seconds, and each output line in the log includes both
the actual interval since the last report and the percentage of
time spent in write lock.
4 changes: 2 additions & 2 deletions source/administration/monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -322,11 +322,11 @@ control these options.
- :setting:`~systemLog.verbosity`. Increases the amount of information written to
the log or output.

- :setting:`systemLog.path`. Enables logging to a file, rather than the standard
- :setting:`~systemLog.path`. Enables logging to a file, rather than the standard
output. You must specify the full path to the log file when adjusting
this setting.

- :setting:`logappend`. Adds information to a log
- :setting:`~systemLog.logAppend`. Adds information to a log
file instead of overwriting the file.

.. note::
Expand Down
10 changes: 6 additions & 4 deletions source/administration/security-checklist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ the interfaces on which MongoDB instances listen for incoming
connections. Allow only trusted clients to access the network
interfaces and ports on which MongoDB instances are available.

See the :setting:`bind_ip` setting, and see
See the :setting:`~net.bindIp` setting, and see
:doc:`/tutorial/configure-linux-iptables-firewall` and
:doc:`/tutorial/configure-windows-netsh-firewall`.

Expand Down Expand Up @@ -92,13 +92,15 @@ Run MongoDB with Secure Configuration Options
MongoDB supports the execution of JavaScript code for certain server-side
operations: :dbcommand:`mapReduce`, :dbcommand:`group`, :dbcommand:`eval`,
and :query:`$where`. If you do not use these operations, disable
server-side scripting by setting :setting:`noscripting` to ``true``.
server-side scripting by using the :option:`--noscripting <mongod
--noscripting>` option on the command line.

Use only the MongoDB wire protocol on production deployments. Do **not**
enable the following, all of which enable the web server interface:
:setting:`httpinterface`, :setting:`jsonp`, and :setting:`net.http.RESTInterfaceEnabled`. Leave
:setting:`~net.http.enabled`, :setting:`net.http.JSONPEnabled`, and
:setting:`net.http.RESTInterfaceEnabled`. Leave
these *disabled*, unless required for backwards compatibility.

Keep input validation enabled. MongoDB enables input validation by default
through the :setting:`objcheck` setting. This ensures that all
through the :setting:`~net.wireObjectCheck` setting. This ensures that all
documents stored by the :program:`mongod` instance are valid :term:`BSON`.
2 changes: 1 addition & 1 deletion source/core/journaling.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ write *many* bytes of data per second, the journal directory should
contain only two or three journal files.

You can use the
:setting:`smallfiles` run time option when starting :program:`mongod`
:setting:`storage.smallFiles` run time option when starting :program:`mongod`
to limit the size of each journal file to 128 megabytes, if you prefer.

To speed the frequent sequential writes that occur to the current
Expand Down
4 changes: 2 additions & 2 deletions source/core/kerberos.txt
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@ the ``EXAMPLE.COM`` Kerberos realm, then ``m1`` should have the service
principal name ``mongodb/[email protected]``.

To specify a different value for ``<service>``, use
:setting:`saslServiceName` during the start up of :program:`mongod` or
:setting:`~security.sasl.serviceName` during the start up of :program:`mongod` or
:program:`mongos` (or :program:`mongod.exe` or :program:`mongos.exe`).
:program:`mongo` shell or other clients may also specify a different
service principal name using :setting:`saslServiceName`.
service principal name using :setting:`~security.sasl.serviceName`.

Service principal names must be reachable over the network using the
fully qualified domain name (FQDN) part of its service principal name.
Expand Down
46 changes: 14 additions & 32 deletions source/core/master-slave.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Initial Deployment
~~~~~~~~~~~~~~~~~~

To configure a :term:`master`\-:term:`slave` deployment, start two
:program:`mongod` instances: one in :setting:`master` mode, and the
other in :setting:`slave` mode.
:program:`mongod` instances: one in master mode, and the
other in slave mode.

To start a :program:`mongod` instance in :setting:`master` mode,
To start a :program:`mongod` instance in master` mode,
invoke :program:`mongod` as follows:

.. code-block:: javascript
Expand All @@ -44,7 +44,7 @@ which the "operation log" that queues operations that the slaves will
apply to replicate operations from the master. The
:option:`--dbpath <mongod --dbpath>` is optional.

To start a :program:`mongod` instance in :setting:`slave` mode,
To start a :program:`mongod` instance in slave mode,
invoke :program:`mongod` as follows:

.. code-block:: javascript
Expand All @@ -55,15 +55,15 @@ Specify the hostname and port of the master instance to the
:option:`--source <mongod --source>` argument. The
:option:`--dbpath <mongod --dbpath>` is optional.

For :setting:`slave` instances, MongoDB stores data about the source
For slave instances, MongoDB stores data about the source
server in the :data:`local.sources` collection.

Configuration Options for Master-Slave Deployments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

As an alternative to specifying the :option:`--source <mongod --source>`
run-time option, can add a document to :data:`local.sources`
specifying the :setting:`master` instance, as in the following
specifying the master instance, as in the following
operation in the :program:`mongo` shell:

.. code-block:: javascript
Expand All @@ -83,7 +83,7 @@ follows:

.. describe:: host

The host field specifies the :setting:`master`\ :program:`mongod`
The host field specifies the master\ :program:`mongod`
instance, and holds a resolvable hostname, i.e. IP address, or
a name from a ``host`` file, or preferably a fully qualified domain
name.
Expand Down Expand Up @@ -120,7 +120,7 @@ master. With :option:`--autoresync <mongod --autoresync>` specified,
the slave will only attempt to re-sync once in a ten minute period.

To prevent these situations you should specify a larger oplog when
you start the :setting:`master` instance, by adding the
you start the ``master`` instance, by adding the
:option:`--oplogSize <mongod --oplogSize>` option when starting
:program:`mongod`. If you do not specify
:option:`--oplogSize <mongod --oplogSize>`, :program:`mongod` will
Expand All @@ -130,28 +130,10 @@ minimum of 1GB for 64bit machines and 50MB for 32bit machines.
Run time Master-Slave Configuration
-----------------------------------

MongoDB provides a number of run time configuration options for
:program:`mongod` instances in :term:`master`\-:term:`slave`
deployments. You can specify these options in :doc:`configuration
files </administration/configuration>` or on the command-line. See
documentation of the following:

- For *master* nodes:

- :setting:`master`

- :setting:`slave`

- For *slave* nodes:

- :setting:`source`

- :setting:`only`

- :setting:`slaveDelay`

Also consider the :ref:`Master-Slave Replication Command Line Options
<cli-mongod-master-slave>` for related options.
MongoDB provides a number of command line options for :program:`mongod`
instances in :term:`master`\-:term:`slave` deployments. See the
:ref:`Master-Slave Replication Command Line Options
<cli-mongod-master-slave>` for options.

Diagnostics
~~~~~~~~~~~
Expand Down Expand Up @@ -406,7 +388,7 @@ new :term:`slave` and then start the slave with :option:`--fastsync
data on both instances is **not** identical, a discrepancy will exist
forever.

:setting:`fastsync` is a way to start a slave by starting with an
:option:`fastsync <mongod --fastsync>` is a way to start a slave by starting with an
existing master disk image/backup. This option declares that the
administrator guarantees the image is correct and completely up-to-date
with that of the master. If you have a full and complete copy of data
Expand Down Expand Up @@ -463,7 +445,7 @@ slave's :data:`local.sources` collection.
.. example::

Consider the following: If you accidentally set an incorrect hostname
for the slave's :setting:`source`, as in the following example:
for the slave's :option:`source <mongod --slave>`, as in the following example:

.. code-block:: javascript

Expand Down
2 changes: 1 addition & 1 deletion source/core/read-preference-mechanics.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ will determine which member to target using the following process:
override in the drivers with their own
``secondaryAcceptableLatencyMS`` option. For :program:`mongos` you
can use the :option:`--localThreshold <mongos --localThreshold>` or
:setting:`localThreshold` runtime options to set this value.
:setting:`~replication.localPingThresholdMs` runtime options to set this value.

#. Selects a member from these hosts at random. The member receives
the read operation.
Expand Down
2 changes: 1 addition & 1 deletion source/core/replica-set-sync.txt
Original file line number Diff line number Diff line change
Expand Up @@ -122,5 +122,5 @@ lock while applying oplog entries. By default, secondaries will
pre-fetch all :ref:`indexes`.

Optionally, you can disable all pre-fetching or only pre-fetch
the index on the ``_id`` field. See the :setting:`replIndexPrefetch`
the index on the ``_id`` field. See the :setting:`~replication.secondaryIndexPrefetch`
setting for more information.
2 changes: 1 addition & 1 deletion source/core/security-interface.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ allows you to configure the primary :program:`mongod` port.
Without the :setting:`net.http.RESTInterfaceEnabled` setting, this interface is entirely
read-only, and limited in scope; nevertheless, this interface may
represent an exposure. To disable the HTTP interface, set the
:setting:`nohttpinterface` run time option or the
:setting:`~net.http.enabled` run time option or the
:option:`--nohttpinterface <mongod --nohttpinterface>` command line
option. See also :ref:`security-port-numbers`.

Expand Down
10 changes: 5 additions & 5 deletions source/core/security-network.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Configuration Options

You can limit the network exposure with the following :program:`mongod`
and :program:`mongos` configuration options:
:setting:`nohttpinterface`, :setting:`net.http.RESTInterfaceEnabled`, :setting:`bind_ip`, and
:setting:`~net.http.enabled`, :setting:`net.http.RESTInterfaceEnabled`, :setting:`~net.bindIp`, and
:setting:`~net.port`. You can use a :doc:`configuration file
</reference/configuration-options>` to specify these settings.

Expand All @@ -29,7 +29,7 @@ and :program:`mongos` configuration options:
including probably removing the nohttpinterface section. For now, just
added the blurb regarding the default behavior for 2.6

The :setting:`nohttpinterface` setting for :program:`mongod` and
The :setting:`~net.http.enabled` setting for :program:`mongod` and
:program:`mongos` instances disables the "home" status page.

.. versionchanged:: 2.6
Expand All @@ -53,7 +53,7 @@ interactive administrative :term:`REST` interface, which is *disabled*
by default. The :setting:`net.http.RESTInterfaceEnabled` configuration makes the http status
interface [#http-interface]_, which is read-only by default, fully
interactive. Use the :setting:`net.http.RESTInterfaceEnabled` setting with the
:setting:`httpinterface` setting.
:setting:`~net.http.enabled` setting.

The REST interface does not support any authentication and you should
always restrict access to this interface to only allow trusted clients
Expand All @@ -72,10 +72,10 @@ You may also enable this interface on the command line as
``bind_ip``
~~~~~~~~~~~

The :setting:`bind_ip` setting for :program:`mongod` and
The :setting:`~net.bindIp` setting for :program:`mongod` and
:program:`mongos` instances limits the network interfaces on which
MongoDB programs will listen for incoming connections. You can also
specify a number of interfaces by passing :setting:`bind_ip` a comma
specify a number of interfaces by passing :setting:`~net.bindIp` a comma
separated list of IP addresses. You can use the :option:`mongod
--bind_ip` and :option:`mongos --bind_ip` option on the command line at
run time to limit the network accessibility of a MongoDB program.
Expand Down
2 changes: 1 addition & 1 deletion source/faq/developers.txt
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Why are MongoDB's data files so large?
--------------------------------------

MongoDB aggressively preallocates data files to reserve space and
avoid file system fragmentation. You can use the :setting:`smallfiles`
avoid file system fragmentation. You can use the :setting:`storage.smallFiles`
setting to modify the file preallocation strategy.

.. seealso:: :ref:`faq-disk-size`
Expand Down
6 changes: 3 additions & 3 deletions source/faq/storage.txt
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ inserted into the database. Consider the following possible causes:
the background prevents significant delays when a new database file
is next allocated.

You can disable preallocation with the :setting:`noprealloc` run time
option. However :setting:`noprealloc` is **not** intended for use in
production environments: only use :setting:`noprealloc` for testing
You can disable preallocation with the :setting:`~storage.preallocDataFiles` run time
option. However :setting:`~storage.preallocDataFiles` is **not** intended for use in
production environments: only use :setting:`~storage.preallocDataFiles` for testing
and with small data sets where you frequently drop databases.

On Linux systems you can use ``hdparm`` to get an idea of how costly
Expand Down
2 changes: 1 addition & 1 deletion source/includes/options-conf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -834,7 +834,7 @@ description: |

* - ``configsvr``

- Start this instance as a term:`config server`. The instance
- Start this instance as a :term:`config server`. The instance
starts on port ``27019`` by default.

* - ``shardsvr``
Expand Down
Loading