Skip to content

s/control script/init script/ #2381

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
17 changes: 8 additions & 9 deletions source/administration/configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,12 @@ best-practice configurations for common use cases.

While both interfaces provide access to the same collection of options
and settings, this document primarily uses the configuration file
interface. If you run MongoDB using a control script or installed from
a package for your operating system, you likely already have a
interface. If you run MongoDB using a :term:`init script` or if you installed
from a package for your operating system, you likely already have a
configuration file located at ``/etc/mongod.conf``. Confirm this by
checking the contents of the ``/etc/init.d/mongod`` or
``/etc/rc.d/mongod`` script to ensure that the :term:`control scripts
<control script>` start the :program:`mongod` with the appropriate
configuration file (see below.)
``/etc/rc.d/mongod`` script to ensure that the init scripts start the
:program:`mongod` with the appropriate configuration file.

To start a MongoDB instance using this configuration file, issue a
command in the following form:
Expand Down Expand Up @@ -233,7 +232,7 @@ instances that connect to the set. The keyfile must be less than one
kilobyte in size and may only contain characters in the base64 set and
the file must not have group or "world" permissions on UNIX systems.

.. seealso::
.. seealso::
The :ref:`Replica Set Security <replica-set-security>` section for
information on configuring authentication with replica sets.

Expand Down Expand Up @@ -320,7 +319,7 @@ Or, if using the :v2.4:`older configuration file format
.. important:: Always use 3 config servers in production environments.

You can specify multiple :setting:`~sharding.configDB` instances by specifying
hostnames and ports in the form of a comma separated list.
hostnames and ports in the form of a comma separated list.

In general,
avoid modifying the :setting:`~sharding.chunkSize` from the default value of 64,
Expand Down Expand Up @@ -371,8 +370,8 @@ 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.

Create additional :term:`control scripts <control script>` and/or
adjust your existing MongoDB configuration and control script as
Create additional :term:`init scripts <init script>` and/or
adjust your existing MongoDB configuration and init script as
needed to control these processes.

.. [#multimongod] Single-tenant systems with :term:`SSD` or other high
Expand Down
14 changes: 7 additions & 7 deletions source/includes/list-mongodb-enterprise-packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ repository. This repository contains the following packages:
:program:`mongoperf`, :program:`mongorestore`, :program:`mongostat`,
and :program:`mongotop`.

Control Scripts
---------------
Init Scripts
------------

The ``mongodb-enterprise`` package includes various :term:`control scripts
<control script>`, including the init script ``/etc/rc.d/init.d/mongod``.
The ``mongodb-enterprise`` package includes various :term:`init scripts
<init script>`, including the init script ``/etc/rc.d/init.d/mongod``.

The package configures MongoDB using the ``/etc/mongod.conf`` file in
conjunction with the control scripts. See
conjunction with the init scripts. See
the :doc:`Configuration File </reference/configuration-options>`
reference for documentation of settings available in the configuration file.

As of version |release|, there are no control scripts for
As of version |release|, there are no init scripts for
:program:`mongos`. The :program:`mongos` process is used only in
:doc:`sharding </core/sharding>`. You can use the ``mongod`` init script
to derive your own :program:`mongos` control script.
to derive your own :program:`mongos` init script.
14 changes: 7 additions & 7 deletions source/includes/list-mongodb-org-packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,20 @@ repository contains the following packages:
:program:`mongoperf`, :program:`mongorestore`, :program:`mongostat`,
and :program:`mongotop`.

Control Scripts
---------------
Init Scripts
------------

The ``mongodb-org`` package includes various :term:`control scripts
<control script>`, including the init script |init-script-path|. These scripts
The ``mongodb-org`` package includes various :term:`init scripts
<init script>`, including the init script |init-script-path|. These scripts
are used to stop, start, and restart daemon processes.

The package configures MongoDB using the ``/etc/mongod.conf`` file in
conjunction with the control scripts. See
conjunction with the init scripts. See
the :doc:`Configuration File </reference/configuration-options>`
reference for documentation of settings available in the configuration file.

As of version |release|, there are no control scripts for
As of version |release|, there are no init scripts for
:program:`mongos`. The :program:`mongos` process is used only in
:doc:`sharding </core/sharding>`. You can use the ``mongod`` init script
to derive your own :program:`mongos` control script for use in such
to derive your own :program:`mongos` init script for use in such
environments. See the :program:`mongos` reference for configuration details.
4 changes: 2 additions & 2 deletions source/includes/steps-deploy-replica-set-with-auth.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ action:
code: |
mongod --config $HOME/.mongodb/config
post: |
In production deployments, you can configure a :term:`control script` to
manage this process. Control scripts are beyond the scope of this document.
In production deployments, you can configure a :term:`init script` to
manage this process. Init scripts are beyond the scope of this document.
---
title: "Connect to the member of the replica set where you created the administrative users."
stepnum: 7
Expand Down
16 changes: 8 additions & 8 deletions source/includes/steps-deploy-replica-set.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This file ref'd in steps-convert-replica-set-shard-deploy-test-data.yaml
# This file is tweaked to work with the other step file, as well.
#
title:
title:
text: Start each member of the replica set with the appropriate options.
character: "`"
stepnum: 1
Expand Down Expand Up @@ -29,10 +29,10 @@ action:
code: |
mongod --config $HOME/.mongodb/config
post: |
In production deployments, you can configure a :term:`control script` to
manage this process. Control scripts are beyond the scope of this document.
In production deployments, you can configure a :term:`init script` to
manage this process. Init scripts are beyond the scope of this document.
---
title:
title:
text: Connect a :program:`mongo` shell to a replica set member.
character: "`"
stepnum: 2
Expand All @@ -45,7 +45,7 @@ action:
code: |
mongo
---
title:
title:
text: Initiate the replica set.
character: "`"
stepnum: 3
Expand All @@ -60,7 +60,7 @@ post: |
MongoDB initiates a set that consists of the current member and that
uses the default replica set configuration.
---
title:
title:
text: Verify the initial replica set configuration.
character: "`"
stepnum: 4
Expand All @@ -87,7 +87,7 @@ action:
]
}
---
title:
title:
text: Add the remaining members to the replica set.
character: "`"
stepnum: 5
Expand All @@ -105,7 +105,7 @@ post: |
When complete, you have a fully functional replica set. The new replica
set will elect a :term:`primary`.
---
title:
title:
text: Check the status of the replica set.
character: "`"
stepnum: 6
Expand Down
4 changes: 2 additions & 2 deletions source/reference/configuration-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ deployments. You can also add comments to the configuration file to
explain the server's settings.

