Skip to content

Commit 5f53b0f

Browse files
ianf-mongodbjeff-allen-mongo
ianf-mongodb
and
jeff-allen-mongo
authored
DOCSP-33790 Deployment Considerations Content (#136)
* DOCSP-33790 Deployment Considerations Content * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Apply suggestions from code review Co-authored-by: Jeff Allen <[email protected]> * * * * * * * * * * * * * * * * * * * * * * * * * * * Apply suggestions from code review Co-authored-by: Jeff Allen <[email protected]> * * * * * * * * * * * netlify rebase * * * * * * * * * * * * * * * * * * --------- Co-authored-by: Jeff Allen <[email protected]>
1 parent 670b150 commit 5f53b0f

File tree

4 files changed

+184
-1
lines changed

4 files changed

+184
-1
lines changed

‎snooty.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ toc_landing_pages = [
3737
"diagrams/manage-diagrams",
3838
"getting-started",
3939
"jobs/prerequisites",
40-
"api-docs"
40+
"api-docs",
41+
"deployment-considerations"
4142
]
4243

4344
[constants]

‎source/installation.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ For instructions on installing Relational Migrator, see the following pages:
6868
:hidden:
6969
:titlesonly:
7070

71+
/installation/system-requirements
72+
/installation/deployment-considerations
7173
/installation/install-on-a-local-machine/install-on-a-local-machine
7274
/installation/install-on-an-unattended-server/install-on-an-unattended-server
7375
/installation/kafka-deployments/migrator-with-kafka

‎source/installation/deployment-considerations.txt

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
.. _rm-deployment-considerations:
2+
3+
=========================
4+
Deployment Considerations
5+
=========================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
In the context of Relational Migrator, deployment considerations refers
14+
to where the servers, networking equipment, and databases are located.
15+
This page outlines location specific details to consider when using
16+
Relational Migrator.
17+
18+
How to Run Relational Migrator
19+
------------------------------
20+
21+
The following table outlines high-level recommendations for how to
22+
run Relational Migrator. Also note that the
23+
:ref:`Kafka deployment model <kafka-intro>` provides greater
24+
resilience and scalability and can be used with any of the
25+
deployment options.
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 40 60
30+
31+
* - Use case
32+
- Recommended environment
33+
34+
* - Smaller scale or debugging and testing jobs that run for
35+
less than four hours.
36+
- Laptop / Desktop / Docker
37+
38+
* - Larger scale production jobs that run for more than four
39+
hours.
40+
- Remote server / EC2 / Azure VM
41+
42+
Where to Run Relational Migrator
43+
--------------------------------
44+
45+
For best performance, locate the machine or server running Relational
46+
Migrator as geographically close to the source and target databases as
47+
possible. Proximity to the target database influences performance
48+
the most:
49+
50+
- If you're using Relational Migrator for an on-premises migration,
51+
run Relational Migrator in the same data center as the source
52+
database.
53+
54+
- If you're using a cloud hosted database, run Relational
55+
Migrator on an EC2 instance or VM in the same
56+
:abbr:`VPC (Virtual Private Cloud)` as the source database.
57+
58+
.. tip::
59+
60+
Check the sleep timeout setting for your operating system. If your
61+
machine goes to sleep during a migration, the sync job fails.
62+
63+
Network Considerations
64+
----------------------
65+
66+
When using Relational Migrator, the system firewall on the machine or
67+
server must allow outbound TCP traffic to both the source and
68+
destination databases.
69+
70+
Cloud Networking
71+
~~~~~~~~~~~~~~~~
72+
73+
When running Relational Migrator in a cloud environment, check the
74+
cloud specific firewall (security group), router table, and
75+
the server firewall configurations. For details on specific cloud
76+
provider network configurations, see these pages:
77+
78+
- `AWS Networking <https://docs.aws.amazon.com/vpc/>`__
79+
- `Azure Networking <https://azure.microsoft.com/en-us/products/category/networking>`__
80+
- `GCP Networking <https://cloud.google.com/vpc/docs>`__
81+
82+
System Hardware
83+
---------------
84+
85+
For specific hardware recommendations, see :ref:`rm-system-requirements`.
86+
87+
.. note::
88+
89+
Scaling up the Atlas cluster size can significantly improve migration
90+
speeds. For details, see :ref:`scale-cluster-instance`.
91+
92+
Get Started
93+
-----------
94+
95+
For detailed installation instructions, see :ref:`installation`.

‎source/installation/system-requirements.txt

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
.. _rm-system-requirements:
2+
3+
===================
4+
System Requirements
5+
===================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
The following page outlines the system requirements for using Relational
14+
Migrator. For additional details on where to run Relation Migrator, see
15+
:ref:`rm-deployment-considerations`.
16+
17+
Hardware
18+
--------
19+
20+
You can run Relational Migrator in multiple ways:
21+
22+
- Computer (can be a local desktop/labtop)
23+
- Remote server (EC2, Azure VM, or Google compute engine instance)
24+
- Virtual Machine
25+
- Docker Container
26+
27+
28+
.. note:
29+
30+
To use Relational Migrator, you must access the application through a web
31+
browser, this requires:
32+
33+
- Loading a browser on the machine running RM
34+
(locally or using Windows RDP or similar).
35+
- Accessing remotely, which requires configuring RM in
36+
Unattended mode.
37+
38+
Memory
39+
------
40+
41+
The machine running the Relational Migrator application requires a
42+
minimum of 8GB of RAM. For best performance, we recommend having 16GB
43+
of RAM or more.
44+
45+
Network
46+
-------
47+
48+
Deploy Relational Migrator to a location close to the destination
49+
databases to maximize bandwidth and minimize latency.
50+
51+
Operating System
52+
----------------
53+
54+
You can run Relational Migrator on any of the following operating
55+
systems:
56+
57+
- Windows 10 or higher
58+
- Windows Server 2016 or higher
59+
- MacOS 11 or higher (Intel or ARM)
60+
- Linux - Debian / Ubuntu
61+
- Linux - Redhat / CentOS
62+
- Docker
63+
64+
Web Browser
65+
-----------
66+
67+
You can use Relational Migrator in any of the latest versions of
68+
web browsers:
69+
70+
- Chrome (or Chromium-based browsers)
71+
- Edge
72+
- Firefox
73+
- Safari
74+
75+
Kafka Deployments
76+
-----------------
77+
78+
You can optionally use Kafka for long-running sync jobs. For details.
79+
see :ref:`kafka-intro`.
80+
81+
Supported Databases
82+
-------------------
83+
84+
- :ref:`supported-databases`
85+
- :ref:`rm-prerequisites`

0 commit comments

Comments
 (0)