Skip to content

DOCS-2807 shared steps for non-enterprise install tutorials #1697

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
9 changes: 0 additions & 9 deletions source/includes/fact-unix-control-scripts.rst

This file was deleted.

5 changes: 0 additions & 5 deletions source/includes/fact-unix-data-and-log-dir.rst

This file was deleted.

44 changes: 44 additions & 0 deletions source/includes/list-mongodb-enterprise-packages.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
Packages
--------

The MongoDB Enterprise package repository contains five 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``

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`.

Control Scripts
---------------

The ``mongodb-enterprise`` package includes various :term:`control scripts
<control 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.

As of version |release|, there are no control 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.
44 changes: 44 additions & 0 deletions source/includes/list-mongodb-org-packages.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
Packages
--------

The MongoDB package repository contains five 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``

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`.

Control Scripts
---------------

The ``mongodb-org`` package includes various :term:`control scripts
<control 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.

As of version |release|, there are no control 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.
6 changes: 6 additions & 0 deletions source/includes/steps-2.6-downgrade-authorization.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
title:
text: Connect and authenticate to MongoDB instance.
character: "`"
stepnum: 1
ref: connect-and-authenticate
pre: |
Connect and authenticate to the :program:`mongod` instance for a
Expand All @@ -17,6 +18,7 @@ action:
title:
text: Create backup of 2.6 ``admin.system.users`` collection.
character: "`"
stepnum: 2
ref: create-backup-of-new-users
pre: |
Copy all documents in the :data:`admin.system.users`` collection to
Expand All @@ -32,6 +34,7 @@ action:
title:
text: Update the version document for the ``authSchema``.
character: "`"
stepnum: 3
ref: update-version-schema-initial
action:
language: javascript
Expand All @@ -44,6 +47,7 @@ action:
title:
text: "Remove existing documents from the ``admin.system.users`` collection."
character: "`"
stepnum: 4
ref: remove-existing-documents
action:
language: javascript
Expand All @@ -53,6 +57,7 @@ action:
title:
text: Copy documents from the ``admin.system.backup_users`` collection.
character: "`"
stepnum: 5
ref: copy-backup-users
pre: |
Copy all documents from the ``admin.system.backup_users``, created during the
Expand All @@ -69,6 +74,7 @@ action:
title:
text: Update the version document for the ``authSchema``.
character: "`"
stepnum: 6
ref: update-version-schema-final
action:
language: javascript
Expand Down
58 changes: 58 additions & 0 deletions source/includes/steps-configure-windows-service-for-mongodb.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
title: Configure directories and files.
stepnum: 1
ref: directories
pre: |
Create a :doc:`configuration file </reference/configuration-options>`
and a directory path for MongoDB log output (:setting:`logpath`):
action:
- pre: |
Create a specific directory for MongoDB log files:
language: powershell
code: |
md "C:\Program Files\MongoDB\log"
- pre: |
In the :guilabel:`Command Prompt`, create a configuration file for
the :setting:`logpath` option for MongoDB:
language: powershell
code: |
echo logpath="C:\Program Files\MongoDB\log\mongo.log" > "C:\Program Files\MongoDB\mongod.cfg"
---
title: Run the MongoDB service.
stepnum: 2
ref: mongodb-service
pre: |
Run all of the following commands in :guilabel:`Command Prompt` with
"Administrative Privileges:"
action:
- pre: |
Install the MongoDB service. For :option:`--install <mongod.exe
--install>` to succeed, you *must* specify the :setting:`logpath`
run-time option.
language: powershell
code: |
"C:\Program Files\MongoDB\bin\mongod.exe" --config "C:\Program Files\MongoDB\mongod.cfg" --install
- pre: |
Modify the path to the ``mongod.cfg`` file as needed.
post: |
To use an alternate :setting:`dbpath`, specify the path in the
configuration file (e.g. ``C:\Program Files\MongoDB\mongod.cfg``) or
on the command line with the :option:`--dbpath <mongod --dbpath>` option.

