juplo.de Git - demos/kafka/outbox/blob - README.md

   1 # Implementation of the Outbox-Pattern for Apache Kafka
   2
   3 This Repository holds the source code for
   4 [a blog-series that explains a technically complete implementation of the outbox-pattern for Apache Kafka](https://juplo.de/implementing-the-outbox-pattern-with-kafka-part-2-sending-messages-from-the-outbox/).
   5
   6 Execute [README.sh](README.sh) in a shell to demonstrate the example:
   7
   8     ./README.sh
   9
  10 The script will...
  11
  12 * compile the two components,
  13 * package them as Docker-Images,
  14 * start up the components and a minimal Kafka Cluster as containers in a [Compose-Setup](docker-compose.yml),
  15 * execute example-queries (CREATE / DELETE) against the API of [the example-project](https://juplo.de/implementing-the-outbox-pattern-with-kafka-part-0-the-example/) and
  16 * tail the logs of the containers `jdbc` and `kafkacat` to show what is going on.
  17
  18 You can verify the expected outcome of the demonstration by running a command like the following:
  19
  20     $ docker-compose logs kafkacat | grep peter
  21     kafkacat_1   | peter1:"CREATED"
  22     kafkacat_1   | peter2:"CREATED"
  23     kafkacat_1   | peter3:"CREATED"
  24     kafkacat_1   | peter4:"CREATED"
  25     kafkacat_1   | peter5:"CREATED"
  26     kafkacat_1   | peter6:"CREATED"
  27     kafkacat_1   | peter7:"CREATED"
  28     $
  29
  30 The example-output shows, that the CREATE-event for users with "peter" in their username are only issued exactly once, although the script issues several requests for each of these users.
  31
  32 Be aware, that the outcome of the script will be different, if you run it several times.
  33 In order to reproduce the same behaviour, you have to shut down the Compose-Setup before rerunning the script:
  34
  35     docker-compose down -v
  36     ./README.sh
  37
  38 To clean up all created artifacts one can run:
  39
  40     ./README.sh cleanup