icingadb icon indicating copy to clipboard operation
icingadb copied to clipboard

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

Open julianbrost opened this issue 4 years ago • 3 comments

In https://github.com/Icinga/icinga2/pull/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 avatar Apr 26 '21 10:04 julianbrost

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

lippserd avatar Aug 12 '21 07:08 lippserd

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

Al2Klimov avatar Nov 09 '23 09:11 Al2Klimov

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.

oxzi avatar Aug 15 '24 15:08 oxzi