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.

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

[incubator-kie-issues-974] Document data index in compact architecture #2002

Merged
merged 2 commits into from
Mar 7, 2024

Conversation

elguardian
Copy link
Contributor


The next dependency is added for quarkus and being able to use in-vm transport tier
The next dependency is used to specify the storage of the data index and the transport tier at the same time.

Copy link
Contributor

Choose a reason for hiding this comment

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

The two sentences starting with "The next dependency" could be a bit misleading. Maybe start the second one with "The same dependency" (and then remove "at the same time" at the end).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

* mongodb
* postgresql

Current system
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe it would help to add a sentence to describe the diagram, eg:

## How data index works

![data-index](docs/data-index.png "Data Index")

The concepts to understand the above picture are:
*   Transport: the medium used to transfer events between the runtime and the data index service. The transport is http in distributed environments, or in-vm for compact architecture.
*   Storage: the persistence tier of the data index component.
*   Data index: the main component responsible for creating/updating the data index, and for providing query capabilities.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done




of for quarkus
Copy link
Contributor

Choose a reason for hiding this comment

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

or

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done



More information about the Data Index images in here:
[https://github.com/apache/incubator-kie-kogito-images?tab=readme-ov-file#kogito-data-index-component-images](https://github.com/apache/incubator-kie-kogito-images?tab=readme-ov-file#kogito-data-index-component-images images)
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove ' images' to have the link rendered properly

Copy link
Contributor

@martinweiler martinweiler left a comment

Choose a reason for hiding this comment

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

@elguardian thank you. Some minor suggestions, see my comments.

@elguardian elguardian merged commit 399fe8d into apache:main Mar 7, 2024
4 of 5 checks passed
rgdoliveira pushed a commit to rgdoliveira/kogito-apps that referenced this pull request Mar 11, 2024
apache#2002)

* [incubator-kie-issues-974] Document data index in compact architecture

* fix
pefernan pushed a commit to pefernan/kogito-apps that referenced this pull request Mar 11, 2024
apache#2002)

* [incubator-kie-issues-974] Document data index in compact architecture

* fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants