[DOCS-3167] Suggestion for /manual/tutorial/install-mongodb-on-red-hat-centos-or-fedora-linux/ Created: 15/Apr/14  Updated: 11/Jan/17  Resolved: 11/Sep/14

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: 01112017-cleanup

Type: Improvement Priority: Minor - P4
Reporter: bard.bloom@10gen.com Assignee: Michael Paik
Resolution: Done Votes: 0
Labels: audit-2014
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 9 years, 22 weeks, 6 days ago

 Description   

This tutorial outlines the steps to install MongoDB on Red Hat Enterprise Linux, CentOS Linux, Fedora Linux and related systems. The tutorial uses .rpm packages to install.

The last sentence is a bit rough. Consider something like "This tutorial outlines the steps to install MongoDB from .rpm packages"

This package contains all MongoDB tools from the latest stable release.

It is not clear to the naïve reader whether the mongo-10gen package contains mongod and mongos or not, and whether one package or two must be installed. Even though this is made somewhat clear later, it's upsetting here.

When this command completes, you have successfully installed MongoDB!

I'm not sure about yum, but various package installers require me to answer y or yes to some questions. Does or might yum?

A correction is forthcoming, see SERVER-7285 for more information, and in the mean time use your own control scripts or install using the procedure outlined in Install MongoDB on Linux Systems.

Comma splice.

Control Scripts

After reading this section and following the "control scripts" link, I have no idea what, if anything, I'm supposed to do with control scripts.

(I'd expect to see text like "These scripts tell MongoDB how to start and stop. If you want to change the location of MongoDB's data files from /var/lib/mongo, edit the control script foo and change the --dbpath parameter in the mongod command on line 384753945")

You can use the mongod init script to derive your own mongos control script.

Why would I want to do that? What would such a script do?

(As a Mongo expert, I'd expect an answer along the lines of "A typical mongos control script will start three mongos instances, giving them information in command-line arguments or configuration files about the replica sets in their sharded cluster")

enable access to the relevant ports (e.g. 27017) for SELinux.

For extra friendliness, I'd recommend adding a clause like "e.g., using the foo tool" here, if there is a standard tool to enable access to ports on SELinux.

The MongoDB instance stores its data files in the /var/lib/mongo and its log files in /var/log/mongo, and run using the mongod user account.

Can this be changed?

If you change the user that runs the MongoDB process, you must modify the access control rights to the /var/lib/mongo and /var/log/mongo directories.

For extra friendliness, consider adding a clause like "using a command like {{chown newuser /var/

{lib,log}

/mongo}}". Or whatever we recommend doing, if chown isn't the right thing.

You can verify that the mongod process has started successfully by checking the contents of the log file at /var/log/mongo/mongod.log.

A naïve user who has never seen a MongoDB log file might well get upset here, wondering "What do I look for to tell if it's working?" A link to a "reading MongoDB log files" page might be helpful here, or, lacking that, a sentence to the effect that a running MongoDB log file tends to have waiting for connection or connection accepted messages towards the end, whereas a failed log file ends with shutdown messages and reasons why it failed. If you actually look at the log it's usually easy to tell, though I'm not sure how to communicate this to a naïve user.



 Comments   
Comment by Githook User [ 11/Sep/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-3167: edits and stabalizing single sourcing
Branch: master
https://github.com/mongodb/docs/commit/3992901498fceb3d73e14313a4a562fad3c1112c

Comment by Githook User [ 11/Sep/14 ]

Author:

{u'username': u'mpaik', u'name': u'Michael Paik', u'email': u'michael.paik@10gen.com'}

Message: DOCS-3167 - improvements and lots of bug fixes

Signed-off-by: Sam Kleinman <samk@10gen.com>
Branch: master
https://github.com/mongodb/docs/commit/0f33de901cf42ed46947e6cf5804a57b442568e1

Generated at Thu Feb 08 07:45:08 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.