[DOCS-3181] Suggestion for /manual/reference/replica-configuration/ Created: 15/Apr/14  Updated: 10/Jun/14  Resolved: 10/Jun/14

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: v1.3.6

Type: Improvement Priority: Minor - P4
Reporter: Hannes Magnusson Assignee: Kay Kim (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to DOCS-3518 replicaset priority limits are incorr... Closed
Participants:
Days since reply: 9 years, 36 weeks, 1 day ago

 Description   

This page should learn from http://docs.mongodb.org/master/reference/operator/aggregation/ where the structure and ease of finding the info is so simple it makes me smile

Angle brackets (e.g. < and >) enclose all optional fields.

...

host : hostname<:port>,
<arbiterOnly : <boolean>,>

So.. port is optional, also the boolean value for arbiterOnly?
And the <setname>?

Speaking of <setname>

An _id field holding the name of the replica set. This reflects the set name configured with replSetName or mongod --replSet.

so this name is referred to as replSetName, replSet and setname?
Maybe the ship has sailed in mongod, but the docs don't need to introduce <setname>. Use one of the names mongod already uses.

<hidden : <boolean>,>
<priority: <priority>,>

What type is priority? Why do some values have types, while others have some sort of description?

The syntax of the json document is a good attempt to make it correct, but unless the "votes" is required, then any there will always be a trailing coma when copying and pasting from the doc

The whitespace between the examples at the bottom compared to the top "example configuration document" are inconsistent

This page seems to have identity crisis.
Why are we mixing local.systems.replicaset.xxx with what the user has to pass to rs.conf()?

What is being documented?

  • How to configure a replicaset?
  • Available options?
  • Magic internal databases/collections?
  • How to set Replicaset Tags?

New in version 2.6: mongod installed from official .deb and .rpm packages have the bind_ip configuration set to 127.0.0.1 by default.

What does that mean? Can I or can I not use localhost? o.O

For arbiters, this value is true, and is automatically configured by rs.addArb()".

trailing double quote.

Omitting index creation, and thus this setting, may be useful, if:

I didn't read Hamlet, and thus don't care, that I can, or can't, have many many comas and upscale grammar. Just get to the point so my friends from home can read it

buildIndexes is only valid when priority is 0 to prevent these members from becoming primary. Make all instances that do not build indexes hidden.

What?
So, I have to buildIndexes: 0, priority: 0, hidden: true?
Say that then. That was a difficult sentence to grasp.
What happens anyway if I don't? Error? Or will it just delete my data?



 Comments   
Comment by Githook User [ 10/Jun/14 ]

Author:

{u'username': u'kay-kim', u'name': u'kay', u'email': u'kay.kim@10gen.com'}

Message: DOCS-3181 edits per audit of replica-configuration
Branch: master
https://github.com/mongodb/docs/commit/854e6472f18fe97d974a403d12e1d729aee864e7

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