Skip to content

Commit

Permalink
fix: #452 : kafka in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Yalz committed Jan 12, 2024
1 parent 818a83d commit 677fe5f
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions docs/_ldio/ldio-inputs/ldio-kafka-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,35 +15,34 @@ Two security protocols are supported:

## Config

| Property | Description | Required | Default | Example | Supported values |
|----------------------|---------------------------------------------------------------------|----------|---------|----------------------------------|--------------------------------------------------------------------------------------|
| content-type | Any content type supported by Apache Jena | Yes | N/A | application/n-quads | String |
| bootstrap-servers | Comma separated list of uris of the bootstrap servers | Yes | N/A | localhost:9012 | url |
| topic | Name of the topic | Yes | N/A | quickstart-events | String |
| key-property-path | Optional property path to extract the kafka key from the data model | No | null | <http://purl.org/dc/terms/title> | [ARQ property path](https://jena.apache.org/documentation/query/property_paths.html) |
| security-protocol | Security protocol to be used to connect to the kafka broker | No | NO_AUTH | SASL_SSL_PLAIN | SASL_SSL_PLAIN or NO_AUTH |
| sasl-jaas-user | Username used in the security protocol | No | null | client | String |
| sasl-jaas-password | Password used in the security protocol | No | null | secret | String |
| Property | Description | Required | Default | Example | Supported values |
|--------------------|-------------------------------------------------------------|----------|-----------------|---------------------|---------------------------|
| content-type | Any content type supported by Apache Jena | Yes | N/A | application/n-quads | String |
| bootstrap-servers | Comma separated list of uris of the bootstrap servers | Yes | N/A | localhost:9012 | url |
| topics | Names of the topics (comma separated) | Yes | N/A | quickstart-events | String |
| group-id | Group identifier the consumer belongs to | No | generated value | group-1 | String |
| security-protocol | Security protocol to be used to connect to the kafka broker | No | NO_AUTH | SASL_SSL_PLAIN | SASL_SSL_PLAIN or NO_AUTH |
| sasl-jaas-user | Username used in the security protocol | No | null | client | String |
| sasl-jaas-password | Password used in the security protocol | No | null | secret | String |

## Example

### NO SECURITY

```yaml
outputs:
- name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaOut
- name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaIn
config:
content-type: application/n-quads
topics: quickstart-events
bootstrap-servers: localhost:9092
group-id: testing_group
```
### SASL SSL PLAIN
```yaml
outputs:
- name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaOut
- name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioKafkaIn
config:
content-type: application/n-quads
topics: quickstart-events
Expand Down

0 comments on commit 677fe5f

Please sign in to comment.