Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(ingestion): Fix pulsar source docs. #5011

Merged
merged 1 commit into from
May 26, 2022
Merged

fix(ingestion): Fix pulsar source docs. #5011

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 3 additions & 29 deletions metadata-ingestion/docs/sources/pulsar/pulsar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

In order to ingest metadata from Apache Pulsar, you will need:

* Access to a Pulsar Instance, if authentication is enabled a valid access token.
* Pulsar version >= 2.7.0
* ...

> **_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}).
>