Skip to content

Commit 80affbf

Browse files
jocelyn-mendez1jocelyn-mendez1
authored
DOCSP-30415 Single machine install migration (#12)
* DOCSP-30415 install windows * DOCSP-30415 update refs * DOCSP-30415 update refs * DOCSP-30415 ubuntu install * DOCSP-30415 ubuntu install * DOCSP-30415 ubuntu install * DOCSP-30415 update ubuntu * DOCSP-30415 update rhel * DOCSP-30415 update mac * DOCSP-30415 add single install * DOCSP-30415 add single install * DOCSP-30415 fix build errors * DOCSP-30415 add installation page * DOCSP-30415 remove procedure * DOCSP-30415 fix build errors * DOCSP-30415 feedback * DOCSP-30415 feedback
1 parent af3c0b2 commit 80affbf

File tree

6 files changed

+353
-18
lines changed

6 files changed

+353
-18
lines changed

‎source/installation.txt

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,50 @@
1+
.. _installation:
2+
13
============
24
Installation
35
============
46

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Relational Migrator supports local deployment and unattended server deployment models.
14+
For instructions on installing Relational Migrator, see the following pages:
15+
16+
.. list-table::
17+
:header-rows: 1
18+
19+
* - Deployment Model
20+
21+
- Description
22+
23+
- Reference
24+
25+
* - Local
26+
27+
- Suitable for evaluation and proof of concept jobs.
28+
29+
- :ref:`Install on a Single Machine <single-machine-install>`
30+
31+
* - Unattended server
32+
33+
- Suitable for smaller production jobs.
34+
35+
- :ref:`Install on an Unattended Server <unattended-server>`
36+
37+
* - Kafka
38+
39+
- Suitable for larger production jobs. Integrates with your own Kafka infrastructure
40+
to provide enhanced resiliency.
41+
42+
- The Kafka deployment model is not yet generally available, but you can
43+
reach out to your MongoDB account team to discuss early access opportunities.
44+
545
.. toctree::
646
:hidden:
747
:titlesonly:
848

949
/installation/install-on-a-single-machine/install-on-a-single-machine
10-
/installation/install-on-an-unattended-server/install-on-an-unattended-server
50+
/installation/install-on-an-unattended-server/install-on-an-unattended-server

‎source/installation/install-on-a-single-machine/install-mac.txt

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,60 @@
1-
===========
2-
Install Mac
3-
===========
1+
.. _single-mac:
42

5-
TBD.
3+
==============
4+
Install on Mac
5+
==============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can install Relational Migrator on a single Mac machine. This
14+
installation method uses default settings and binds Relational Migrator to a single
15+
IP and port.
16+
17+
Steps
18+
-----
19+
20+
1. Download the latest MacOS Relational Migrator binary from the
21+
`release page <https://migrator-installer-repository.s3.ap-southeast-2.amazonaws.com/index.html>`__.
22+
23+
#. Double-click the ``MongoDB.Relational.Migrator-X.X.X.dmg`` file.
24+
25+
#. Drag the ``MongoDB Relational Migrator.app`` icon into the ``/Applications`` folder.
26+
27+
#. (Optional) To connect to Oracle or MySQL drivers, download and place the drivers into your Relational Migrator directory.
28+
29+
a. To download and install MySQL or Oracle drivers, see the following:
30+
31+
- `MySQL: latest 8.0.x version, Platform Independent Version <https://dev.mysql.com/downloads/connector/j/>`_
32+
33+
- `Oracle: 21.6.0.0 of odjbc11.jar from the Oracle 21c <https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html>`_
34+
35+
b. Copy the driver files to ``/Library/Application Support/MongoDB/Relational Migrator/Drivers``.
36+
37+
.. note::
38+
39+
Relational Migrator installs the JDBC drivers for SQL Server and PostgreSQL
40+
by default.
41+
42+
#. Open Launchpad and search for **MongoDB Relational Migrator**.
43+
44+
Double-click the Relational Migrator icon to start the application.
45+
46+
Next Steps
47+
----------
48+
49+
- :ref:`Create a Project <rm-create-project-live>`
50+
51+
- :ref:`Import a Project <import-project>`
52+
53+
Learn More
54+
----------
55+
56+
- :ref:`Install on RHEL/CentOS <single-rhel>`
57+
58+
- :ref:`Install on Ubuntu/Debian <single-ubuntu>`
59+
60+
- :ref:`Install on Windows <single-windows>`

‎source/installation/install-on-a-single-machine/install-on-a-single-machine.txt

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,51 @@ Installation on a Single Machine
1212
:depth: 1
1313
:class: singlecol
1414

15-
TBD.
15+
You can install Relational Migrator on a single machine. The single machine
16+
installation provides a simplified installation process by using default settings.
17+
This installation method is a "local" install because Relational Migrator
18+
cannot be externally accessed and is bound to a single IP and port.
19+
20+
Use Cases
21+
---------
22+
23+
Installing Migrator on a single machine is ideal for small developmental projects
24+
that do not require not external access.
25+
26+
Behavior
27+
--------
28+
29+
The JDBC drivers must be downloaded separately, and placed into a dedicated
30+
directory after Relational Migrator is installed. This is required to connect to
31+
your relational database. The JDBC driver directory is operating system specific
32+
and included in the installation instructions below.
33+
34+
If you are migrating from a MySQL database:
35+
36+
- Download the `latest 8.0.x version, Platform Independent Version <https://dev.mysql.com/downloads/connector/j/>`_.
37+
38+
- Unzip the downloaded file and copy the ``.jar`` file into the target folder.
39+
40+
If you are migrating from an Oracle database:
41+
42+
- Download `21.6.0.0 of odjbc11.jar from the Oracle 21c <https://www.oracle.com/database/technologies/appdev/jdbc-drivers-archive.html>`_.
43+
44+
Get Started
45+
-----------
46+
47+
- :ref:`Install on Windows <single-windows>`
48+
49+
- :ref:`Install on Mac <single-mac>`
50+
51+
- :ref:`Install on Ubuntu <single-ubuntu>`
52+
53+
- :ref:`Install on RHEL <single-rhel>`
54+
55+
Learn More
56+
----------
57+
58+
- :ref:`Install on an Unattended Server <unattended-server>`
59+
1660

1761
.. toctree::
1862
:hidden:

‎source/installation/install-on-a-single-machine/install-rhel.txt

Lines changed: 73 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,74 @@
1-
============
2-
Install RHEL
3-
============
1+
.. _single-rhel:
42

5-
TBD.
3+
===============
4+
Install on RHEL
5+
===============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can install Relational Migrator on a single RHEL/CentOS machine. This
14+
installation method uses default settings and binds Relational Migrator to a single
15+
IP and port.
16+
17+
Steps
18+
-----
19+
20+
1. Download the latest ``.deb`` binary from the
21+
`release page <https://migrator-installer-repository.s3.ap-southeast-2.amazonaws.com/index.html>`__.
22+
23+
#. Install Relational Migrator.
24+
25+
.. code-block:: bash
26+
27+
sudo yum install mongodb-relational-migrator-X.X.X-1.x86_64.rpm
28+
29+
#. Change the directory to the Relational Migrator ``app/lib`` location.
30+
31+
.. code-block:: bash
32+
33+
cd /opt/mongodb-relational-migrator/lib/app/lib
34+
35+
#. (Optional) To connect to Oracle or MySQL drivers, download and place the drivers
36+
into your Relational Migrator directory.
37+
38+
a. To download and install MySQL or Oracle drivers, see the following:
39+
40+
- `MySQL: latest 8.0.x version, Platform Independent Version <https://dev.mysql.com/downloads/connector/j/>`_
41+
42+
- `Oracle: 21.6.0.0 of odjbc11.jar from the Oracle 21c <https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html>`_
43+
44+
b. Copy the driver files to ``/opt/mongodb-relational-migrator/lib/app/lib``.
45+
46+
To copy the driver, use the following example:
47+
48+
.. code-block:: bash
49+
50+
curl https://download.oracle.com/otn-pub/otn_software/jdbc/216/ojdbc11.jar -O -L -b -o
51+
52+
#. Change the directory to the Relational Migrator ``/bin`` location and start the application.
53+
54+
.. code-block:: bash
55+
56+
cd /opt/mongodb-relational-migrator/bin
57+
58+
./mongodb-relational-migrator
59+
60+
Next Steps
61+
----------
62+
63+
- :ref:`Create a Project <rm-create-project-live>`
64+
65+
- :ref:`Import a Project <import-project>`
66+
67+
Learn More
68+
----------
69+
70+
- :ref:`Install on Mac <single-mac>`
71+
72+
- :ref:`Install on Ubuntu/Debian <single-ubuntu>`
73+
74+
- :ref:`Install on Windows <single-windows>`

‎source/installation/install-on-a-single-machine/install-ubuntu.txt

Lines changed: 74 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,75 @@
1-
==============
2-
Install Ubuntu
3-
==============
1+
.. _single-ubuntu:
2+
3+
=================
4+
Install on Ubuntu
5+
=================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can install Relational Migrator on a single Ubuntu or Debian machine. This
14+
installation method uses default settings and binds Relational Migrator to a single
15+
IP and port.
16+
17+
Steps
18+
-----
19+
20+
1. Download the latest ``.deb`` binary from the
21+
`release page <https://migrator-installer-repository.s3.ap-southeast-2.amazonaws.com/index.html>`__.
22+
23+
#. Install Relational Migrator.
24+
25+
.. code-block:: bash
26+
27+
sudo apt install ./mongodb-relational-migrator_X.X.X-1_amd64.deb
28+
29+
#. Change the directory to the Relational Migrator ``app/lib`` location.
30+
31+
.. code-block:: bash
32+
33+
cd /opt/mongodb-relational-migrator/lib/app/lib
34+
35+
#. (Optional) To connect to Oracle or MySQL drivers, download and place the drivers
36+
into your Relational Migrator directory.
37+
38+
a. To download and install MySQL or Oracle drivers, see the following:
39+
40+
- `MySQL: latest 8.0.x version, Platform Independent Version <https://dev.mysql.com/downloads/connector/j/>`_
41+
42+
- `Oracle: 21.6.0.0 of odjbc11.jar from the Oracle 21c <https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html>`_
43+
44+
b. Copy the driver files to ``/opt/mongodb-relational-migrator/lib/app/lib``.
45+
46+
To copy the driver, use the following example:
47+
48+
.. code-block:: bash
49+
50+
curl https://download.oracle.com/otn-pub/otn_software/jdbc/216/ojdbc11.jar -O -L -b -o
51+
52+
#. Change the directory to the Relational Migrator ``/bin`` location and start the application.
53+
54+
.. code-block:: bash
55+
56+
cd /opt/mongodb-relational-migrator/bin
57+
58+
./mongodb-relational-migrator
59+
60+
Next Steps
61+
----------
62+
63+
- :ref:`Create a Project <rm-create-project-live>`
64+
65+
- :ref:`Import a Project <import-project>`
66+
67+
Learn More
68+
----------
69+
70+
- :ref:`Install on Mac <single-mac>`
71+
72+
- :ref:`Install on RHEL/CentOS <single-rhel>`
73+
74+
- :ref:`Install on Windows <single-windows>`
475

5-
TBD.

‎source/installation/install-on-a-single-machine/install-windows.txt

Lines changed: 61 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,64 @@
11
.. _single-windows:
22

3-
===============
4-
Install Windows
5-
===============
3+
==================
4+
Install on Windows
5+
==================
66

7-
TBD.
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can install Relational Migrator on a single Windows machine. This installation
14+
method uses default settings and binds Relational Migrator to a single
15+
IP and port.
16+
17+
Steps
18+
-----
19+
20+
1. Download the latest Windows Relational Migrator binary from the
21+
`release page <https://migrator-installer-repository.s3.ap-southeast-2.amazonaws.com/index.html>`__.
22+
23+
#. Double-click the ``MongoDB Relational Migrator-X.X.X.msi`` file.
24+
25+
#. When you are prompted with the MongoDB :guilabel:`Relational Migrator Setup Wizard`,
26+
click :guilabel:`Next`.
27+
28+
Accept the license agreement and click :guilabel:`Next` to continue.
29+
30+
#. Click :guilabel:`Install` to start your Migrator installation.
31+
32+
#. Click :guilabel:`Finish` to exit the installer.
33+
34+
#. (Optional) To connect to Oracle or MySQL drivers, download and place the drivers
35+
into your Relational Migrator directory.
36+
37+
a. To download and install MySQL or Oracle drivers, see the following:
38+
39+
- `MySQL: latest 8.0.x version, Platform Independent Version <https://dev.mysql.com/downloads/connector/j/>`_
40+
41+
- `Oracle: 21.6.0.0 of odjbc11.jar from the Oracle 21c <https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html>`_
42+
43+
b. Copy the driver files to ``c:\Users\<username>\AppData\Local\MongoDB\Relational Migrator\Data\Drivers``.
44+
45+
.. note::
46+
47+
Relational Migrator installs the JDBC drivers for SQL Server and PostgreSQL by
48+
default.
49+
50+
Next Steps
51+
----------
52+
53+
- :ref:`Create a Project <rm-create-project-live>`
54+
55+
- :ref:`Import a Project <import-project>`
56+
57+
Learn More
58+
----------
59+
60+
- :ref:`Install on Mac <single-mac>`
61+
62+
- :ref:`Install on RHEL/CentOS <single-rhel>`
63+
64+
- :ref:`Install on Ubuntu/Debian <single-ubuntu>`

0 commit comments

Comments
 (0)