(DOCSP-18842) Introduction > Install The Connector (#161)

Author: biniona-mongodb

snooty.toml

@@ -5,6 +5,7 @@ toc_landing_pages = ["/sink-connector", "/sink-connector/configuration-propertie
 
 [constants]
 mkc = "MongoDB Kafka Connector"
+connector-long = "MongoDB Connector for Apache Kafka"
 ak = "Apache Kafka"
 kc = "Kafka Connect"
 connector_version="1.6"

source/introduction.txt

@@ -6,8 +6,7 @@ Introduction
    :titlesonly:
 
    Kafka and Kafka Connect </introduction/kafka-connect>
+   Install the Connector </introduction/install>
    Connect to MongoDB </introduction/connect>
    Data Formats </introduction/data-formats>
    Converters </introduction/converters>
-
-asdf

source/introduction/install.txt

@@ -0,0 +1,127 @@
+.. _kafka-installation:
+
+===================================
+Install the MongoDB Kafka Connector
+===================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+Overview
+--------
+
+Learn how to install the {+mkc+}. The {+mkc+} is available for Confluent Platform and
+{+ak+} deployments. To see installation instructions for your deployment type,
+navigate to one of the following sections:
+
+- :ref:`Install the Connector on Confluent Platform <kafka-connector-install-confluent>`
+- :ref:`Install the Connector on {+ak+} <kafka-connector-install-apache>`
+
+.. _kafka-connector-install-confluent:
+
+Install the Connector on Confluent Platform
+-------------------------------------------
+
+Click the following tabs to see instructions for how to install the
+connector on Confluent Platform:
+
+.. tabs::
+
+   .. tab::
+      :tabid: Install with Confluent Hub Client
+
+      1. `Install the Confluent Hub Client <https://docs.confluent.io/home/connect/confluent-hub/client.html#installing-c-hub-client>`__.
+
+      2. Follow the installation instructions for the
+         `{+connector-long+} <https://www.confluent.io/hub/mongodb/kafka-connect-mongodb>`__
+         using the Confluent Hub Client.
+
+   .. tab::
+      :tabid: Install from JAR
+
+      1. Follow the directions on the Confluent page for
+         `Manually Installing Community Connectors
+         <https://docs.confluent.io/home/connect/community.html>`__.
+      
+      2. Use the connector GitHub URL and uber JAR locations in the
+         :ref:`installation reference table <kafka-connector-installation-reference>`
+         when appropriate in the Confluent manual installation instructions.
+
+.. _kafka-connector-install-apache:
+
+Install the Connector on Apache Kafka
+-------------------------------------
+
+1. Locate and download the uber JAR to get all the dependencies required
+   for the connector. Refer to the
+   :ref:`installation reference table <kafka-connector-installation-reference>`
+   to find the uber JAR.
+
+   .. note::
+
+      If you are unable to use the uber JAR or prefer to manage your own
+      dependencies, download the JAR that contains the minimum required
+      dependencies and resolve any runtime dependencies. You can use
+      a plugin such as `Maven dependency:tree
+      <https://maven.apache.org/plugins/maven-dependency-plugin/tree-mojo.html>`__
+      to generate the dependency tree.
+
+2. Copy the JAR and any dependencies into the Kafka plugins directory
+   which you can specify in your
+   `plugin.path <https://kafka.apache.org/documentation/#connectconfigs_plugin.path>`__
+   configuration setting (e.g. ``plugin.path=/usr/local/share/kafka/plugins``).
+
+.. note::
+
+   If you intend to run the connector as distributed worker processes, you
+   must repeat this process for each server or virtual machine.
+
+.. _kafka-connector-installation-reference:
+
+Installation Reference Table
+----------------------------
+
+You can download the {+mkc+} source and JAR files from the following locations:
+
+.. list-table::
+   :widths: 55 45
+   :stub-columns: 1
+
+   * - Kafka Connector GitHub repository (source code)
+     - :github:`mongodb/mongo-kafka <mongodb/mongo-kafka>`
+
+   * - Maven Central repository (JAR files)
+     - `mongo-kafka-connect <https://search.maven.org/artifact/org.mongodb.kafka/mongo-kafka-connect>`__
+
+You can identify the contents of the JAR files by the suffix in the
+filename. Consult the following table for a description of each suffix:
+
+.. list-table::
+   :widths: 25 75
+
+   * - Suffix
+     - Description
+
+   * - **all**
+     - The uber JAR that contains the connector, MongoDB dependencies, and
+       Apache Avro
+
+   * - **confluent**
+     - Contains the minimum requirements for the connector and Confluent
+       Platform
+
+   * - **javadoc**
+     - Contains the Javadoc documentation for the connector classes
+
+   * - **sources**
+     - Contains the source code that corresponds to the compiled connector
+       classes
+
+For example, ``mongo-kafka-connect-{+connector_version+}-all.jar`` is the uber JAR for the
+version {+connector_version+} connector.
+