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

Add doc section about secured Kafka #4796

Merged
merged 5 commits into from
Apr 25, 2024
Merged
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
52 changes: 52 additions & 0 deletions docs/ingest-data/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,58 @@ curl -XPOST -H 'Content-Type: application/json' 'http://localhost:7280/api/v1/gh
}'
```


## Secured Kafka connection (optional)

The Quickwit Kafka source supports SSL and SASL authentication. This is
particularly useful when consuming data from an external Kafka service.

### SSL configuration

```yaml
version: 0.8
source_id: kafka-source-ssl
source_type: kafka
num_pipelines: 2
params:
topic: gh-archive
client_params:
bootstrap.servers: your-kafka-broker.com
security.protocol: SSL
ssl.ca.location: /path/to/ca.pem
ssl.certificate.location: /path/to/service.cert
ssl.key.location: /path/to/service.key
```

### SASL configuration

```yaml
version: 0.8
source_id: kafka-source-sasl
source_type: kafka
num_pipelines: 2
params:
topic: gh-archive
client_params:
bootstrap.servers: your-kafka-broker.com
ssl.ca.location: /path/to/ca.pem
security.protocol: SASL_SSL
sasl.mechanisms: SCRAM-SHA-256
sasl.username: your_sasl_username
sasl.password: your_sasl_password
```

:::note

If you get the following error:

```Client creation error: ssl.ca.location failed: error:05880002:x509 certificate routines::system lib```

It usually means the path to the CA certificate is incorrect. Update the
`ssl.ca.location` parameter accordingly.

:::

## Tear down resources (optional)

Let's delete the files and resources created for the purpose of this tutorial.
Expand Down