Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add graphical README.md to catalog-server #385

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Add graphical README.md to catalog-server #385

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4e4585
Add graphical README.md to catalog-server
Bdegraaf1234 Jul 31, 2024
722e0e2
Merge branch 'dev' into add-graphic-to-readme
Bdegraaf1234 Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions java-sdk/radar-catalog-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Flow

Below are several sequence diagrams illustrating the flow of the application during startup and regular operation.

## Startup
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are calling this Initialization in other readmes?

Suggested change
## Startup
## Initialization


On startup, an init container (kafka-init) will be launched to add configured topics to the Kafka schema registry.

This is done using the [docker/topic_init.sh](../../docker/topic_init.sh) script, which calls the `radar-schemas-tools`
command line app

```mermaid
sequenceDiagram
participant kafka-init as kafka-init
participant kafka as Kafka
participant schema-registry as Schema Registry

kafka-init ->> kafka: Create topics
kafka-init ->> schema-registry: Register schemas
```
## Regular operation

After startup the `catalog-server` application will be running and listening for requests on public endpoints.
This application is responsible for providing the source-types on requests, which are configured in the [specifications](../../specifications) folder.

```mermaid
sequenceDiagram
participant client as Client
participant catalog_server as Catalog Server

client ->> catalog_server: Request source-types
catalog_server ->> catalog_server: Read source-types from /specifications/
catalog_server ->> client: Return source-types
```
Loading