Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #87

Merged

Conversation

tdq45gj
Copy link
Collaborator

@tdq45gj tdq45gj commented Feb 11, 2025

An update to README per @ajayvijayakumar123's request.

Copy link
Collaborator

@ajayvijayakumar123 ajayvijayakumar123 left a comment

Choose a reason for hiding this comment

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

LGTM!

README.md Outdated
@@ -14,6 +14,11 @@ _If verifying a migration done via [mongosync](https://www.mongodb.com/docs/clus

_Assumes no port set, default port for operation webserver is 27020_

# Recommendations

Users should use a different cluster for storing migration verification metadata. If the user must use the destination cluster,
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should clarify why.

Copy link
Collaborator

@FGasper FGasper Feb 11, 2025

Choose a reason for hiding this comment

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

Also, the user may be the reader of this document; thus, describing what “the user” should do could cause confusion.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested:

# Verifier Metadata Considerations

migration-verifier needs a database to store its state. This database SHOULD be on its own cluster.

The verifier _can_ instead store its metadata on the destination cluster. This can severely degrade performance, though. It also requires either disabling mongosync’s destination write blocking or giving the `bypassWriteBlockingMode` to the verifier’s `--metaURI` user.

Copy link
Collaborator

Choose a reason for hiding this comment

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

yup fair point. Also, I asked Jian to put up this PR because I'm still lacking push permissions for some reason (and I didn't want to deal with all the permission stuff yet for a readme update 😅 )

@tdq45gj tdq45gj requested a review from FGasper February 11, 2025 20:42
Copy link
Collaborator

@FGasper FGasper left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@tdq45gj tdq45gj merged commit e994eea into mongodb-labs:main Feb 11, 2025
49 checks passed
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