Skip to content

DOCS-6763: Link to past install instructions, and tidy up a bit #2511

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
116 changes: 116 additions & 0 deletions source/includes/extracts-install-past-mongodb.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
ref: _install-past-mongodb
content: |
.. note::

To install a version of MongoDB prior to 3.2, please refer to that version's
documentation. For example, see version {{installLink}}.
---

# Community
ref: install-past-mongodb-org-red-hat
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-on-red-hat/>`_"
---
ref: install-past-mongodb-org-ubuntu
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-on-ubuntu/>`_"
---
ref: install-past-mongodb-org-debian
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-on-debian/>`_"
---
ref: install-past-mongodb-org-suse
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-on-suse/>`_"
---
ref: install-past-mongodb-org-amazon
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-on-amazon/>`_"
---
ref: install-past-mongodb-org-tarball
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-on-linux/>`_"
---
ref: install-past-mongodb-org-windows
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-on-windows/>`_"
---
ref: install-past-mongodb-org-osx
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-on-os-x/>`_"
---

# Enterprise
ref: install-past-mongodb-enterprise-red-hat
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-enterprise-on-red-hat/>`_"
---
ref: install-past-mongodb-enterprise-ubuntu
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-enterprise-on-ubuntu/>`_"
---
ref: install-past-mongodb-enterprise-debian
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-enterprise-on-debian/>`_"
---
ref: install-past-mongodb-enterprise-suse
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-enterprise-on-suse/>`_"
---
ref: install-past-mongodb-enterprise-amazon
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-enterprise-on-amazon/>`_"
---
ref: install-past-mongodb-enterprise-tarball
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-enterprise-on-linux/>`_"
---
ref: install-past-mongodb-enterprise-windows
inherit:
file: extracts-install-past-mongodb.yaml
ref: _install-past-mongodb
replacement:
installLink: "`3.0 </v3.0/tutorial/install-mongodb-enterprise-on-windows/>`_"
...
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The default ``/etc/mongod.conf`` configuration file supplied by the
3.0 series packages has :setting:`~net.bind_ip` set to
``127.0.0.1`` by default. Modify this setting as needed for your
environment before initializing a :term:`replica set`.
packages have :setting:`~net.bind_ip` set to ``127.0.0.1`` by default. Modify
this setting as needed for your environment before initializing a
:term:`replica set`.
14 changes: 14 additions & 0 deletions source/includes/fact-mongodb-org-package-init-scripts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
The ``mongodb-org`` package includes various :term:`init scripts
<init script>`, including the init script |init-script-path|. You can use these
scripts to stop, start, and restart daemon processes.

The package configures MongoDB using the ``/etc/mongod.conf`` file in
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 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` init script for use in such
environments. See the :program:`mongos` reference for configuration details.
57 changes: 18 additions & 39 deletions source/includes/list-mongodb-enterprise-packages.rst
Original file line number Diff line number Diff line change
@@ -1,47 +1,26 @@
Packages
--------

MongoDB provides officially supported Enterprise packages in their own
repository. This repository contains the following packages:

- ``mongodb-enterprise``

This package is a ``metapackage`` that will automatically install
the four component packages listed below.

- ``mongodb-enterprise-server``

This package contains the :program:`mongod` daemon and associated
configuration and init scripts.

- ``mongodb-enterprise-mongos``

This package contains the :program:`mongos` daemon.

- ``mongodb-enterprise-shell``

This package contains the :program:`mongo` shell.

- ``mongodb-enterprise-tools``
.. list-table::
:widths: 25 75

This package contains the following MongoDB tools: :program:`mongoimport`
:program:`bsondump`, :program:`mongodump`, :program:`mongoexport`,
:program:`mongofiles`, :program:`mongoimport`, :program:`mongooplog`,
:program:`mongoperf`, :program:`mongorestore`, :program:`mongostat`,
and :program:`mongotop`.
* - ``mongodb-enterprise``
- A ``metapackage`` that will automatically install
the four component packages listed below.

Init Scripts
------------
* - ``mongodb-enterprise-server``
- Contains the :program:`mongod` daemon and associated
configuration and init scripts.

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

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

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` init script.
* - ``mongodb-enterprise-tools``
- Contains the following MongoDB tools: :program:`mongoimport`
:program:`bsondump`, :program:`mongodump`, :program:`mongoexport`,
:program:`mongofiles`, :program:`mongooplog`,
:program:`mongoperf`, :program:`mongorestore`, :program:`mongostat`,
and :program:`mongotop`.
59 changes: 18 additions & 41 deletions source/includes/list-mongodb-org-packages.rst
Original file line number Diff line number Diff line change
@@ -1,49 +1,26 @@
Packages
--------

MongoDB provides officially supported packages in their own repository. This
repository contains the following packages:

- ``mongodb-org``

This package is a ``metapackage`` that will automatically install
the four component packages listed below.

- ``mongodb-org-server``

This package contains the :program:`mongod` daemon and associated
configuration and init scripts.

- ``mongodb-org-mongos``

This package contains the :program:`mongos` daemon.

- ``mongodb-org-shell``

This package contains the :program:`mongo` shell.

- ``mongodb-org-tools``
.. list-table::
:widths: 25 75

This package contains the following MongoDB tools: :program:`mongoimport`
:program:`bsondump`, :program:`mongodump`, :program:`mongoexport`,
:program:`mongofiles`, :program:`mongooplog`,
:program:`mongoperf`, :program:`mongorestore`, :program:`mongostat`,
and :program:`mongotop`.
* - ``mongodb-org``
- A ``metapackage`` that will automatically install
the four component packages listed below.

