Skip to content

Commit 2d6ddb4

Browse files
authored
Merge pull request #162 from marklogic/feature/contrib-update
Updated Confluent Platform setup instructions
2 parents 499cc12 + 5867083 commit 2d6ddb4

File tree

2 files changed

+34
-9
lines changed

2 files changed

+34
-9
lines changed

CODEOWNERS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Lines starting with '#' are comments.
2+
# Each line is a file pattern followed by one or more owners.
3+
4+
# These owners will be the default owners for everything in the repo.
5+
* @billfarber @rjrudin

CONTRIBUTING.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ For more assistance with Sonar and Gradle, see the [Sonar Gradle plugin docs](ht
5858

5959
# Testing with Confluent Platform
6060

61-
[Confluent Platform](https://docs.confluent.io/platform/7.2.1/overview.html) provides an easy mechanism for running
61+
[Confluent Platform](https://docs.confluent.io/platform/current/overview.html) provides an easy mechanism for running
6262
Kafka locally via a single application. A primary benefit of testing with Confluent Platform is to test configuring the
6363
MarkLogic Kafka connector via the [Confluent Control Center](https://docs.confluent.io/platform/current/control-center/index.html)
6464
web application.
@@ -67,16 +67,37 @@ To try out the MarkLogic Kafka connector via the Confluent Platform, follow the
6767

6868
## Install Confluent Platform with the MarkLogic Kafka connector
6969

70-
First, [install the Confluent Platform](https://docs.confluent.io/platform/current/quickstart/ce-docker-quickstart.html#cp-quickstart-step-1)
71-
via the "Tar archive" option (the "Docker" option has not yet been tested).
70+
First, [install the Confluent Platform](https://docs.confluent.io/platform/current/installation/installing_cp/zip-tar.html)
71+
(the "Docker" option has not yet been tested). It is recommended to configure `CONFLUENT_HOME` as described at that
72+
page, as that simplifies running the `confluent` commands below.
7273

73-
**Important!** After step 6 (installing the Datagen source connector) and before step 7 (starting Confluent Platform),
74-
you'll need to install the MarkLogic Kafka connector into your Confluent Platform distribution.
74+
To verify that you have Confluent Platform installed successfully, run the following:
7575

76-
To do so, modify `confluentHome` in `gradle-local.properties` (create this file in the root of this project if it
77-
does not already exist) to point to where you extracted the Confluent Platform distribution - e.g.:
76+
confluent local services status
7877

79-
confluentHome=/Users/myusername/confluent-7.2.1
78+
This should show that each component of Confluent Platform is not running; you should see something like the following
79+
displayed:
80+
81+
```
82+
Connect is [DOWN]
83+
Control Center is [DOWN]
84+
Kafka is [DOWN]
85+
Kafka REST is [DOWN]
86+
ksqlDB Server is [DOWN]
87+
Schema Registry is [DOWN]
88+
ZooKeeper is [DOWN]
89+
```
90+
91+
The Kafka [Datagen Source Connector](https://www.confluent.io/hub/confluentinc/kafka-connect-datagen) is a convenient
92+
tool for local development and testing. Install it via the following:
93+
94+
confluent-hub install confluentinc/kafka-connect-datagen:0.6.0
95+
96+
Next, in order to build and deploy the MarkLogic Kafka connector to Confluent Platform, modify `confluentHome` in
97+
`gradle-local.properties` (create this file in the root of this project if it does not already exist) to point to
98+
where you extracted the Confluent Platform distribution - e.g.:
99+
100+
confluentHome=/Users/myusername/confluent-7.4.0
80101

81102
Then build and copy the connector to the Confluent Platform directory that you configured above:
82103

@@ -94,7 +115,6 @@ To verify that your Confluent installation is running properly, you can run `con
94115
see logging similar to this:
95116

96117
```
97-
Using CONFLUENT_CURRENT: /var/folders/wn/l42pccj17rbfw6h_5b8bt2nnkpch_s/T/confluent.995873
98118
Connect is [UP]
99119
Control Center is [UP]
100120
Kafka is [UP]

0 commit comments

Comments
 (0)