If the :setting:`dbpath` directory does not exist, :program:`mongod.exe`
will not start. The default value for :setting:`dbpath` is ``\data\db``.
---
title: Stop or remove the MongoDB service as needed.
stepnum: 3
ref: stop
action:
- pre: |
To stop the MongoDB service use the following command:
language: powershell
code: |
net stop MongoDB
- pre: |
To remove the MongoDB service use the following command:
language: powershell
code: |
"C:\Program Files\MongoDB\bin\mongod.exe" --remove
...
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
title: Start ``mongod.exe`` without Kerberos.
stepnum: 1
ref: start-mongod-exe-without-kerberos-support
title: Start ``mongod.exe`` without Kerberos.
pre: |
For the initial addition of Kerberos users, start :program:`mongod.exe`
without Kerberos support.
Expand All @@ -10,18 +10,18 @@ post: |
<createUser-required-access>`, you can start
:program:`mongod.exe` with Kerberos support.
---
title: Connect to ``mongod``.
stepnum: 2
ref: connect-to-mongod
title: Connect to ``mongod``.
pre: |
Connect via the :program:`mongo.exe` shell to the :program:`mongod.exe`
instance. If :program:`mongod.exe` has :option:`--auth` enabled, ensure
you connect with the :ref:`privileges required to create a user
<createUser-required-access>`.
---
title: Add Kerberos Principal(s) to MongoDB.
stepnum: 3
ref: add-kerberos-principals-windows
title: Add Kerberos Principal(s) to MongoDB
pre: |
Add a Kerberos principal, ``<username>@<KERBEROS REALM>``, to
MongoDB in the ``$external`` database. Specify the Kerberos realm in
Expand Down Expand Up @@ -51,9 +51,9 @@ post: |
information about creating and managing users, see
:doc:`/reference/command/nav-user-management`.
---
title: Start ``mongod.exe`` with Kerberos support.
stepnum: 4
ref: start-mongod-exe-with-kerberos-support
title: Start ``mongod.exe`` with Kerberos Support
pre: |
You must start :program:`mongod.exe` as the :ref:`service principal
account <assign-service-principal-name>`.
Expand All @@ -75,9 +75,9 @@ post: |
Modify or include additional
:program:`mongod.exe` options as required for your configuration.
---
title: Connect ``mongo.exe`` shell to ``mongod.exe`` and authenticate.
stepnum: 5
ref: authenticate-a-user-within-mongo-shell
title: Connect ``mongo.exe`` Shell to ``mongod.exe`` and Authenticate
pre: |
Connect the :program:`mongo.exe` shell client as the Kerberos
principal ``[email protected]``.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
title: Start ``mongod`` without Kerberos.
stepnum: 1
ref: start-mongod-without-kerberos-support
title: Start ``mongod`` without Kerberos.
pre: |
For the initial addition of Kerberos users, start :program:`mongod`
without Kerberos support.
Expand All @@ -10,18 +10,18 @@ post: |
<createUser-required-access>`, you can start
:program:`mongod` with Kerberos support.
---
title: Connect to ``mongod``.
stepnum: 2
ref: connect-to-mongod
title: Connect to ``mongod``.
pre: |
Connect via the :program:`mongo` shell to the :program:`mongod`
instance. If :program:`mongod` has :option:`--auth` enabled, ensure
you connect with the :ref:`privileges required to create a user
<createUser-required-access>`.
---
title: Add Kerberos Principal(s) to MongoDB.
stepnum: 3
ref: add-kerberos-principals
title: Add Kerberos Principal(s) to MongoDB
pre: |
Add a Kerberos principal, ``<username>@<KERBEROS REALM>`` or
``<username>/<instance>@<KERBEROS REALM>``, to MongoDB in the
Expand Down Expand Up @@ -52,9 +52,9 @@ post: |
information about creating and managing users, see
:doc:`/reference/command/nav-user-management`.
---
title: Start ``mongod`` with Kerberos support.
stepnum: 4
ref: start-mongod-with-kerberos-support
title: Start ``mongod`` with Kerberos Support
action:
- pre: |
To start :program:`mongod` with Kerberos support, set the
Expand Down Expand Up @@ -88,9 +88,9 @@ post: |
``KRB5_KTNAME`` in a environment settings file. See
:ref:`setting-krb5_ktname` for details.
---
title: Connect ``mongo`` shell to ``mongod`` and authenticate.
stepnum: 5
ref: invoke-an-authenticated-mongo-shell
title: Connect ``mongo`` Shell to ``mongod`` and Authenticate
pre: |
Connect the :program:`mongo` shell client as the Kerberos principal
``application/[email protected]``. Before connecting, you
Expand Down
32 changes: 0 additions & 32 deletions source/includes/steps-install-configure-debian-packages.yaml

This file was deleted.

14 changes: 14 additions & 0 deletions source/includes/steps-install-mongodb-enterprise-on-amazon.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
stepnum: 1
source:
file: steps-install-mongodb-enterprise-on-linux.yaml
ref: sequence
# The content of the following include is auto-generated:
action:
pre: |
.. include:: /includes/install-curl-release-ent-amzn64.rst
---
stepnum: 2
source:
file: steps-install-mongodb-enterprise-on-linux.yaml
ref: ensure-binaries-in-path
...
23 changes: 23 additions & 0 deletions source/includes/steps-install-mongodb-enterprise-on-linux.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# This is a parent procedure that provides steps for other procedures to inherit.
# This procedure is NOT intended for direction inclusion in a tutorial.
#
title: Download and install the MongoDB Enterprise packages.
stepnum: 1
ref: sequence
# When borrowing this step, you must include an action with a command sequence.
pre: |
After you have installed the required prerequisite packages, download
and install the MongoDB Enterprise packages from
`<http://www.mongodb.com/products/mongodb-enterprise>`_. The MongoDB
binaries are located in the ``/bin`` directory of the archive. To download
and install, use the following sequence of commands.
---
title: Ensure the location of the MongoDB binaries is included in the ``PATH`` variable.
stepnum: 2
ref: ensure-binaries-in-path
pre: |
Once you have copied the MongoDB binaries to their target location,
ensure that the location is included in your ``PATH`` variable. If it is
not, either include it or create symbolic links from the binaries to a
directory that is included.
...
Loading