Skip to content

Commit

Permalink
Improve examples
Browse files Browse the repository at this point in the history
  • Loading branch information
gfinocchiaro committed Mar 22, 2024
1 parent 16add9a commit 68ab04a
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 6 deletions.
4 changes: 2 additions & 2 deletions examples/quickstart-confluent-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This folder contains a variant of the [_Quick Start SSL_](../quickstart-ssl/README.md#quick-start-ssl) app configured to use _Confluent Cloud_ as the target Kafka cluster.

The [docker-compose.yml](docker-compose.yml) file has been revised to realize the integration with Confluent Cloud as follows:
The [docker-compose.yml](docker-compose.yml) file has been revised to realize the integration with _Confluent Cloud_ as follows:

- removal of the _broker_ service, because replaced by the remote Kafka cluster.
- removal of the `broker` service, because replaced by the remote Kafka cluster.
- _kafka-connector_:
- definition of new environment variables to configure remote endpoint, credentials, and topic name in the `adapters.xml` through the _variable-expansion__ feature of Lightstreamer:
```yaml
Expand Down
1 change: 1 addition & 0 deletions examples/quickstart-confluent-cloud/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
version: '2'
name: quickstart-kafka-connector-confluent-cloud
services:
kafka-connector:
container_name: kafka-connector
Expand Down
2 changes: 1 addition & 1 deletion examples/quickstart-redpanda-selfhosted/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This folder contains a variant of the [_Quick Start_](../../README.md#quick-start-set-up-in-5-minutes) app configured to use _Redpanda_ as the target broker.

The [docker-compose.yml](docker-compose.yml) file has been revised to realize the integration with [Redpanda Self-hosted](https://docs.redpanda.com/current/get-started/quick-start/).
The [docker-compose.yml](docker-compose.yml) file has been revised to realize the integration with [_Redpanda Self-hosted_](https://docs.redpanda.com/current/get-started/quick-start/).
In particular, the previous `broker` service has been replaced with the following definition:

```yaml
Expand Down
4 changes: 2 additions & 2 deletions examples/quickstart-redpanda-serverless/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ This folder contains a variant of the [_Quick Start SSL_](../quickstart-ssl/READ
- allow `All` permissions to the user on the topic
- allow `All` permissions to the user on the consumer group `quick-start-group`

The [docker-compose.yml](docker-compose.yml) file has been revised to realize the integration with Redpanda Cloud as follows:
The [docker-compose.yml](docker-compose.yml) file has been revised to realize the integration with _Redpanda Serverless_ as follows:

- removal of the _broker_ service, because replaced by the remote cluster.
- removal of the `broker` service, because replaced by the remote cluster.
- _kafka-connector_:
- definition of new environment variables to configure remote endpoint, credentials, and topic name in the `adapters.xml` through the _variable-expansion__ feature of Lightstreamer:
```yaml
Expand Down
1 change: 1 addition & 0 deletions examples/quickstart-redpanda-serverless/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
version: '2'
name: quickstart-kafka-connector-redpanda-serverless
services:
kafka-connector:
container_name: kafka-connector
Expand Down
2 changes: 1 addition & 1 deletion examples/quickstart-schema-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This folder contains a variant of the [_Quick Start SSL_](../quickstart-ssl/READ

The [docker-compose.yml](docker-compose.yml) file has been revised to configure the integration with [_Confluent Docker Image for Schema Registry_](https://hub.docker.com/r/confluentinc/cp-schema-registry) as follows:

- new _schema-registry_ service, pulled from the mentioned Docker image and configured with security settings
- new `schema-registry` service, pulled from the mentioned Docker image and configured with security settings
- _kafka-connector_:

adaption of [`adapters.xml`](./adapters.xml) to include:
Expand Down
1 change: 1 addition & 0 deletions examples/quickstart-schema-registry/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
version: '2'
name: quickstart-kafka-schema-registry
services:
kafka-connector:
container_name: kafka-connector
Expand Down
1 change: 1 addition & 0 deletions examples/quickstart/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
version: '2'
name: quickstart-kafka-connector
services:
kafka-connector:
container_name: kafka-connector
Expand Down

0 comments on commit 68ab04a

Please sign in to comment.