Skip to content

Commit f915258

Browse files
DOCSP-38445 Stage and final walkthrough for kafka docs feature branch (#114)
* DOCSP-37087 concept page and toc set up * DOCSP-37087 update snooty file * DOCSP-37087 reword * DOCSP-37087 remove sentence * DOCSP-37087 reword * DOCSP-37087 nit * DOCSP-37087 add image * DOCSP-37087 sarah feedback * DOCSP-35193 add steps * DOCSP-35193 add steps * DOCSP-35193 fix steps * DOCSP-35193 fix steps * DOCSP-35193 writing updates * DOCSP-35193 writing updates * DOCSP-37087 sarah feedback * DOCSP-37087 tom feedback * DOCSP-37087 david feedback * DOCSP-37087 david feedback * DOCSP-37087 update this PR according to separate confluent PR * DOCSP-35309 add Kafka to intro installation page * DOCSP-35309 remove reference section * DOCSP-35309 writing updates * DOCSP-35309 grammar change * DOCSP-35309 ian feedback * DOCSP-35309 writing * DOCSP-35309 writing * DOCSP-35309 update single machine to local * DOCSP-35309 fix build errors * DOCSP-35309 david feedback * DOCSP-35309 david feedback * DOCSP-35309 pull rebase updates * DOCSP-37088 save changes * DOCSP-37088 save changes * DOCSP-37088 add final steps * DOCSP-37088 intro update * DOCSP-37088 staging fixes * DOCSP-37088 fix staging * DOCSP-37088 fix staging * DOCSP-37088 update steps * DOCSP-37088 update steps * DOCSP-37088 update steps * DOCSP-37088 update steps * DOCSP-37088 update steps * DOCSP-37088 internal feedback * DOCSP-37088 internal feedback * DOCSP-37088 nit change * DOCSP-37088 typo * DOCSP-37088 add next steps * DOCSP-37088 ian feedback * DOCSP-37088 table adjustments * DOCSP-35193-new Install with Confluent Cloud Deployment method (#106) * DOCSP-35193 add steps * DOCSP-35193 learn more * DOCSP-35356 ali feedback * DOCSP-35193 fix branch * DOCSP-35193 fix branch * DOCSP-35193-new fix files * DOCSP-35193-new fix build errors * DOCSP-35193-new fix build errors * DOCSP-35193-new fix build errors * DOCSP-35193-new * DOCSP-35193-new fix toc * DOCSP-35193-new fix image * DOCSP-35193-new fix step * DOCSP-35193-new fix build error * DOCSP-35193-new add next steps * DOCSP-35193-new add next steps * DOCSP-35193-new nit fix * DOCSP-35193 ian feedback * DOCSP-3519-new ian feedback * DOCSP-35193-new ian feedback * DOCSP-35193-new david feedback * DOCSP-35193-new ashley feedback * DOCSP-35193-new ashley feedback * DOCSP-35193-new ashley feedback * DOCSP-35325 Kafka CDC Updates To Sync Job Content (#105) * DOCSP-35325 Kafka CDC Updates To Sync Job Content * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Apply suggestions from code review Co-authored-by: jocelyn-mendez1 <[email protected]> * * * Apply suggestions from code review Co-authored-by: jocelyn-mendez1 <[email protected]> * * * * --------- Co-authored-by: jocelyn-mendez1 <[email protected]> * DOCSP-37918 Add Kafka Install Links (#111) * DOCSP-37918 Add Kafka Install Links * DOCSP-37090 tables * DOCSP-37090 glossary test * DOCSP-37090 adjust glossary * DOCSP-37090 save changes * DOCSP-37090 updated glossary * DOCSP-37090 fix typos * DOCSP-37090 fix typos * DOCSP-37090 clean up * DOCSP-37090 clean up * DOCSP-37090 matt feedback * DOCSP-37090 add examples * DOCSP-37090 add examples * DOCSP-37090 nit fixes * DOCSP-37090 nit fixes * DOCSP-37090 nit fixes * DOCSP-37090 nit fixes * DOCSP-37089-new Install with Docker task page (#101) * DOCSP-37089-new fix branch * DOCSP-37089-new nit fix * DOCSP-37089 add behavioral data * DOCSP-37089 nit fix * DOCSP-37089 nit fix * DOCSP-37089-new nick feedback * DOCSP-37089-new tom feedback * DOCSP-37089-new nit changes * DOCSP-37089-new nit changes * DOCSP-37089-new nit changes * DOCSP-37089-ne updates * DOCSP-37089-new updates * DOCSP-37089-ne new instructions * DOCSP-37089-new typo fix * DOCSP-37089-new nit fixes * DOCSP-38445 remove db2 and stage * DOCSP-38445 build errors * DOCSP-38445 david feedback * DOCSP-38445 nit fix * DOCSP-38445 nit fix --------- Co-authored-by: ianf-mongodb <[email protected]>
1 parent 91e0244 commit f915258

29 files changed

+1021
-126
lines changed

snooty.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
1111
toc_landing_pages = [
1212
"supported-databases",
1313
"installation",
14-
"installation/install-on-a-single-machine/install-on-a-single-machine",
14+
"installation/install-on-a-local-machine/install-on-a-local-machine",
1515
"installation/install-on-an-unattended-server/install-on-an-unattended-server",
1616
"installation/install-on-an-unattended-server/debian-server-installation/debian-server-installation",
1717
"installation/install-on-an-unattended-server/windows-server-installation/windows-server-installation",
1818
"installation/install-on-an-unattended-server/rhel-centos-server-installation/rhel-centos-server-installation",
19+
"installation/kafka-deployments/migrator-with-kafka",
1920
"installation/file-location",
2021
"projects/projects",
2122
"mapping-rules/mapping-rules",

source/getting-started.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Steps
3737
.. step:: Install
3838

3939
You can install Relational Migrator with a
40-
:ref:`single machine install <single-machine-install>` suitable
40+
:ref:`single machine install <local-machine-install>` suitable
4141
for testing or a :ref:`unattended server install <unattended-server>`
4242
for production workloads.
4343

267 KB
Loading
19.4 KB
Loading

source/img/kafka/kafka-behavior.png

93.1 KB
Loading
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- Continuous sync jobs using Confluent Cloud Kafka may take additional
2+
time due to the provisioning of backend resources on Confluent Cloud.
3+
This process typically takes an additional two to five
4+
minutes the first time a CDC sync job runs.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This task also applies to Apache Kafka supported
2+
continuous sync jobs. There is no procedural difference introduced when
3+
using Kafka. For more details, see :ref:`kafka-intro`.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:width: 40 15 45
4+
5+
* - Property Name
6+
- Default
7+
- Description
8+
9+
* - ``spring.profiles.active``
10+
- local
11+
- Relational Migrator can be run in the following profile:
12+
13+
- ``kafka``: Remote server using embedded server deployment.
14+
- ``confluent``: Remote server using Confluent Cloud for managed Kafka
15+
16+
Set the profile value to ``kafka``.
17+
18+
* - ``server.port``
19+
- 8278
20+
- The port the Relation Migrator application runs on.
21+
22+
* - ``migrator.kafka.bootstrap.servers``
23+
- No default
24+
- This is a list of ``host:port`` pairs of your pre-existing kafka cluster.
25+
26+
For more information, see `Worker Configuration Properties
27+
<https://docs.confluent.io/platform/current/connect/userguide.html#worker-configuration-properties-file>`__.
28+
29+
* - ``migrator.kafka.connect.url``
30+
- No default
31+
- The Kafka Connect host url using the ``{host}:{port}`` format.
32+
33+
* - ``migrator.kafka.connect.metrics.jmx.service.url``
34+
- No default
35+
- The Kafka Connect Java Management Extensions (JMX) url.
36+
37+
For example: ``service:jmx:rmi:///jndi/rmi://localhost:9876/jmxrmi``

source/installation.txt

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,41 +20,56 @@ For instructions on installing Relational Migrator, see the following pages:
2020

2121
- Description
2222

23-
- Reference
24-
2523
* - Local
2624

27-
- Suitable for evaluation and proof of concept jobs.
25+
- Suitable for evaluation and proof of concept jobs.
2826

29-
- :ref:`Install on a Single Machine <single-machine-install>`
27+
For more information, see :ref:`Install on a Local Machine
28+
<local-machine-install>`.
3029

3130
* - Unattended server
3231

33-
- Suitable for smaller production jobs.
34-
35-
- :ref:`Install on an Unattended Server <unattended-server>`
32+
- Suitable for smaller production jobs.
33+
34+
For more information, see :ref:`Install on an Unattended Server
35+
<unattended-server>`.
3636

3737
* - Docker
3838

3939
- Suitable if your familiar with Docker and don't want to run
4040
Relational Migrator directly on a server or machine.
4141

42-
- :ref:`Install with Docker <rm-install-docker>`
42+
For more information, see :ref:`Install with Docker <rm-install-docker>`.
4343

4444
* - Kafka
4545

46-
- Suitable for larger production jobs. Integrates with your own Kafka
47-
infrastructure to provide enhanced resiliency.
46+
- The Kafka deployment method is suitable for long-running Change Data
47+
Capture (CDC) sync jobs and large data migrations that exceed 4 weeks in
48+
duration or involve databases larger than 20GB. `Apache Kafka
49+
<https://kafka.apache.org/>`__ is an open-source platform for distributed
50+
workloads that offers high availability and automatic recovery. This is the
51+
most advanced option that is intended for users who require long-running or
52+
large production data migrations.
53+
54+
For more information, see :ref:`kafka-intro`.
55+
56+
* - Kafka with Confluent Cloud
57+
58+
- The Kafka with Confluent Cloud deployment method is an option for users who
59+
want the reliability of Kafka without having to manage their own cluster.
60+
`Confluent <https://www.confluent.io/>`__ is a fully-managed Kafka hosting
61+
provider run by the founders of Kafka. This deployment method uses APIs to
62+
add the newest Relational Migrator sink connectors to Confluent Cloud as
63+
managed connectors.
4864

49-
- The Kafka deployment model is not yet generally available, but you can
50-
reach out to your MongoDB account team to discuss private preview
51-
opportunities.
65+
For more information, see :ref:`install-confluent-kafka`.
5266

5367
.. toctree::
5468
:hidden:
5569
:titlesonly:
5670

57-
/installation/install-on-a-single-machine/install-on-a-single-machine
71+
/installation/install-on-a-local-machine/install-on-a-local-machine
5872
/installation/install-on-an-unattended-server/install-on-an-unattended-server
73+
/installation/kafka-deployments/migrator-with-kafka
5974
/installation/install-with-docker
6075
/installation/file-location

source/installation/file-location.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,6 @@ The file locations for the Linux OS:
7171
Learn More
7272
----------
7373

74-
- :ref:`Installation on a Single Machine <single-machine-install>`
74+
- :ref:`Installation on a Local Machine <local-machine-install>`
7575

7676
- :ref:`Installation on an Unattended Server <unattended-server>`

0 commit comments

Comments
 (0)