yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-08-18 14:16:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix pulsar source docs. (#5011)

Browse Source
This commit is contained in:
Ravindra Lanka 2022-05-26 03:34:04 -07:00 committed by GitHub
parent 2911e1ed1b
commit a8c1df083f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
metadata-ingestion/docs/sources/pulsar/pulsar.md
View File

@ -1,38 +1,12 @@
> **_NOTE:_** Always use TLS encryption in a production environment and use variable substitution for sensitive information (e.g. ${CLIENT_ID} and ${CLIENT_SECRET}).
>
### Prerequisites ### Prerequisites
In order to ingest metadata from Apache Pulsar, you will need: In order to ingest metadata from Apache Pulsar, you will need:
* Access to a Pulsar Instance, if authentication is enabled a valid access token. * Access to a Pulsar Instance, if authentication is enabled a valid access token.
* Pulsar version >= 2.7.0 * Pulsar version >= 2.7.0
* ...
> **_NOTE:_** A _superUser_ role is required for listing all existing tenants within a Pulsar instance. > **_NOTE:_** A _superUser_ role is required for listing all existing tenants within a Pulsar instance.
> >
### Install the Plugin(s)
Run the following commands to install the relevant plugin(s):
`pip install 'acryl-datahub[pulsar]'`
### Configure the Ingestion Recipe(s)
Use the following recipe(s) to get started with ingestion. See [below](#config-details) for full configuration options.
_For general pointers on writing and running a recipe, see our [main recipe guide](../../../../metadata-ingestion/README.md#recipes)._
#### Quickstart recipe
Getting started receipt
```yml
source:
type: pulsar
config:
# Required fields
web_service_url: "http://localhost:8080"
sink:
# sink configs
```
> **_NOTE:_** Always use TLS encryption in a production environment and use variable substitution for sensitive information (e.g. ${CLIENT_ID} and ${CLIENT_SECRET}).
>