From 90b116a4d6140be751e226e756bbfbfb820524be Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Wed, 29 Jan 2025 14:35:33 -0500 Subject: [PATCH 01/11] (DOCSP-43999) Promo admonition. --- source/includes/atlas-sp.rst | 10 ++++++++++ source/index.txt | 14 +------------- 2 files changed, 11 insertions(+), 13 deletions(-) create mode 100644 source/includes/atlas-sp.rst diff --git a/source/includes/atlas-sp.rst b/source/includes/atlas-sp.rst new file mode 100644 index 00000000..4dd47c15 --- /dev/null +++ b/source/includes/atlas-sp.rst @@ -0,0 +1,10 @@ +.. note:: + + Consider using Atlas Stream Processing, which provides tooling to + continuously process streaming data, validate schemas, and + materialize views into either Atlas database collections or Apache + Kafka topics. + + To learn more about Atlas Stream Processing, see the + `Atlas Stream Processing `__ + product page or read the `docs `__. diff --git a/source/index.txt b/source/index.txt index a6a30851..2071b46b 100644 --- a/source/index.txt +++ b/source/index.txt @@ -47,19 +47,7 @@ offerings to host your {+kafka+} cluster and {+connector+}: - To learn more about the MongoDB Source Connector, read the `documentation `__. - To learn more about the MongoDB Sink Connector, read the `documentation `__. -.. note:: - - You can also use Atlas Stream Processing, which is a MongoDB-native way to - process streaming data by using the MongoDB Query API. It transforms the way - that developers build modern applications. - - Use Atlas Stream Processing to continuously process streaming data, - validate schemas, and materialize views into either Atlas database - collections or Apache Kafka topics. - - To learn more about Atlas Stream Processing, see the - `Atlas Stream Processing `__ - product page or read the `docs `__. +.. include:: /includes/atlas-sp.rst What's New ---------- From 2ead46b83fd874d8c9a80adb85be68e0694d44e8 Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Wed, 29 Jan 2025 15:03:49 -0500 Subject: [PATCH 02/11] (DOCSP-43999) Turn promo into inclusion. --- source/introduction.txt | 2 ++ source/migrate-from-kafka-connect-mongodb.txt | 2 ++ source/quick-start.txt | 2 ++ 3 files changed, 6 insertions(+) diff --git a/source/introduction.txt b/source/introduction.txt index f7aba52d..9f6cb7a1 100644 --- a/source/introduction.txt +++ b/source/introduction.txt @@ -20,3 +20,5 @@ Read the following sections to learn about the {+connector+}, {+kafka-connect+}, - :doc:`Connect to MongoDB ` - :doc:`Data Formats ` - :doc:`Converters ` + +.. include:: /includes/atlas-sp.rst diff --git a/source/migrate-from-kafka-connect-mongodb.txt b/source/migrate-from-kafka-connect-mongodb.txt index a29e2c3a..cac27a9c 100644 --- a/source/migrate-from-kafka-connect-mongodb.txt +++ b/source/migrate-from-kafka-connect-mongodb.txt @@ -12,6 +12,8 @@ The following sections list the changes you must make to your Kafka Connect sink connector configuration settings and custom classes to transition to the {+sink-connector+}. +.. include:: /includes/atlas-sp.rst + Update Configuration Settings ----------------------------- diff --git a/source/quick-start.txt b/source/quick-start.txt index 74a8edd0..1b43f6c1 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -17,6 +17,8 @@ .. meta:: :keywords: get started, tutorial, code example +.. include:: /includes/atlas-sp.rst + Overview -------- From 7d0f1aa68c0e2df9a704a707fe8a427f1ae5da41 Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Wed, 29 Jan 2025 15:04:55 -0500 Subject: [PATCH 03/11] (DOCSP-43999) Add include to two pages. --- source/sink-connector.txt | 2 ++ source/source-connector.txt | 2 ++ 2 files changed, 4 insertions(+) diff --git a/source/sink-connector.txt b/source/sink-connector.txt index f9f2456c..1b58cd95 100644 --- a/source/sink-connector.txt +++ b/source/sink-connector.txt @@ -17,6 +17,8 @@ Sink Connector :depth: 2 :class: singlecol +.. include:: /includes/atlas-sp.rst + Overview -------- diff --git a/source/source-connector.txt b/source/source-connector.txt index 4ae04e0e..f67bbae9 100644 --- a/source/source-connector.txt +++ b/source/source-connector.txt @@ -18,6 +18,8 @@ Source Connector :depth: 2 :class: singlecol +.. include:: /includes/atlas-sp.rst + Overview -------- From 548d10e628fb35d940f13baa513698ed90118d5e Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Tue, 18 Feb 2025 14:52:18 -0500 Subject: [PATCH 04/11] (DOCSP-43999) Feature Comparison - Initial draft of feature comparison page --- ...tor-atlas-stream-processing-comparison.txt | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 source/kafka-connector-atlas-stream-processing-comparison.txt diff --git a/source/kafka-connector-atlas-stream-processing-comparison.txt b/source/kafka-connector-atlas-stream-processing-comparison.txt new file mode 100644 index 00000000..9c97733f --- /dev/null +++ b/source/kafka-connector-atlas-stream-processing-comparison.txt @@ -0,0 +1,76 @@ +.. _kafka-connector-atlas-stream-processing-comparison: + +=================================================== +Compare Kafka Connector and Atlas Stream Processing +=================================================== + +.. toctree:: + :titlesonly: + :maxdepth: 2 + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +This page provides a comparison of the feature sets of the MongoDB +Kafka Connector and {+atlas-sp+} to help you identify which tool +best suits your use case. + +.. list-table:: + :header-rows: 1 + :widths: 20 40 40 + + * - Feature + - Kafka Connector + - Atlas Stream Processing + + * - Hosting + - Hosting required for your {+kafka+} cluster and the Kafka + Connector. Use partner services such as Confluent Cloud, Amazon + Managed Streaming, or Redpanda Cloud when possible. + - Hosting required for your {+kafka+} cluster. {+atlas-sp+} + hosts stream processors on your {+spi+}s. + + * - Installation + - Installation required either locally or on Confluent. + - No installation required. + + * - Connectivity Tooling + - MongoDB Java Driver required + - Connection managed by {+atlas-sp+} + + * - Streaming Data Processing + - No data processing capabilities. You must use or write external + tooling to process streaming data handled by Kafka Connector + - Available through the MongoDB aggregation framework, with + extensions specific to stream processing. + + * - Windowing + - No support for windowing. + - Support for highly configurable + :atlas:`windows ` + + * - Connection Type Support + - - Kafka clusters + - {+service+} databases + - {+service+} collections + - - Kafka clusters + - {+service+} {+clusters+} + - {+service+} databases + - {+service+} collections + - HTTPS + + * - Security Features + - - SSL/TLS + - X.509 + - {+aws+} |iam| + - User must develop all other authentication tools + - - SSL/TLS + - X.509 + - VPC Peering with {+aws+} + - Private Link with {+aws+} Confluent + - Private Link with {+aws+} MSK + - Private Link with |azure| Event Hub + From 62005c6144a23f89780b2a2da6d3c60e76c490f2 Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Tue, 18 Feb 2025 14:54:21 -0500 Subject: [PATCH 05/11] (DOCSP-43999) Add link from index. --- source/index.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/source/index.txt b/source/index.txt index 2071b46b..65a97bdd 100644 --- a/source/index.txt +++ b/source/index.txt @@ -18,6 +18,7 @@ MongoDB Kafka Connector Security and Authentication Monitoring Migrate from the Community Connector + Compare Kafka Connector and Atlas Stream Processing Troubleshooting How to Contribute Issues & Help From fd1c8426b8903b82e8b0bc2d30276a2191662067 Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Tue, 18 Feb 2025 15:02:58 -0500 Subject: [PATCH 06/11] (DOCSP-43999) Changes to support source constants - Add constant definitions to snooty.toml - Update Azure from substitution to source constant --- snooty.toml | 3 +++ source/kafka-connector-atlas-stream-processing-comparison.txt | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index 06d14a3a..1ef3c5a8 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,6 +25,8 @@ kafka-connect-long = "Confluent Kafka Connect" avro-long = "Apache Avro" avro = "Avro" avro-converter = "Kafka Connect Avro Converter (Avro Converter)" +aws = ":abbr:`AWS (Amazon Web Services)`" +azure = "Microsoft Azure" protobuf-converter = "Kafka Connect Protobuf Converter" json-schema-converter = "Kafka Connect JSON Schema Converter" connector_version = "1.14" @@ -34,6 +36,7 @@ connector_version_github_tag = "master" connector_kafka_version_major = "2" connector_kafka_version_minor = "6" connector_kafka_version_docs = "https://kafka.apache.org/{+connector_kafka_version_major+}{+connector_kafka_version_minor+}" +service = "Atlas" sink-connector = "MongoDB Kafka sink connector" source-connector = "MongoDB Kafka source connector" sink-connector-title = "MongoDB Kafka Sink Connector" diff --git a/source/kafka-connector-atlas-stream-processing-comparison.txt b/source/kafka-connector-atlas-stream-processing-comparison.txt index 9c97733f..31e413fc 100644 --- a/source/kafka-connector-atlas-stream-processing-comparison.txt +++ b/source/kafka-connector-atlas-stream-processing-comparison.txt @@ -72,5 +72,5 @@ best suits your use case. - VPC Peering with {+aws+} - Private Link with {+aws+} Confluent - Private Link with {+aws+} MSK - - Private Link with |azure| Event Hub + - Private Link with {+azure+} Event Hub From d6726e53b32d633ceb8fbab2b8a0bd678011a3e1 Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Tue, 4 Mar 2025 12:56:07 -0500 Subject: [PATCH 07/11] (DOCSP-43999) Content review. --- source/includes/atlas-sp.rst | 5 ++--- ...tor-atlas-stream-processing-comparison.txt | 19 ++++++++++++------- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/source/includes/atlas-sp.rst b/source/includes/atlas-sp.rst index 4dd47c15..9c99fc96 100644 --- a/source/includes/atlas-sp.rst +++ b/source/includes/atlas-sp.rst @@ -1,10 +1,9 @@ .. note:: - Consider using Atlas Stream Processing, which provides tooling to + Atlas Stream Processing provides MongoDB-native tooling to continuously process streaming data, validate schemas, and materialize views into either Atlas database collections or Apache Kafka topics. To learn more about Atlas Stream Processing, see the - `Atlas Stream Processing `__ - product page or read the `docs `__. + `documentation `__. diff --git a/source/kafka-connector-atlas-stream-processing-comparison.txt b/source/kafka-connector-atlas-stream-processing-comparison.txt index 31e413fc..15cd2937 100644 --- a/source/kafka-connector-atlas-stream-processing-comparison.txt +++ b/source/kafka-connector-atlas-stream-processing-comparison.txt @@ -30,27 +30,28 @@ best suits your use case. - Hosting required for your {+kafka+} cluster and the Kafka Connector. Use partner services such as Confluent Cloud, Amazon Managed Streaming, or Redpanda Cloud when possible. - - Hosting required for your {+kafka+} cluster. {+atlas-sp+} - hosts stream processors on your {+spi+}s. + - Stream processing functionality fully managed by {+service+}. + Hosting required for your {+kafka+} cluster. * - Installation - Installation required either locally or on Confluent. - No installation required. * - Connectivity Tooling - - MongoDB Java Driver required - - Connection managed by {+atlas-sp+} + - MongoDB Java Driver required. + - Connection managed by {+service+}. - * - Streaming Data Processing + * - Supported Stream Processing Capabilities - No data processing capabilities. You must use or write external tooling to process streaming data handled by Kafka Connector - Available through the MongoDB aggregation framework, with extensions specific to stream processing. * - Windowing - - No support for windowing. + - No support for windowing. You must manually configure windowing + with the Kafka Streams API or other external tooling. - Support for highly configurable - :atlas:`windows ` + :atlas:`windows `. * - Connection Type Support - - Kafka clusters @@ -74,3 +75,7 @@ best suits your use case. - Private Link with {+aws+} MSK - Private Link with {+azure+} Event Hub + * - Pricing + - Pricing dependent on your hosting provider. + - Hourly pricing managed by {+atlas-sp+} Typical costs + approximately 25% of the cost of the Kafka Connector. From cb5b34bd4f88b2430e3467cff998b8f3f577928e Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Tue, 4 Mar 2025 13:12:16 -0500 Subject: [PATCH 08/11] (DOCSP-43999) Fixing substitutions/source constants --- snooty.toml | 2 ++ source/kafka-connector-atlas-stream-processing-comparison.txt | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index 1ef3c5a8..0cc84953 100644 --- a/snooty.toml +++ b/snooty.toml @@ -16,6 +16,7 @@ toc_landing_pages = [ ] [constants] +atlas-sp = "Atlas Stream Processing" connector = "MongoDB Kafka Connector" connector-short = "Kafka Connector" connector-long = "MongoDB Connector for Apache Kafka" @@ -62,3 +63,4 @@ jmx-port-mapping = "35000" sandbox-directory = "kafka-edu/docs-examples/mongodb-kafka-base/" win-sandbox-directory = "kafka-edu\\docs-examples\\mongodb-kafka-base\\" cluster = "MongoDB cluster" +clusters = "MongoDB clusters" diff --git a/source/kafka-connector-atlas-stream-processing-comparison.txt b/source/kafka-connector-atlas-stream-processing-comparison.txt index 15cd2937..82c37519 100644 --- a/source/kafka-connector-atlas-stream-processing-comparison.txt +++ b/source/kafka-connector-atlas-stream-processing-comparison.txt @@ -66,7 +66,7 @@ best suits your use case. * - Security Features - - SSL/TLS - X.509 - - {+aws+} |iam| + - {+aws+} IAM - User must develop all other authentication tools - - SSL/TLS - X.509 From 1d13127d5192e02fb58caaf286e1b56bdc5aa9d4 Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Tue, 4 Mar 2025 13:31:15 -0500 Subject: [PATCH 09/11] (DOCSP-43999) Content review, pt. 2 --- .../kafka-connector-atlas-stream-processing-comparison.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/kafka-connector-atlas-stream-processing-comparison.txt b/source/kafka-connector-atlas-stream-processing-comparison.txt index 82c37519..5b2c89d7 100644 --- a/source/kafka-connector-atlas-stream-processing-comparison.txt +++ b/source/kafka-connector-atlas-stream-processing-comparison.txt @@ -42,8 +42,10 @@ best suits your use case. - Connection managed by {+service+}. * - Supported Stream Processing Capabilities - - No data processing capabilities. You must use or write external - tooling to process streaming data handled by Kafka Connector + - To process streaming data handled by Kafka Connector, you must + do one of the following: + - Extend the Kafka Connector with SMTs or custom Java + - Use or write external tooling - Available through the MongoDB aggregation framework, with extensions specific to stream processing. From f9c496bf8b6ac857bf92593a5cb9c3a9808eb65e Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Tue, 4 Mar 2025 16:25:52 -0500 Subject: [PATCH 10/11] (DOCSP-43999) Copy review. --- source/includes/atlas-sp.rst | 8 ++-- ...tor-atlas-stream-processing-comparison.txt | 40 +++++++++---------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/source/includes/atlas-sp.rst b/source/includes/atlas-sp.rst index 9c99fc96..7561ad35 100644 --- a/source/includes/atlas-sp.rst +++ b/source/includes/atlas-sp.rst @@ -1,9 +1,9 @@ .. note:: - Atlas Stream Processing provides MongoDB-native tooling to + {+atlas-sp+} provides MongoDB-native tooling to continuously process streaming data, validate schemas, and - materialize views into either Atlas database collections or Apache + materialize views into either {+service+} database collections or Apache Kafka topics. - To learn more about Atlas Stream Processing, see the - `documentation `__. + To learn more about {+atlas-sp+}, see |service| + `Stream Processing `__. diff --git a/source/kafka-connector-atlas-stream-processing-comparison.txt b/source/kafka-connector-atlas-stream-processing-comparison.txt index 5b2c89d7..60c79a17 100644 --- a/source/kafka-connector-atlas-stream-processing-comparison.txt +++ b/source/kafka-connector-atlas-stream-processing-comparison.txt @@ -1,7 +1,7 @@ .. _kafka-connector-atlas-stream-processing-comparison: =================================================== -Compare Kafka Connector and Atlas Stream Processing +Compare {+connector-short+} and {+atlas-sp+} =================================================== .. toctree:: @@ -14,8 +14,8 @@ Compare Kafka Connector and Atlas Stream Processing :depth: 2 :class: singlecol -This page provides a comparison of the feature sets of the MongoDB -Kafka Connector and {+atlas-sp+} to help you identify which tool +This section provides a comparison of the feature sets of the MongoDB +{+connector-short+} and {+atlas-sp+} to help you identify which tool best suits your use case. .. list-table:: @@ -23,15 +23,16 @@ best suits your use case. :widths: 20 40 40 * - Feature - - Kafka Connector - - Atlas Stream Processing + - {+connector-short+} + - {+atlas-sp+} - * - Hosting - - Hosting required for your {+kafka+} cluster and the Kafka - Connector. Use partner services such as Confluent Cloud, Amazon - Managed Streaming, or Redpanda Cloud when possible. - - Stream processing functionality fully managed by {+service+}. - Hosting required for your {+kafka+} cluster. + * - Supported Stream Processing Capabilities + - To process streaming data handled by {+connector-short+}, you must + do one of the following: + - Extend the {+connector-short+} with SMTs or custom Java + - Use or write external tooling + - Available through the MongoDB aggregation framework, with + extensions specific to stream processing. * - Installation - Installation required either locally or on Confluent. @@ -41,13 +42,12 @@ best suits your use case. - MongoDB Java Driver required. - Connection managed by {+service+}. - * - Supported Stream Processing Capabilities - - To process streaming data handled by Kafka Connector, you must - do one of the following: - - Extend the Kafka Connector with SMTs or custom Java - - Use or write external tooling - - Available through the MongoDB aggregation framework, with - extensions specific to stream processing. + * - Hosting + - Hosting required for your {+kafka+} cluster and the Kafka + Connector. Use partner services, such as Confluent Cloud, Amazon + Managed Streaming, or Redpanda Cloud when possible. + - Stream processing functionality fully managed by {+service+}. + Hosting required for your {+kafka+} cluster. * - Windowing - No support for windowing. You must manually configure windowing @@ -79,5 +79,5 @@ best suits your use case. * - Pricing - Pricing dependent on your hosting provider. - - Hourly pricing managed by {+atlas-sp+} Typical costs - approximately 25% of the cost of the Kafka Connector. + - Hourly pricing managed by {+atlas-sp+}. Typical costs + approximately 25% of the cost of the {+connector-short+}. From 9a0756ce6c36b8b35ae09aae4af5847ca47857ae Mon Sep 17 00:00:00 2001 From: Lander McFall Kerbey Date: Tue, 4 Mar 2025 16:31:13 -0500 Subject: [PATCH 11/11] (DOCSP-43999) Copy review, pt. 2 --- source/includes/atlas-sp.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/atlas-sp.rst b/source/includes/atlas-sp.rst index 7561ad35..840aba79 100644 --- a/source/includes/atlas-sp.rst +++ b/source/includes/atlas-sp.rst @@ -5,5 +5,5 @@ materialize views into either {+service+} database collections or Apache Kafka topics. - To learn more about {+atlas-sp+}, see |service| + To learn more about {+atlas-sp+}, see {+service+} `Stream Processing `__.