Skip to content

Problem: No documentation about supported MongoDB authentication modes#2495

Merged
shahbazn merged 2 commits intobigchaindb:masterfrom
shahbazn:document-hosted-mongodb-deployment
Aug 31, 2018
Merged

Problem: No documentation about supported MongoDB authentication modes#2495
shahbazn merged 2 commits intobigchaindb:masterfrom
shahbazn:document-hosted-mongodb-deployment

Conversation

@shahbazn
Copy link
Copy Markdown
Contributor

@shahbazn shahbazn commented Aug 30, 2018

Solution: Add documentation for production nodes.

@shahbazn shahbazn requested a review from ttmc August 30, 2018 11:41
@codecov-io
Copy link
Copy Markdown

codecov-io commented Aug 30, 2018

Codecov Report

Merging #2495 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2495      +/-   ##
==========================================
- Coverage   91.16%   91.13%   -0.03%     
==========================================
  Files          41       41              
  Lines        2455     2447       -8     
==========================================
- Hits         2238     2230       -8     
  Misses        217      217

ttmc
ttmc previously requested changes Aug 30, 2018

Login to your MongoDB deployment as Admin and run following commands

```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

```text


_Don't use macOS_ (formerly OS X, formerly Mac OS X), because it's not a server-grade operating system. Also, BigchaindB Server uses the Python multiprocessing package and [some functionality in the multiprocessing package doesn't work on Mac OS X](https://docs.python.org/3.6/library/multiprocessing.html#multiprocessing.Queue.qsize).

## Using Hosted MongoDB
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this page is the best place to put this documentation. Maybe put it on the page about BigchainDB configuration settings (i.e. http://docs.bigchaindb.com/projects/server/en/master/server-reference/configuration.html#database ), since that's the only other place in the docs where the backend database username/login and password are mentioned.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only usecase I see for this is a production one, which is the reason I did not add it to simple network guide either. So I thought it was appropriate to add it under production nodes notes. If you agree I think we should keep it here as well. I will add some detail in config page but keeping in mind login field is still used if we use SSL cert based x.509 authentication method. password is not needed in x.509 method.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using a hosted MongoDB isn't required, even in production nodes, and I don't want to give that impression by including it in the "Production Node Requirements" page. (We would also have to include instructions to set up MongoDB to use the X.509 auth system, and I really don't want to do that.)

It's good to know that password isn't needed when using the X.509 method. Maybe add a note about that to the documentation about password.

@ttmc ttmc changed the title Problem: No ducumentation for hosted MongoDB Problem: No documentation for hosted MongoDB Aug 30, 2018
@ttmc ttmc dismissed their stale review August 31, 2018 11:17

I pushed a commit that has the changes that I thought made sense

@shahbazn shahbazn merged commit cb41826 into bigchaindb:master Aug 31, 2018
@ttmc ttmc changed the title Problem: No documentation for hosted MongoDB Problem: No documentation about supported MongoDB authentication modes Sep 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants