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.

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

Update documentation to explicitly mention auth parameter translation for Kafka #102

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions fink_client/consumer.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ class AlertConsumer:
def __init__(self, topics: list, config: dict, schema_path=None):
"""Creates an instance of `AlertConsumer`

Note we are currently using SASL for the user authentication.
`config` parameters get then translated for Kafka.
For lower level usage, see `_get_kafka_config`

Parameters
----------
topics : list of str
Expand Down Expand Up @@ -244,6 +248,8 @@ def close(self):
def _get_kafka_config(config: dict) -> dict:
"""Returns configurations for a consumer instance

Note we are using SASL for authentication (SCRAM-SHA-512).

Parameters
----------
config: dict
Expand Down