Skip to content

Commit

Permalink
Add symlinks to example directories
Browse files Browse the repository at this point in the history
  • Loading branch information
Nuvindu committed Apr 10, 2024
1 parent 9a01503 commit ed4d366
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 1 deletion.
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Ballerina Avro Serializer/Deserializer connector for Confluent Schema Regist
This example shows how to publish Avro serialized data to a Kafka topic.

2. [Kafka Avro consumer](https://github.com/ballerina-platform/module-ballerinax-confluent.cavroserdes/tree/main/examples/kafka-avro-consumer)
This example shows how to consume data in the correct format from a Kafka topic.
This guide demonstrates how to consume data in the correct format according to Avro schema from a Kafka topic.

## Prerequisites

Expand Down
1 change: 1 addition & 0 deletions examples/kafka-avro-consumer/.github/README.md
31 changes: 31 additions & 0 deletions examples/kafka-avro-consumer/kafka-avro-consumer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Consume Avro Serialized Data from a Kafka Topic

## Introduction

This guide demonstrates how to consume data in the correct format according to Avro schema from a Kafka topic.

### Configuration

Configure the followings in Config.toml in the example directory.

```toml
baseUrl = <BASE_URL>
identityMapCapacity = <SCHEMA_MAP_CAPACITY>
subject = <SCHEMA_REGISTRY_TOPIC>

[originals]
"schema.registry.url" = <SCHEMA_REGISTRY_ENDPOINT_URL>
"basic.auth.credentials.source" = "USER_INFO"
"bootstrap.servers" = "<SERVER>:<PORT>"
"schema.registry.basic.auth.user.info" = "<KEY>:<SECRET>"

[headers]
```

## Run the example

Execute the following command to run the example.

```ballerina
bal run
```
1 change: 1 addition & 0 deletions examples/kafka-avro-producer/.github/README.md
31 changes: 31 additions & 0 deletions examples/kafka-avro-producer/kafka-avro-producer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Publish Avro Serialized Data to a Kafka Topic

## Introduction

This guide demonstrates how to publish Avro serialized data to a Kafka topic.

### Configuration

Configure the followings in Config.toml in the example directory.

```toml
baseUrl = <BASE_URL>
identityMapCapacity = <SCHEMA_MAP_CAPACITY>
subject = <SCHEMA_REGISTRY_TOPIC>

[originals]
"schema.registry.url" = <SCHEMA_REGISTRY_ENDPOINT_URL>
"basic.auth.credentials.source" = "USER_INFO"
"bootstrap.servers" = "<SERVER>:<PORT>"
"schema.registry.basic.auth.user.info" = "<KEY>:<SECRET>"

[headers]
```

## Run the example

Execute the following command to run the example.

```ballerina
bal run
```

0 comments on commit ed4d366

Please sign in to comment.