You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/05/09 03:44:27 UTC
[GitHub] [pulsar] Huanli-Meng opened a new pull request, #15495: Update Kafka source connector docs
Huanli-Meng opened a new pull request, #15495:
URL: https://github.com/apache/pulsar/pull/15495
### Motivation
The Kafka source connector configs are updated. Therefore, update docs accordingly.
### Modifications
- Update Kafka source connector docs.
- Related releases:
- latest
- 2.10.0
- 2.9.2
### Documentation
Check the box below or label this PR directly.
Need to update docs?
- [ ] `doc-required`
(Your PR needs to update docs and you will update later)
- [ ] `no-need-doc`
(Please explain why)
- [ x ] `doc`
(Your PR contains doc changes)
- [ ] `doc-added`
(Docs have been already added)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] freeznet commented on a diff in pull request #15495: Update Kafka source connector docs
Posted by GitBox <gi...@apache.org>.
freeznet commented on code in PR #15495:
URL: https://github.com/apache/pulsar/pull/15495#discussion_r868966431
##########
site2/website/versioned_docs/version-2.9.2/io-kafka-source.md:
##########
@@ -182,18 +163,49 @@ Here is an example of using the Kafka source connector with the configuration fi
--parallelism 1
```
-10. Open a new terminal window and run the consumer.
+7. Open a new terminal window and run the Kafka producer locally.
```bash
- $ docker exec -it pulsar-kafka-standalone /bin/bash
+ python3 kafka-producer.py
+ ```
- $ pip install kafka-python
+8. Open a new terminal window and run the Pulsar consumer locally.
- $ python3 kafka-producer.py
+ ```bash
+ python3 pulsar-client.py
```
- The following information appears on the consumer terminal window.
+The following information appears on the consumer terminal window.
```bash
Received message: 'hello world'
```
+
+### On-premises cluster
+
+This example explains how to create a Kafka source connector in an on-premises cluster.
+
+1. Copy the NAR package of the Kafka connector to the Pulsar connectors directory.
+
+ ```
+ cp pulsar-io-kafka-{{connector:version}}.nar $PULSAR_HOME/connectors/pulsar-io-kafka-{{connector:version}}.nar
+ ```
+
+2. Reload all [built-in connectors](https://pulsar.apache.org/docs/en/next/io-connectors/).
+
+ ```
+ PULSAR_HOME/bin/pulsar-admin sources reload
+ ```
+
+3. Check whether the Kafka source connector is available on the list or not.
+
+ ```
+ PULSAR_HOME/bin/pulsar-admin sources available-sources
+ ```
+
+4. Create a Kafka source connector on a Pulsar cluster using the [`pulsar-admin sources create`](http://pulsar.apache.org/tools/pulsar-admin/2.8.0-SNAPSHOT/#-em-create-em--14) command.
Review Comment:
maybe link to current version's doc?
##########
site2/website/versioned_docs/version-2.10.0/io-kafka-source.md:
##########
@@ -184,18 +163,49 @@ Here is an example of using the Kafka source connector with the configuration fi
--parallelism 1
```
-10. Open a new terminal window and run the consumer.
+7. Open a new terminal window and run the Kafka producer locally.
```bash
- $ docker exec -it pulsar-kafka-standalone /bin/bash
+ python3 kafka-producer.py
+ ```
- $ pip install kafka-python
+8. Open a new terminal window and run the Pulsar consumer locally.
- $ python3 kafka-producer.py
+ ```bash
+ python3 pulsar-client.py
```
- The following information appears on the consumer terminal window.
+The following information appears on the consumer terminal window.
```bash
Received message: 'hello world'
```
+
+### On-premises cluster
+
+This example explains how to create a Kafka source connector in an on-premises cluster.
+
+1. Copy the NAR package of the Kafka connector to the Pulsar connectors directory.
+
+ ```
+ cp pulsar-io-kafka-{{connector:version}}.nar $PULSAR_HOME/connectors/pulsar-io-kafka-{{connector:version}}.nar
+ ```
+
+2. Reload all [built-in connectors](https://pulsar.apache.org/docs/en/next/io-connectors/).
+
+ ```
+ PULSAR_HOME/bin/pulsar-admin sources reload
+ ```
+
+3. Check whether the Kafka source connector is available on the list or not.
+
+ ```
+ PULSAR_HOME/bin/pulsar-admin sources available-sources
+ ```
+
+4. Create a Kafka source connector on a Pulsar cluster using the [`pulsar-admin sources create`](http://pulsar.apache.org/tools/pulsar-admin/2.8.0-SNAPSHOT/#-em-create-em--14) command.
Review Comment:
maybe link to current version's doc?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Huanli-Meng commented on a diff in pull request #15495: [Improve][Doc]Update Kafka source connector docs
Posted by GitBox <gi...@apache.org>.
Huanli-Meng commented on code in PR #15495:
URL: https://github.com/apache/pulsar/pull/15495#discussion_r869015786
##########
site2/website/versioned_docs/version-2.10.0/io-kafka-source.md:
##########
@@ -184,18 +163,49 @@ Here is an example of using the Kafka source connector with the configuration fi
--parallelism 1
```
-10. Open a new terminal window and run the consumer.
+7. Open a new terminal window and run the Kafka producer locally.
```bash
- $ docker exec -it pulsar-kafka-standalone /bin/bash
+ python3 kafka-producer.py
+ ```
- $ pip install kafka-python
+8. Open a new terminal window and run the Pulsar consumer locally.
- $ python3 kafka-producer.py
+ ```bash
+ python3 pulsar-client.py
```
- The following information appears on the consumer terminal window.
+The following information appears on the consumer terminal window.
```bash
Received message: 'hello world'
```
+
+### On-premises cluster
+
+This example explains how to create a Kafka source connector in an on-premises cluster.
+
+1. Copy the NAR package of the Kafka connector to the Pulsar connectors directory.
+
+ ```
+ cp pulsar-io-kafka-{{connector:version}}.nar $PULSAR_HOME/connectors/pulsar-io-kafka-{{connector:version}}.nar
+ ```
+
+2. Reload all [built-in connectors](https://pulsar.apache.org/docs/en/next/io-connectors/).
+
+ ```
+ PULSAR_HOME/bin/pulsar-admin sources reload
+ ```
+
+3. Check whether the Kafka source connector is available on the list or not.
+
+ ```
+ PULSAR_HOME/bin/pulsar-admin sources available-sources
+ ```
+
+4. Create a Kafka source connector on a Pulsar cluster using the [`pulsar-admin sources create`](http://pulsar.apache.org/tools/pulsar-admin/2.8.0-SNAPSHOT/#-em-create-em--14) command.
Review Comment:
Good point. Have fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Huanli-Meng commented on a diff in pull request #15495: [Improve][Doc]Update Kafka source connector docs
Posted by GitBox <gi...@apache.org>.
Huanli-Meng commented on code in PR #15495:
URL: https://github.com/apache/pulsar/pull/15495#discussion_r869015333
##########
site2/website/versioned_docs/version-2.9.2/io-kafka-source.md:
##########
@@ -182,18 +163,49 @@ Here is an example of using the Kafka source connector with the configuration fi
--parallelism 1
```
-10. Open a new terminal window and run the consumer.
+7. Open a new terminal window and run the Kafka producer locally.
```bash
- $ docker exec -it pulsar-kafka-standalone /bin/bash
+ python3 kafka-producer.py
+ ```
- $ pip install kafka-python
+8. Open a new terminal window and run the Pulsar consumer locally.
- $ python3 kafka-producer.py
+ ```bash
+ python3 pulsar-client.py
```
- The following information appears on the consumer terminal window.
+The following information appears on the consumer terminal window.
```bash
Received message: 'hello world'
```
+
+### On-premises cluster
+
+This example explains how to create a Kafka source connector in an on-premises cluster.
+
+1. Copy the NAR package of the Kafka connector to the Pulsar connectors directory.
+
+ ```
+ cp pulsar-io-kafka-{{connector:version}}.nar $PULSAR_HOME/connectors/pulsar-io-kafka-{{connector:version}}.nar
+ ```
+
+2. Reload all [built-in connectors](https://pulsar.apache.org/docs/en/next/io-connectors/).
+
+ ```
+ PULSAR_HOME/bin/pulsar-admin sources reload
+ ```
+
+3. Check whether the Kafka source connector is available on the list or not.
+
+ ```
+ PULSAR_HOME/bin/pulsar-admin sources available-sources
+ ```
+
+4. Create a Kafka source connector on a Pulsar cluster using the [`pulsar-admin sources create`](http://pulsar.apache.org/tools/pulsar-admin/2.8.0-SNAPSHOT/#-em-create-em--14) command.
Review Comment:
Good point. Have fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Huanli-Meng commented on pull request #15495: Update Kafka source connector docs
Posted by GitBox <gi...@apache.org>.
Huanli-Meng commented on PR #15495:
URL: https://github.com/apache/pulsar/pull/15495#issuecomment-1121846754
@freeznet could you please help review this PR? Thanks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #15495: Update Kafka source connector docs
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #15495:
URL: https://github.com/apache/pulsar/pull/15495#issuecomment-1122048761
@Huanli-Meng can you rename your PR? eg. [improve][doc] xxx
guideline: https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Huanli-Meng merged pull request #15495: [Improve][Doc]Update Kafka source connector docs
Posted by GitBox <gi...@apache.org>.
Huanli-Meng merged PR #15495:
URL: https://github.com/apache/pulsar/pull/15495
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org