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

Improve schema documentation (notably where it differs from the objects in Icinga 2) #272

Open
julianbrost opened this issue Apr 26, 2021 · 3 comments
Labels
area/documentation Improvements or additions to documentation area/schema

Comments

@julianbrost
Copy link
Contributor

In Icinga/icinga2#8706 we decided that we want to change the meaning of endpoint.zone_id in Icinga DB to be more like what a user would expect. This means that this now differs from the object in Icinga 2 as written in the config file and as returned by the API (Icinga 2: location of the endpoint object as considered by the config sync, Icinga DB: zone membership, as considered for cluster message routing and check scheduling).

When discussing this internally, @N-o-X also said that there may be more places were information in Icinga DB where similar differences exist.

We therefore should document this, either as a full schema documentation that includes descriptions independent of the Icinga 2 documentation, or as a list of differences. Or possibly both, we'd have to decide what would be most helpful for users.

@julianbrost julianbrost added area/documentation Improvements or additions to documentation area/schema labels Apr 26, 2021
@julianbrost julianbrost changed the title Improve schema documentation (notably where it differens from the objects in Icinga 2) Improve schema documentation (notably where it differs from the objects in Icinga 2) Aug 9, 2021
@lippserd
Copy link
Member

I would say we add COMMENTs to the schema as we normally do now.

@lippserd lippserd added this to the v1.0.0-rc2 milestone Aug 12, 2021
@lippserd lippserd removed this from the v1.0.0-rc2 milestone Nov 12, 2021
@Al2Klimov
Copy link
Member

Apropos helpful for users, one already wants[1] a full doc, something like https://icinga.com/docs/icinga1/latest/en/db_model.html

[1] https://community.icinga.com/t/description-for-icingadbs-mysql-schema/12844/3?u=al2klimov

@oxzi
Copy link
Member

oxzi commented Aug 15, 2024

As just discussed with @lippserd, size limitations should be documented as well. For example, some columns are of the varchar(255) type because of the final size. This, of course, limits larger text, which should be noted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation area/schema
Projects
None yet
Development

No branches or pull requests

4 participants