Skip to content

Commit 2cda30f

Browse files
author
Dave Cuthbert
authored
Merge pull request #9 from davemungo/DOCSP-22726-c2c-install-v2
DOCSP-22726 c2c install
2 parents 2fd95fb + 0da25d7 commit 2cda30f

14 files changed

+250
-31
lines changed

‎snooty.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ title = "MongoDB Cluster-to-Cluster Sync"
44
intersphinx = [ "https://docs.mongodb.com/manual/objects.inv" ]
55

66
toc_landing_pages = ["/quickstart",
7+
"/installation",
78
"reference/reference",
89
"/release-notes/release-notes",
910
"/faq"
@@ -15,4 +16,4 @@ c2c-product-name = "Cluster-to-Cluster Sync"
1516
c2c-full-product-name = "MongoDB Cluster-to-Cluster Sync"
1617

1718
[substitutions]
18-
# string = "some other string"
19+
c2c-product-name = "Cluster-to-Cluster Sync"

‎source/includes/fact-install-past-mongosync.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
This tutorial installs {+c2c-full-product-name+} {+version+}. To
3+
install a different version of {+c2c-product-name+}, use the version
4+
drop-down menu in the upper-left corner of this page to select the
5+
documentation for that version.

‎source/includes/fact-mongodb-version.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
{+c2c-product-name+} supports synchronization between clusters. Both
3+
the source and destination cluster must use MongoDB 6.0 or later. The
4+
:dbcommand:`Feature Compatibility Version (FCV)
5+
<setFeatureCompatibilityVersion>` must also be set to 6.0 or later.

‎source/includes/run-c2c.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
To run and administer ``mongosync``, see :ref:`c2c-using-mongosync`.

‎source/includes/step-update-path.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
The ``mongosync`` binary is in the ``dist/`` directory of the
2+
unpacked tarball. To add the location of the ``mongosync`` binary to
3+
your ``PATH``, do one of the following:
4+
5+
- Copy the binary into a directory listed in your ``PATH``
6+
variable, such as ``/usr/local/bin``. (Update
7+
``/path/to/mongosync/dist`` to reflect the location where you
8+
extracted the ``tar`` file.)
9+
10+
.. code-block:: bash
11+
12+
sudo cp /path/to/mongosync/dist/mongosync /usr/local/bin/
13+
14+
- Create symbolic links to the ``mongosync`` binary from a
15+
directory such as ``/usr/local/bin`` that is already in your
16+
``PATH``. (Update ``/path/to/mongosync/dist`` to reflect the
17+
location where you extracted the ``tar`` file.)
18+
19+
.. code-block:: bash
20+
21+
sudo ln -s /path/to/mongosync/dist/mongosync /usr/local/bin/mongosync
22+
23+

‎source/index.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _c2c-index:
22

3-
=========================
4-
{+c2c-full-product-name+}
5-
=========================
3+
===============================
4+
MongoDB Cluster-to-Cluster Sync
5+
===============================
66

77
.. default-domain:: mongodb
88

@@ -15,7 +15,7 @@ NOTE: This page will have material that introduces C2C to the reader.
1515

1616
/quickstart
1717
/installation
18-
/running-mongosync
18+
/using-mongosync
1919
/connecting
2020
/reference
2121
/release-notes

‎source/installation.txt

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,23 @@
44
Installation
55
============
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
These documents provide instructions to install {+c2c-full-product-name+}.
14+
15+
:ref:`c2c-install-linux`
16+
Install the official builds of {+c2c-product-name+} on Linux-based operating systems.
17+
18+
:ref:`c2c-install-macos`
19+
Install the official build of {+c2c-product-name+} on macOS.
20+
721
.. toctree::
8-
:titlesonly:
22+
:hidden:
923

1024
/installation/install-on-linux
1125
/installation/install-on-macos
12-
/installation/install-on-windows
1326

‎source/installation/install-on-linux.txt

Lines changed: 93 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,97 @@ Install on Linux
66

77
.. default-domain:: mongodb
88

9-
Linux install pages
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: twocols
1014

15+
.. |arrow| unicode:: U+27A4
16+
.. |executable-name| replace:: ``mongosync``
17+
.. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
18+
19+
Overview
20+
--------
21+
22+
Use this tutorial to manually install {+c2c-full-product-name+}
23+
{+version+} on Linux using a downloaded ``.tgz`` tarball.
24+
25+
{+c2c-product-name+} is available on select platforms.
26+
27+
.. bug in constant parser DOP-3025
28+
29+
{+c2c-product-name+} Version
30+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31+
32+
.. include:: /includes/fact-install-past-mongosync.rst
33+
34+
Considerations
35+
--------------
36+
37+
Consider the following when running {+c2c-full-product-name+} on Linux:
38+
39+
Platform Support
40+
~~~~~~~~~~~~~~~~
41+
42+
{+c2c-product-name+} is available on the following Linux operating
43+
systems:
44+
45+
- Red Hat Enterprise Linux (RHEL) 7
46+
- Red Hat Enterprise Linux (RHEL) 8
47+
- Ubuntu 18.04
48+
- Ubuntu 20.04
49+
50+
Version Requirements
51+
~~~~~~~~~~~~~~~~~~~~
52+
53+
.. include:: /includes/fact-mongodb-version.rst
54+
55+
.. bug in constant parser DOP-3025
56+
57+
Install {+c2c-product-name+}
58+
-------------------------------
59+
60+
Follow these steps to manually install {+c2c-product-name+} from
61+
the ``.tgz``.
62+
63+
.. procedure::
64+
:style: normal
65+
66+
.. step:: Download the tarball.
67+
68+
Download the {+c2c-product-name+} ``.tgz`` tarball from the
69+
following link:
70+
71+
|arrow| |mdb-download-link|
72+
73+
a. In the :guilabel:`Version` dropdown, select the version of
74+
{+c2c-product-name+} to download.
75+
76+
#. In the :guilabel:`Platform` dropdown, select
77+
:guilabel:`Linux`.
78+
79+
#. In the :guilabel:`Package` dropdown, select
80+
:guilabel:`shell (tgz)`.
81+
82+
#. Click :guilabel:`Download`.
83+
84+
.. step:: Extract the files from the downloaded archive.
85+
86+
To extract ``mongosync``, use the ``tar`` command in a system
87+
shell:
88+
89+
.. code-block:: bash
90+
91+
tar -zxvf mongosync-*.tgz
92+
93+
.. step:: Ensure the binary is in a directory listed in your ``PATH`` environment variable.
94+
95+
.. include:: /includes/step-update-path.rst
96+
97+
.. bug in constant parser DOP-3025
98+
99+
Run {+c2c-product-name+}
100+
---------------------------
101+
102+
.. include:: /includes/run-c2c.rst

‎source/installation/install-on-macos.txt

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,91 @@ Install on macOS
66

77
.. default-domain:: mongodb
88

9-
OSX install
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: twocols
14+
15+
.. |arrow| unicode:: U+27A4
16+
.. |edition| replace:: Enterprise
17+
.. |distro-name| replace:: macOS
18+
.. |package-manager| replace:: ``brew``
19+
.. |executable-name| replace:: ``mongod``
20+
.. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
21+
22+
Overview
23+
--------
24+
25+
Use this tutorial to manually install {+c2c-full-product-name+}
26+
{+version+} on macOS using a downloaded ``.tgz`` tarball.
27+
28+
.. bug in constant parser DOP-3025
29+
30+
{+c2c-product-name+} Version
31+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32+
33+
.. include:: /includes/fact-install-past-mongosync.rst
34+
35+
Considerations
36+
--------------
37+
38+
Consider the following when running {+c2c-product-name+} on macOS:
39+
40+
Platform Support
41+
~~~~~~~~~~~~~~~~
42+
43+
{+c2c-full-product-name+} {+version+} supports macOS 10.14 or later.
44+
45+
Version Requirements
46+
~~~~~~~~~~~~~~~~~~~~
47+
48+
.. include:: /includes/fact-mongodb-version.rst
49+
50+
.. bug in constant parser DOP-3025
51+
52+
Install {+c2c-product-name+}
53+
-------------------------------
54+
55+
Follow these steps to manually install {+c2c-product-name+} from
56+
the ``.tgz``.
57+
58+
.. procedure::
59+
:style: normal
60+
61+
.. step:: Download the tarball.
62+
63+
Download the {+c2c-product-name+} ``.tgz`` tarball from the following
64+
link:
65+
66+
|arrow| |mdb-download-link|
67+
68+
a. In the :guilabel:`Version` dropdown, select the version of
69+
{+c2c-product-name+} to download.
70+
71+
#. In the :guilabel:`Platform` dropdown, select :guilabel:`macOS`.
72+
73+
#. In the :guilabel:`Package` dropdown, select :guilabel:`shell (tgz)`.
74+
75+
#. Click :guilabel:`Download`.
76+
77+
.. step:: Extract the files from the downloaded archive.
78+
79+
To extract ``mongosync``, use the ``tar`` command in a system
80+
shell:
81+
82+
.. code-block:: bash
83+
84+
tar -zxvf mongosync-*.tgz
85+
86+
.. step:: Ensure the binary is in a directory listed in your ``PATH`` environment variable.
87+
88+
.. include:: /includes/step-update-path.rst
89+
90+
.. bug in constant parser DOP-3025
91+
92+
Run {+c2c-product-name+}
93+
---------------------------
94+
95+
.. include:: /includes/run-c2c.rst
1096

‎source/installation/install-on-windows.txt

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)