[DOCS-15494] mongosync docs improvements for connecting with Atlas Created: 19/Jul/22  Updated: 19/Jul/22  Resolved: 19/Jul/22

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Minor - P4
Reporter: Pia Kochar Assignee: Unassigned
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 1 year, 29 weeks, 1 day ago

 Description   

While testing out mongosync with Atlas, I noticed a few places where the documentation could be made clearer for using mongosync with Atlas:

1. When starting up mongosync, I needed to specify ssl=true for Atlas connection strings. I think it would be helpful to include this in the docs, as it is not obvious:

The docs for connecting with Atlas currently list the following example connection string:

mongosync --cluster0 mongodb://clusterAdmin:superSecret@clusterOne01.fancyCorp.com:20020,
                    clusterOne02.fancyCorp.com:20020,
                    clusterOne03.fancyCorp.com:20020
          --cluster1 mongodb://clusterAdmin:superSecret@clusterTwo01.fancyCorp.com:20020,
                    clusterTwo02.fancyCorp.com:20020,
                    clusterTwo03.fancyCorp.com:20020

but it should instead look like:

mongosync --cluster0 mongodb://clusterAdmin:superSecret@clusterOne01.fancyCorp.com:20020,
                    clusterOne02.fancyCorp.com:20020,
                    clusterOne03.fancyCorp.com:20020/?ssl=true
          --cluster1 mongodb://clusterAdmin:superSecret@clusterTwo01.fancyCorp.com:20020,
                    clusterTwo02.fancyCorp.com:20020,
                    clusterTwo03.fancyCorp.com:20020/?ssl=true

2. I think it would be helpful to explicitly call out that srv-based connection strings cannot be used for mongosync. This is currently the default connection string type displayed in the Atlas UI for connecting to an Atlas cluster. I think it might be non-obvious to an user that this type of connection string cannot be used.


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