Skip to content

Commit 3a7c1e1

Browse files
Merge pull request #114 from timvaillancourt/readme_links_v1
Additional README links
2 parents dd7c372 + 6804874 commit 3a7c1e1

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,17 @@ About
77
Creates cluster-consistent point-in-time backups of MongoDB with optional
88
archiving, compression/de-duplication, encryption and upload functionality
99

10+
The motivation for this tool in explained in this Percona blog post *(more posts coming soon)*:
11+
`"MongoDB Consistent Backups" <https://www.percona.com/blog/2016/07/25/mongodb-consistent-backups/>`__
12+
1013
Features
1114
~~~~~~~~
1215

1316
- Works on a single replset (2+ members) or a sharded cluster
1417
- Auto-discovers healthy members for backup by considering replication
1518
lag, replication 'priority' and by preferring 'hidden' members
1619
- Creates cluster-consistent backups across many separate shards
17-
- 'mongodump' is the default *(and currently only)* backup method. Other methods coming soon!
20+
- `'mongodump' <https://docs.mongodb.com/manual/reference/program/mongodump/>`__ is the default *(and currently only)* backup method. Other methods coming soon!
1821
- Transparent restore process (*just add --oplogReplay flag to your
1922
mongorestore command*)
2023
- Archiving and compression of backups (*optional*)
@@ -42,7 +45,7 @@ Requirements:
4245
hosts! Server time **must be synchronized on all nodes** using ntpd
4346
and a consistent time source or virtualization guest agent that
4447
syncs time
45-
- Must have 'mongodump' installed and specified if not at default:
48+
- Must have `'mongodump' <https://docs.mongodb.com/manual/reference/program/mongodump/>`__ installed and specified if not at default:
4649
*/usr/bin/mongodump*. Even if you do not run MongoDB 3.2+, it is
4750
strongly recommended to use MongoDB 3.2+ mongodump binaries due
4851
to inline compression and parallelism features
@@ -130,7 +133,7 @@ A description of all available config settings can also be listed by passing the
130133
Restore a Backup
131134
~~~~~~~~~~~~~~~~
132135

133-
The backups are mongorestore compatible and stored in a directory per backup. The *--oplogReplay* flag **MUST** be present to replay the oplogs to ensure consistency.
136+
The backups are `mongorestore <https://docs.mongodb.com/manual/reference/program/mongorestore/>`__ compatible and stored in a directory per backup. The *--oplogReplay* flag **MUST** be present to replay the oplogs to ensure consistency.
134137

135138
::
136139

@@ -204,7 +207,7 @@ To remove a backup, first delete the .tar file in 'backups' subdir of the ZBacku
204207
Roadmap
205208
~~~~~~~
206209

207-
- More testing: this project has many flows that probably need more in-depth testing. Please submit and bugs and/or bugfixes!
210+
- More testing: this project has many flows that probably need more in-depth testing. Please submit any bugs and/or bugfixes!
208211
- "Distributed Mode" for running backup on remote hosts *(vs. only on one host)*
209212
- Upload compatibility for ZBackup archive phase *(upload unsupported today)*
210213
- Backup retention/rotation *(eg: delete old backups)*
@@ -214,6 +217,15 @@ Roadmap
214217
- Documentation for running under Docker with persistent volumes
215218
- Python unit tests
216219

220+
Links
221+
~~~~~
222+
223+
- https://www.percona.com/blog/2016/07/25/mongodb-consistent-backups/
224+
- https://www.percona.com/blog/2017/01/09/mongodb-pit-backups-part-2/
225+
- https://docs.mongodb.com/manual/reference/program/mongodump/
226+
- https://docs.mongodb.com/manual/reference/program/mongorestore/
227+
- http://zbackup.org
228+
217229
Contact
218230
~~~~~~~
219231

0 commit comments

Comments
 (0)