Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/selcuksert/task-manager
Basic task management application based on event driven architecture paradigm
https://github.com/selcuksert/task-manager
bootstrap codereadycontainers grafana kafka kafka-connect kafka-streams ksqldb kubernetes openshift react-hooks react-router reactjs rest-proxy schema-registry spring-cloud-stream spring-cloud-stream-binder-kafka
Last synced: about 1 month ago
JSON representation
Basic task management application based on event driven architecture paradigm
- Host: GitHub
- URL: https://github.com/selcuksert/task-manager
- Owner: selcuksert
- License: mit
- Created: 2021-05-02T11:54:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-14T20:48:27.000Z (over 1 year ago)
- Last Synced: 2023-06-14T22:40:29.377Z (over 1 year ago)
- Topics: bootstrap, codereadycontainers, grafana, kafka, kafka-connect, kafka-streams, ksqldb, kubernetes, openshift, react-hooks, react-router, reactjs, rest-proxy, schema-registry, spring-cloud-stream, spring-cloud-stream-binder-kafka
- Language: JavaScript
- Homepage:
- Size: 16.9 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Task Management App
This project is an event driven task management application that comprises of PostgreSQL DB and ReactJS, Apache Kafka, Kafka Streams (based on single writer principle) and the major ecosystem components like SchemaRegistry, Kafka Connect.
The UI is based on ReactJS and Bootstrap.
Keycloak with OpenLDAP is used as IdP (Identity Provider) to enable OAuth2 and OIDC driven AAA (AuthN, AuthZ, Accounting).
The Kafka Stream source, processor and sink implementations are based on Spring Cloud Stream Kafka Binder.
## References
To have a solid baseline and understanding on Apache Kafka ecosystem following e-books are should read references (they are DRM free and freely distributed by Confluent):
* [Kafka Definitive Guide](./docs/books/20170707-EB-Confluent_Kafka_Definitive-Guide_Complete.pdf)
* [Designing Event Driven Systems](./docs/books/20180328-EB-Confluent_Designing_Event_Driven_Systems.pdf)
## Basic Setup
As this is a PoC project a local domain is used for Traefik edge router. Following entries should be entered for web and identity provider access in `/etc/hosts`:
```
127.0.0.1 web.poc.local
127.0.0.1 idp.poc.local
```
## Architecture
Here is the architecture model of project:
## Processor Topology
The application utilizes Spring Boot Actuator endpoint `kafkastreamstopology` to retrieve topology definition for **task-processor** Kafka Streams app. The *Processor Topology* button on header menu renders this in image format using [kafka-streams-viz](https://github.com/zz85/kafka-streams-viz):
## Components
The project is shipped with of two different deployment modes as [fully containerized deployment](./docker/compose/docker-compose.containerized.yml) and [hybrid deployment](./docker/compose/docker-compose.yml):
* ***Fully Containerized:*** All of the components including SpringBoot based microservices are containerized. Can
be [started](./docker/compose/cont-up.ps1) and [stopped](./docker/compose/cont-down.ps1) using shell scripts.
* ***Hybrid Mode:*** All of the components **except** SpringBoot based microservices are containerized. Can be used
for development and be [started](./docker/compose/dev-up.ps1) and [stopped](./docker/compose/dev-down.ps1) using shell
scripts.
Before starting `mvn clean install` should be invoked for top-level project in order to generate app binaries. See [bin](./docker/compose/app/service/bin/README.md).
Here are the components:
### Web UI
ReactJS based Web UI to provide basic portal to manage tasks. React Hook and Context API are also used for state management:
### Messaging Layer
Event Driven messaging layer using Apache Kafka Ecosystem Tooling:
* Zookeeper
* Kafka Brokers
* Schema Registry
* Kafka Connect
* Rest Proxy
* Kafka Monitoring Stack
### Persistent Data Store
PostgreSQL RDBMS to persist event data on user and task topics for viewing on UI. PgAdmin is also available for DB administration.
### Monitoring Stack
Prometheus and Grafana based monitoring stack is available to view status of Kafka brokers:
There exists a [sample Grafana dashboard](./docker/compose/kafka/monitor/dashboard) in JSON format that can be imported into Grafana.
### Identity Provider for OAuth2 & OIDC
Keycloak Identity Provider for OAuth2 & OIDC based AAA enablement. The IdP is backed by an OpenLDAP instance which is initiated by a designated [user database](./docker/compose/ldap/config/bootstrap.ldif).
The task user list on Add User screen is retrieved via Keycloak REST API that is populated from LDAP. To enable this functionality Keycloak admin should assign `view-users` role of `realm-management` client to added realm's default role set:
Other settings:
## ksqlDB
There exists a [documentation](./docker/compose/kafka/ksql/README.md) on ksql statements used in this project.
### Statistics Page
The project brings a statistics page comprised of React Plotly charts fed with real time data from ksqlDB queries. The task distribution graph has the ability to set window size and historical framing (as a baseline to re-playing) based on date and time:
## OpenShift Support
This project contains deployment objects to activate the task manager application on a RHOCP cluster. These objects are derived from objects [generated](./ocp/kompose/generate.sh) by `kompose` tool using existing `docker-compose.yml` file. The objects were tested on local OCP deployment using CodeReady Containers technology. The [build](./ocp/build.sh) and [deploy](./ocp/deploy.sh) scripts can be used to generate custom images and deploy them on cluster.
