Skip to content

Adding additional configuration parameters including... #19

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Adding additional configuration parameters including... #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87407ae
Adding additional configuration parameters including TLS with cert fi…
will-verizon-wireless Dec 12, 2022
6580ee2
Rebasing and fixing conflicts
will-verizon-wireless Dec 14, 2022
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
50 changes: 40 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,36 @@ It is fully free and fully open source. The license is Apache 2.0, meaning you a

This input will read events from a Pulsar topic.

This plugin uses Pulsar Client 2.9.0. For broker compatibility, see the official Pulsar compatibility reference. If the compatibility wiki is not up-to-date, please contact Pulsar support/community to confirm compatibility.
This plugin uses Pulsar Client 2.10.2. For broker compatibility, see the official Pulsar compatibility reference. If the compatibility wiki is not up-to-date, please contact Pulsar support/community to confirm compatibility.

If you require features not yet available in this plugin (including client version upgrades), please file an issue with details about what you need.

# Pulsar Input Configuration Options
This plugin supports these configuration options.

| Settings | Input type | Required |
| ------------- |:-------------:| -----:|
| codec | string, one of ["plain","json"] | No |
| topics | array | Yes |
| subscriptionName | string | Yes |
| consumerName | string | No |
| subscriptionType | string, one of["Shared","Exclusive","Failover","Key_shared"] | No |
| subscriptionInitialPosition| string, one of["Latest","Earliest"] | No |
| Settings | Input type | Required |
|----------------------------------|:------------------------------------------------------------:|----------:|
| serviceUrl | string | No |
| topics | array | Yes |
| subscriptionName | string | Yes |
| consumerName | string | No |
| subscriptionType | string, one of["Shared","Exclusive","Failover","Key_shared"] | No |
| subscriptionInitialPosition | string, one of["Latest","Earliest"] | No |
| codec | string, one of ["plain","json"] | No |
| protocols | array, ciphers list. default is TLSv1.2 | No |
| ciphers | array,ciphers list | No |
| enable_tls | boolean, one of [true, false]. default is false | No |
| tls_trust_store_path | string, required if enable_tls is set to true | No |
| tls_trust_store_password | string, default is empty | No |
| enable_tls_hostname_verification | boolean, one of [true, false]. default is false | No |
| allow_tls_insecure_connection | boolean, one of [true, false].default is false | No |
| enable_token | boolean, one of [true, false].default is false | No |
| auth_plugin_class_name | string | No |
| auth_plugin_params_string | string | No |


# Example

pulsar without tls & token
```
input{
pulsar{
Expand All @@ -40,6 +51,25 @@ input{
}
}
```
pulsar with token
```
input{
pulsar{
serviceUrl => "pulsar://127.0.0.1:6650"
codec => "plain"
topics => [
"persistent://public/default/topic1",
"persistent://public/default/topic2"
]
subscriptionName => "my_subscription"
subscriptionType => "Shared"
subscriptionInitialPosition => "Earliest"
enable_token => true
auth_plugin_class_name => "org.apache.pulsar.client.impl.auth.AuthenticationToken"
auth_plugin_params_String => "token:%{token}"
}
}
```


# Installation
Expand Down
Loading