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

Data model definition #344

Open
2 of 4 tasks
AlexRuiz7 opened this issue Aug 7, 2024 · 1 comment
Open
2 of 4 tasks

Data model definition #344

AlexRuiz7 opened this issue Aug 7, 2024 · 1 comment
Labels
level/epic Epic issue type/enhancement Enhancement issue

Comments

@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Aug 7, 2024

Description

As part of the new data persistence model to be implemented across Wazuh, we need to define the data model that is going to be used and shared by the Wazuh Central Components. While the Wazuh Indexer team is in charge of the creation and maintenance of the index templates, the indices and their fields, we believe their semantics depend on the context where they are being generated, hence the significance of these fields needs to be provided by the source of the data.

This new data model needs to be well documented, written and visually, by the use of diagrams, to make its understanding and maintenance as easy as possible. The data model needs to ensure that the data can be filtered using consistent criteria, such as the groups of agent they belong to.

As a result, we'll generate not only the documentation of this new data model, but the index templates that effectively represent the data model in the Indexer.

Functional requirements

  • The data model must cover all the indices planned for 5.0 (stateful and stateless. See parent issue).
  • The data model must allow Role-Based access control consistently. The data can be filtered, at least, by the groups of agents it belongs to.

Non-functional requirements

  • The data model must be represented in an E/R diagram.
  • The fields of the data model need to be well documented, indicating their meaning in the context of the source where they are generated, and providing any relevant information about their lifecycle, for example, under which conditions the data is generated or changes.
  • The data model must outline the visibility of the indices.

Plan

@AlexRuiz7 AlexRuiz7 added level/task Task issue type/enhancement Enhancement issue labels Aug 7, 2024
@wazuhci wazuhci moved this to Backlog in Release 5.0.0 Aug 7, 2024
@AlexRuiz7 AlexRuiz7 mentioned this issue Aug 7, 2024
3 tasks
@AlexRuiz7 AlexRuiz7 added level/epic Epic issue and removed level/task Task issue labels Aug 30, 2024
@wazuhci wazuhci moved this from Backlog to On hold in Release 5.0.0 Aug 30, 2024
@AlexRuiz7
Copy link
Member Author

Moved to the Feature Complete stage.

@AlexRuiz7 AlexRuiz7 changed the title Data persistence model definition Data model definition Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/epic Epic issue type/enhancement Enhancement issue
Projects
Status: On hold
Development

No branches or pull requests

1 participant