Skip to content

Commit af3c0b2

Browse files
jocelyn-mendez1jocelyn-mendez1
authored
DOCSP-30416 Unattended install migration (#14)
* DOCSP-30416 unattended server install * DOCSP-30416 window server install * DOCSP-30416 window server install * DOCSP-30416 install windows * DOCSP-30416 external access and install fix * DOCSP-30416 system service and install fix * DOCSP-30416 system service fix * DOCSP-30416 system service fix and rhel server * DOCSP-30416 rhel server install * DOCSP-30416 rhel server install * DOCSP-30416 rhel system service * DOCSP-30416 debian os * DOCSP-30416 debian os * DOCSP-30416 debian install * DOCSP-30416 debian system * DOCSP-30416 remove procedure * DOCSP-30416 remove procedure * DOCSP-30416 fix build errors * DOCSP-30416 feedback * DOCSP-30416 feedback
1 parent b15b263 commit af3c0b2

File tree

14 files changed

+665
-14
lines changed

14 files changed

+665
-14
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _single-machine-install:
2+
13
================================
24
Installation on a Single Machine
35
================================
@@ -19,4 +21,4 @@ TBD.
1921
/installation/install-on-a-single-machine/install-windows
2022
/installation/install-on-a-single-machine/install-mac
2123
/installation/install-on-a-single-machine/install-ubuntu
22-
/installation/install-on-a-single-machine/install-rhel
24+
/installation/install-on-a-single-machine/install-rhel

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _single-windows:
2+
13
===============
24
Install Windows
35
===============

‎source/installation/install-on-an-unattended-server/debian-server-installation/debian-server-installation.txt

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
1+
.. _debian-install:
2+
13
===========================
24
Debian Systems Installation
35
===========================
46

5-
TBD.
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Install Relational Migrator on an unattended server in a Linux systems. For instructions
16+
on installation and configuration, see the installation tasks.
17+
18+
Get Started
19+
-----------
20+
21+
- :ref:`Install on Debian <install-debian-server>`
22+
23+
- :ref:`Run Relational Migrator as a System Service on Debian <debian-system-service>`
624

725

826
.. toctree::
927
:hidden:
1028
:titlesonly:
1129

1230
/installation/install-on-an-unattended-server/debian-server-installation/install-debian-server
13-
/installation/install-on-an-unattended-server/debian-server-installation/debian-system-service
31+
/installation/install-on-an-unattended-server/debian-server-installation/debian-system-service

‎source/installation/install-on-an-unattended-server/debian-server-installation/debian-system-service.txt

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,66 @@
1+
.. _debian-system-service:
2+
13
=====================================================
24
Run Relational Migrator as a System Service on Debian
35
=====================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
When you install Relational Migrator on a Debian server, you can also set up
16+
Relational Migrator to run as a system service. By running Relational Migrator as
17+
a system service, Relational Migrator automatically starts when the server starts.
18+
19+
Steps
20+
-----
21+
22+
1. Create a ``/etc/systemd/system/migrator.service`` file.
23+
24+
Copy the text below into the ``/etc/systemd/system/migrator.service`` file. Replace
25+
the binary path as needed.
26+
27+
.. code-block::
28+
29+
[Unit]
30+
Description=MongoDB Relational Migrator
31+
32+
[Service]
33+
ExecStart="/opt/mongodb-relational-migrator/bin/MongoDB Relational Migrator
34+
35+
[Install]
36+
WantedBy=multi-user.target
37+
38+
#. Reload ``systemd`` to read the newly created service.
39+
40+
.. code-block::
41+
42+
systemctl daemon-reload
43+
44+
#. Enable the Relational Migrator service to automatically start when the server starts.
45+
46+
You can manage the service with the following ``systemctl`` commands:
47+
48+
.. code-block::
49+
50+
systemctl enable migrator.service
51+
52+
systemctl start migrator.service
53+
54+
Next Steps
55+
----------
56+
57+
- :ref:`Create a Project <rm-create-project-live>`
58+
59+
- :ref:`Import a Project <import-project>`
60+
61+
Learn More
62+
----------
63+
64+
- :ref:`RHEL/CentOS Systems Installation <rhel-install>`
65+
66+
- :ref:`Windows Server Installation <windows-install>`

‎source/installation/install-on-an-unattended-server/debian-server-installation/install-debian-server.txt

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,116 @@
1+
.. _install-debian-server:
2+
13
=================
24
Install On Debian
35
=================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can install Relational Migrator on a Debian server. This installation method
16+
allows Relational Migrator to run on an unattended server. By running on an
17+
unattended server, Relational Migrator binds to any IP and port on the server
18+
and is exposes it as a web application.
19+
20+
Steps
21+
-----
22+
23+
1. Download the latest ``.deb`` binary from the `release page <https://migrator-installer-repository.s3.ap-southeast-2.amazonaws.com/index.html>`__.
24+
25+
#. Install Relational Migrator.
26+
27+
.. code-block:: bash
28+
29+
sudo apt install ./mongodb-relational-migrator_X.X.X-1_amd64.deb
30+
31+
#. Change the directory to the Relational Migrator ``app/lib`` location.
32+
33+
.. code-block:: bash
34+
35+
cd /opt/mongodb-relational-migrator/lib/app/lib
36+
37+
#. (Optional) To connect to Oracle or MySQL drivers, download and place the drivers
38+
into your Relational Migrator directory.
39+
40+
a. To download and install MySQL or Oracle drivers, see the following:
41+
42+
- `MySQL: latest 8.0.x version, Platform Independent Version <https://dev.mysql.com/downloads/connector/j/>`_
43+
44+
- `Oracle: 21.6.0.0 of odjbc11.jar from the Oracle 21c <https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html>`_
45+
46+
b. Copy the driver files to ``/opt/mongodb-relational-migrator/lib/app/lib``.
47+
48+
To copy the driver, use the following example:
49+
50+
.. code-block:: bash
51+
52+
curl https://download.oracle.com/otn-pub/otn_software/jdbc/216/ojdbc11.jar -O -L -b -o
53+
54+
For more information, see :ref:`Install on a Single Machine <single-machine-install>`.
55+
56+
#. Change the directory to the Relational Migrator ``/bin`` location and start the application.
57+
58+
.. code-block:: bash
59+
60+
cd /opt/mongodb-relational-migrator/bin
61+
62+
./mongodb-relational-migrator
63+
64+
#. Enable Relational Migrator to run as an unattended standalone server.
65+
66+
In your ``user.properties`` file, uncomment ``spring.profiles.active: unattended``.
67+
68+
#. (Optional) Update TLS/SSL configuration properties.
69+
70+
In your ``user.properties`` file, uncomment and update TLS/SSL configuration
71+
properties.
72+
73+
It is recommended that the unattended server installation is supplemented with
74+
TLS/SSL configuration because Relational Migrator can be bound to any IP and port on
75+
the server. For additional information, see `TLS/SSL Configuration Properties <https://docs.spring.io/spring-cloud-skipper/docs/2.8.4/reference/htmlsingle/#configuration-security-enabling-https>`__.
76+
77+
#. (Optional) Update the port that Relational Migrator runs on.
78+
79+
By default, Relational Migrator is configured to run on port 8278. To change
80+
the port Relational Migrator runs on (for example to port 80 for HTTP or port 443 for
81+
HTTPS), update the ``server.port`` line in your ``user.properties`` file to specify
82+
your preferred port.
83+
84+
#. Run Relational Migrator using the binary.
85+
86+
The ``bin`` directory can typically be found at ``/opt/mongodb-relational-migrator/bin``.
87+
To run Relational Migrator using the binary, run the following:
88+
89+
.. code-block:: bash
90+
91+
cd /opt/mongodb-relational-migrator/bin
92+
93+
./mongodb-relational-migrator
94+
95+
#. (Optional) Check logs for errors or other information.
96+
97+
- The logs are located in ``~/Migrator/Logs/migrator.log``.
98+
99+
- When running Relational Migrator as a system service, the path is under
100+
the service user’s home directory.
101+
102+
Next Steps
103+
----------
104+
105+
- :ref:`Run Relational Migrator as a System Service on Debian <debian-system-service>`
106+
107+
- :ref:`Create a Project <rm-create-project-live>`
108+
109+
- :ref:`Import a Project <import-project>`
110+
111+
Learn More
112+
----------
113+
114+
- :ref:`RHEL/CentOS Systems Installation <rhel-install>`
115+
116+
- :ref:`Windows Server Installation <windows-install>`

‎source/installation/install-on-an-unattended-server/install-on-an-unattended-server.txt

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,61 @@
1+
.. _unattended-server:
2+
13
====================================
24
Installation on an Unattended Server
35
====================================
46

5-
TBD.
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can install Relational Migrator on an unattended server on both Linux
16+
and Windows systems. The unattended server installation binds Relational
17+
Migrator to any IP and port on the server and exposes it as a web application.
18+
19+
Use Case
20+
--------
21+
22+
Installing Relational Migrator on an unattended server is ideal for larger
23+
production-scale migration projects.
24+
25+
Behavior
26+
--------
27+
28+
- It is recommended that the unattended server installation is supplemented with
29+
TLS/SSL configuration because Relational Migrator can be bound to any IP and port on
30+
the server.
31+
32+
- When you install Relational Migrator on an unattended server, you can set up
33+
Relational Migrator to run as a system service. As a system service, Relational
34+
Migrator automatically starts when the server starts.
35+
36+
- When you install Relational Migrator on an unattended server, you can enable
37+
external access to Relational Migrator on Windows. By enabling external access,
38+
incoming connections are allowed on the same port as Relational Migrator.
39+
40+
Get Started
41+
-----------
42+
43+
- :ref:`Windows Server Installation <windows-install>`
44+
45+
- :ref:`RHEL/CentOS Server Installation <rhel-install>`
46+
47+
- :ref:`Debian Server Installation <debian-install>`
48+
49+
Learn More
50+
----------
51+
52+
- :ref:`Install on a Single Machine <single-machine-install>`
53+
654

755
.. toctree::
856
:titlesonly:
957
:hidden:
1058

1159
/installation/install-on-an-unattended-server/windows-server-installation/windows-server-installation
1260
/installation/install-on-an-unattended-server/rhel-centos-server-installation/rhel-centos-server-installation
13-
/installation/install-on-an-unattended-server/debian-server-installation/debian-server-installation
61+
/installation/install-on-an-unattended-server/debian-server-installation/debian-server-installation

0 commit comments

Comments
 (0)