If you installed from a package and have started MongoDB using your
system's :term:`control script`, you are already using a configuration
system's :term:`init script`, you are already using a configuration
file.

File Format
Expand Down Expand Up @@ -97,7 +97,7 @@ file, as in the following:
mongos -f /etc/mongos.conf

If you installed from a package and have started MongoDB using your
system's :term:`control script`, you are already using a configuration
system's :term:`init script`, you are already using a configuration
file.

Core Options
Expand Down
4 changes: 2 additions & 2 deletions source/reference/glossary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Glossary
cluster requires three config servers, each on a separate machine.
See :ref:`sharding-config-server`.

control script
init script
A simple shell script, typically located in the ``/etc/rc.d`` or
``/etc/init.d`` directory, and used by the system's initialization
process to start, restart or stop a :term:`daemon` process.
Expand Down Expand Up @@ -1036,4 +1036,4 @@ Glossary

.. [#edge-cases-2-primaries]

.. include:: /includes/footnote-two-primaries-edge-cases.rst
.. include:: /includes/footnote-two-primaries-edge-cases.rst
6 changes: 3 additions & 3 deletions source/tutorial/expand-replica-set.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ that already has seven votes, you must either add the member as a
vote from an :data:`existing member
<replSetGetConfig.members[n].votes>`.

Control Scripts
~~~~~~~~~~~~~~~
Init Scripts
~~~~~~~~~~~~

In production deployments you can configure a :term:`control script`
In production deployments you can configure a :term:`init script`
to manage member processes.

Existing Members
Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/install-mongodb-enterprise-on-red-hat.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Linux versions 5, 6, and 7 from ``.rpm`` packages.
.. include:: /includes/fact-installation-64bit.rst

.. The following include includes two h2 headers:
.. Packages and Control Scripts
.. Packages and Init Scripts

.. include:: /includes/list-mongodb-enterprise-packages.rst

Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/install-mongodb-on-amazon.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ packages.
.. include:: /includes/fact-installation-64bit.rst

.. The following include includes two h2 headers:
.. Packages and Control Scripts
.. Packages and Init Scripts

.. |init-script-path| replace:: ``/etc/rc.d/init.d/mongod``

Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/install-mongodb-on-debian.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ MongoDB only provides packages for 64-bit Debian "Wheezy". These packages may
work with other Debian releases, but this is not a supported configuration.

.. The following include includes two h2 headers:
.. Packages and Control Scripts
.. Packages and Init Scripts

.. |init-script-path| replace:: ``/etc/init.d/mongod``
.. include:: /includes/list-mongodb-org-packages.rst
Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/install-mongodb-on-red-hat.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ packages are generally more up to date.
.. include:: /includes/fact-installation-64bit.rst

.. The following include includes two h2 headers:
.. Packages and Control Scripts
.. Packages and Init Scripts

.. |init-script-path| replace:: ``/etc/rc.d/init.d/mongod``

Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/install-mongodb-on-suse.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ date.
.. include:: /includes/fact-installation-64bit.rst

.. The following include includes two h2 headers:
.. Packages and Control Scripts
.. Packages and Init Scripts

.. |init-script-path| replace:: ``/etc/rc.d/init.d/mongod``

Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/install-mongodb-on-ubuntu.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ packages are generally more up-to-date.
.. include:: /includes/fact-ubuntu-lts-support.rst

.. The following include includes two h2 headers:
.. Packages and Control Scripts
.. Packages and Init Scripts

.. |init-script-path| replace:: ``/etc/init.d/mongod``

Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/manage-mongodb-processes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ the :method:`db.shutdownServer()` method as follows:
use admin
db.shutdownServer()

Calling the same method from a control script accomplishes the same result.
Calling the same method from a :term:`init script` accomplishes the same result.

For systems with :setting:`~security.authorization` enabled, users may only issue
:method:`db.shutdownServer()` when authenticated to the ``admin``
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Reconfigure by Turning Off Replication
This option replaces the :term:`replica set` with a :term:`standalone` server.

1. Stop the surviving :program:`mongod` instances. To ensure a clean shutdown, use
an existing :term:`control script` or use the :method:`db.shutdownServer()` method.
an existing :term:`init script` or use the :method:`db.shutdownServer()` method.

For example, to use the :method:`db.shutdownServer()` method, connect
to the server using the :program:`mongo` shell and issue the
Expand Down Expand Up @@ -149,7 +149,7 @@ procedure, the new primary is ``db0.example.net``. MongoDB copies the
data from ``db0.example.net`` to all the other members.

1. Stop the surviving :program:`mongod` instances. To ensure a clean
shutdown, use an existing :term:`control script` or use the
shutdown, use an existing :term:`init script` or use the
:method:`db.shutdownServer()` method.

For example, to use the :method:`db.shutdownServer()` method, connect
Expand Down
16 changes: 9 additions & 7 deletions source/tutorial/recover-data-following-unexpected-shutdown.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Recover Data after an Unexpected Shutdown

.. default-domain:: mongodb

If MongoDB does not shutdown cleanly [#clean-shutdown]_ the on-disk
If MongoDB does not shutdown cleanly, the on-disk
representation of the data files will likely reflect an inconsistent
state which could lead to data corruption. [#validation]_

Expand All @@ -22,18 +22,20 @@ of a replica set, you should *always* restore from a backup or restart
the :program:`mongod` instance with an empty :setting:`~storage.dbPath` and
allow MongoDB to perform an initial sync to restore the data.

To ensure a clean shut down, use one of the following methods:

* :method:`db.shutdownServer()` from the :program:`mongo` shell,
* Your system's :term:`init script`,
* "Control-C" when running :program:`mongod` in interactive mode,
* ``kill $(pidof mongod)``; or ``kill -2 $(pidof mongod)``,
* On Linux, the :option:`mongod --shutdown` option.

.. seealso:: The :doc:`/administration` documents, including
:ref:`Replica Set Syncing <replica-set-syncing>`, and the
documentation on the :option:`--repair <mongod --repair>`
:setting:`~storage.repairPath` and
:setting:`storage.journal.enabled` settings.

.. [#clean-shutdown] To ensure a clean shut down, use the
:method:`db.shutdownServer()` from the :program:`mongo` shell, your
control script, the :option:`mongod --shutdown` option on Linux
systems, "Control-C" when running :program:`mongod` in interactive
mode, or ``kill $(pidof mongod)`` or ``kill -2 $(pidof mongod)``.

.. [#validation] You can also use the :method:`db.collection.validate()`
method to test the integrity of a single collection. However, this
process is time consuming, and without journaling you can safely
Expand Down