[DOCS-12374] Users must set an IPv6 address for net.bindIp if they want to bind to an IPv6 address Created: 16/Jan/19  Updated: 30/Oct/23  Resolved: 07/Feb/19

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Bug Priority: Major - P3
Reporter: Anthony Sansone (Inactive) Assignee: Ravind Kumar (Inactive)
Resolution: Fixed Votes: 0
Labels: configuration, ipv6
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

https://docs.mongodb.com/manual/reference/configuration-options/#net.ipv6


Issue Links:
Documented
Related
Participants:
Days since reply: 5 years, 6 days ago
Epic Link: DOCSP-1769
Story Points: 0.25

 Description   

Summary

Setting net.ipv6 directs the mongod/mongos to generally support IPv6 addressing, such as resolving DNS hostnames to IPv6 or outgoing connections to remove IPv6 hosts (e.g. other replica set members).

However, the mongod/mongos will *not* auto-bind to any local IPv6 addresses or interfaces. If user's want the mongod/mongos to listen on an IPv6 interface, they must set
net.ipv6 to true and set at least one valid IPv6 address in net.bindIp (or set net.bindIpAll : true.

One caveat - if the user wants the mongod/mongos to listen on a link-local address fe80::/10, when specifying the address they must append a % followed by the network adapter name associated to that address (fe80::a00:27ff:fee0:1fcf%enp0s3.

Original Description

According to changes going in for DOCSP- , jonathan.balsano indicated that if a user sets net.ipv6 for a MongoDB deployment, they also need to set net.bindIp (or, presumably, net.bindIpAll.

Please add that condition to net.ipv6.

Scope of changes

Update documentation for net.bindIp with basic instructions on setting IPv6 addressing and relationship with net.ipv6.
Update documentation on net.ipv6 to explicitly state that it does not automatically direct the mongod/mongos to accept incoming connections via IPv6 addresses.

 



 Comments   
Comment by Ravind Kumar (Inactive) [ 07/Feb/19 ]

That's all folks! 4.2 -> 3.0 updated with better docs on ipv6 + bindIp/bindIpAll relationships.

Comment by Githook User [ 07/Feb/19 ]

Author:

{'name': 'rkumar-mongo', 'email': 'ravind.kumar@mongodb.com'}

Message: DOCS-12374: Update documentation for ipv6, bindIp, bindIpAll for ipv6
Branch: v3.0
https://github.com/mongodb/docs/commit/77e86fdb7ed0201f6c76c25cbbbba5887c3e751a

Comment by Githook User [ 07/Feb/19 ]

Author:

{'name': 'rkumar-mongo', 'email': 'ravind.kumar@mongodb.com'}

Message: DOCS-12374: Update documentation for ipv6, bindIp, bindIpAll for ipv6
Branch: v3.2
https://github.com/mongodb/docs/commit/56b5879261ee5f067181b09046195187c4ab4f94

Comment by Githook User [ 07/Feb/19 ]

Author:

{'name': 'rkumar-mongo', 'email': 'ravind.kumar@mongodb.com'}

Message: DOCS-12374: Update documentation for ipv6, bindIp, bindIpAll for ipv6
Branch: v3.4
https://github.com/mongodb/docs/commit/23c23b08cb132c4ff9f848dfa95c060b13c33d75

Comment by Githook User [ 07/Feb/19 ]

Author:

{'name': 'rkumar-mongo', 'email': 'ravind.kumar@mongodb.com'}

Message: DOCS-12374: Update documentation for ipv6, bindIp, bindIpAll for ipv6
Branch: v3.6
https://github.com/mongodb/docs/commit/cdc8974c83caad6c561ac6b064e263fbc70d0b40

Comment by Ravind Kumar (Inactive) [ 07/Feb/19 ]

Backport is slightly delayed due to git pulling in a lot of cruft. Deploying master -> 3.6, 3.4 -> 3.0 will wrap by tomorrow morning.

Comment by Githook User [ 06/Feb/19 ]

Author:

{'name': 'rkumar-mongo', 'email': 'ravind.kumar@mongodb.com'}

Message: DOCS-12374: Update documentation for ipv6, bindIp, bindIpAll for ipv6
Branch: v4.0
https://github.com/mongodb/docs/commit/a04fe662dcb848911043db85e1889a740b3223da

Comment by Githook User [ 06/Feb/19 ]

Author:

{'name': 'rkumar-mongo', 'email': 'ravind.kumar@mongodb.com'}

Message: DOCS-12374: Update documentation for ipv6, bindIp, bindIpAll for ipv6
Branch: master
https://github.com/mongodb/docs/commit/daaa40c47b18b27b14d16699184c5aa0593d1b79

Comment by Jonathan Balsano [ 17/Jan/19 ]

Gotcha. So it's not so much that it's an error. The issue is if you don't put an IPv6 address in there (and you're running in a mixed environment with both IPv4 and IPv6) I'm pretty sure it won't bind to the IPv6 IPs. So while you won't get an error, you won't be able to connect to the mongod via ::1 or it's external IPv6 addresses.

In that HELP ticket I suspect the issue you're running into is that your VM doesn't have an IPv6 network gateway.

Comment by Jonathan Balsano [ 17/Jan/19 ]

Just want to call out that this was our experience while using IPv6 but it may be worth checking with the server team to make sure it's correct.

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