Init Scripts
------------
* - ``mongodb-org-server``
- Contains the :program:`mongod` daemon and associated
configuration and init 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.
* - ``mongodb-org-mongos``
- Contains the :program:`mongos` daemon.

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

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` init script for use in such
environments. See the :program:`mongos` reference for configuration details.
* - ``mongodb-org-tools``
- Contains the following MongoDB tools: :program:`mongoimport`
:program:`bsondump`, :program:`mongodump`, :program:`mongoexport`,
:program:`mongofiles`, :program:`mongooplog`,
:program:`mongoperf`, :program:`mongorestore`, :program:`mongostat`,
and :program:`mongotop`.
5 changes: 0 additions & 5 deletions source/includes/note-package-change.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ action:
language: sh
code: |
echo "deb http://repo.mongodb.com/apt/ubuntu "$(lsb_release -sc)"/mongodb-enterprise/2.6 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise-2.6.list
- pre: |
---
stepnum: 3
source:
Expand Down
12 changes: 3 additions & 9 deletions source/includes/steps-install-mongodb-on-debian.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
title: Import the public key used by the package management system.
stepnum: 1
ref: import-key
action:
pre: |
Issue the following command to add the `MongoDB public GPG Key
<https://docs.mongodb.org/10gen-gpg-key.asc>`_ to the system key ring.
language: sh
code: |
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com --recv EA312927
source:
file: steps-install-mongodb-on-ubuntu.yaml
ref: import-key
---
title: Create a ``/etc/apt/sources.list.d/mongodb-org-3.2.list`` file for MongoDB.
stepnum: 2
Expand Down
4 changes: 0 additions & 4 deletions source/includes/steps-install-mongodb-on-red-hat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,4 @@ action:
language: ini
code: |
exclude=mongodb-org,mongodb-org-server,mongodb-org-shell,mongodb-org-mongos,mongodb-org-tools
post: |
Versions of the MongoDB packages before 2.6 use a different repo
location. Refer to the version of the documentation appropriate for
your MongoDB version.
...
6 changes: 1 addition & 5 deletions source/includes/steps-install-mongodb-on-ubuntu.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ action:
The Ubuntu package management tools (i.e. ``dpkg`` and ``apt``) ensure
package consistency and authenticity by requiring that distributors
sign packages with GPG keys. Issue the following command to import the
`MongoDB public GPG Key <https://docs.mongodb.org/10gen-gpg-key.asc>`_:
`MongoDB public GPG Key <https://www.mongodb.org/static/pgp/server-3.2.asc>`_:
language: sh
code: |
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv EA312927
Expand Down Expand Up @@ -78,8 +78,4 @@ action:
echo "mongodb-org-shell hold" | sudo dpkg --set-selections
echo "mongodb-org-mongos hold" | sudo dpkg --set-selections
echo "mongodb-org-tools hold" | sudo dpkg --set-selections
post: |
Versions of the MongoDB packages before 2.6 use a different repository
location. Refer to the version of the documentation appropriate for
your MongoDB version.
...
2 changes: 2 additions & 0 deletions source/tutorial/install-mongodb-enterprise-on-amazon.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ To install all of MongoDB's dependencies, run the following command:
Install MongoDB Enterprise
--------------------------

.. include:: /includes/extracts/install-past-mongodb-enterprise-amazon.rst

.. note::

The Enterprise packages include an example SNMP configuration file
Expand Down
11 changes: 4 additions & 7 deletions source/tutorial/install-mongodb-enterprise-on-debian.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,15 @@ Debian 7 "Wheezy".

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

Considerations
--------------
Install MongoDB Enterprise
--------------------------

.. include:: /includes/fact-installation-64bit.rst
.. include:: /includes/extracts/install-past-mongodb-enterprise-debian.rst

.. include:: /includes/note-package-change.rst
.. include:: /includes/fact-installation-64bit.rst

.. include:: /includes/fact-use-distribution-package.rst

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

.. include:: /includes/steps/install-mongodb-enterprise-on-debian.rst

.. _install-debian-from-tarball:
Expand Down
2 changes: 2 additions & 0 deletions source/tutorial/install-mongodb-enterprise-on-linux.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ installing MongoDB for other Linux systems without supported packages.
Install MongoDB
---------------

.. include:: /includes/extracts/install-past-mongodb-enterprise-tarball.rst

.. include:: /includes/steps/install-mongodb-enterprise-on-linux.rst

Run MongoDB
Expand Down
11 changes: 4 additions & 7 deletions source/tutorial/install-mongodb-enterprise-on-red-hat.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,19 @@ Linux versions 5, 6, and 7 from ``.rpm`` packages.

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

Considerations
--------------

.. include:: /includes/fact-use-distribution-package.rst

.. include:: /includes/fact-installation-bind-ip-default-in-config.rst

.. include:: /includes/note-package-change.rst

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

.. include:: /includes/extracts/install-past-mongodb-enterprise-red-hat.rst

When you install the packages for MongoDB Enterprise, you choose whether
to install the current release or a previous one. This procedure describes
how to do both.

.. include:: /includes/fact-use-distribution-package.rst

.. include:: /includes/steps/install-mongodb-enterprise-on-red-hat.rst

.. _install-redhat-from-tarball:
Expand Down
Loading