Skip to content

Conversation

oxzi
Copy link
Member

@oxzi oxzi commented Apr 25, 2025

doc/01-About.md: Big Picture

Inspired by the "Big Picture" section in the Icinga Notifications
documentation[^0], such a section was introduced for Icinga DB as well.
It aims to describe the essential components in an Icinga DB setup along
the architecture diagram for novice users. This hopefully helps new
users to understand what Icinga DB actually is and how it interconnects.

[^0]: https://icinga.com/docs/icinga-notifications/latest/#big-picture

doc/03-Configuration.md: Mention forced log events

The logging was slightly modified in #920, resulting in a few log
messages being shown regardless of the user configured log level. Since
this may not be the expected behavior, it is now mentioned in the docs.

doc/07-Operations.md: New Operations section

The newly introduced Operations section is a first attempt at an
operational Icinga DB documentation.

It covers
- essential Icinga DB monitoring,
- backups and corner cases for MySQL/MariaDB,
- optional systemd service restarts after failures,
- MySQL/MariaDB configuration options, including AWS RDS and Galera,
- and memory overcommitment for Redis.

As such a section can never be completed, this documentation is a target
for continuous improvement.

Fixes #745.

Fixes #745.

@oxzi oxzi added the area/documentation Improvements or additions to documentation label Apr 25, 2025
@cla-bot cla-bot bot added the cla/signed label Apr 25, 2025
@oxzi oxzi changed the title Bugfix week docs docs docs Doc: Big Picture Overview, Forced Logs, Operations Apr 25, 2025
@julianbrost julianbrost requested a review from Copilot April 25, 2025 13:09
Copilot

This comment was marked as spam.

@oxzi oxzi force-pushed the bugfix-week-docs-docs-docs branch from efbbaa2 to 26170f2 Compare May 7, 2025 07:55
@oxzi oxzi requested a review from theFeu May 7, 2025 07:55
Copy link
Contributor

@theFeu theFeu left a comment

Choose a reason for hiding this comment

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

I added some comments with suggestions for minor improvements :)
This reads well and is very nicely done. Thank you!

oxzi added 2 commits May 7, 2025 14:02
Inspired by the "Big Picture" section in the Icinga Notifications
documentation[^0], such a section was introduced for Icinga DB as well.
It aims to describe the essential components in an Icinga DB setup along
the architecture diagram for novice users. This hopefully helps new
users to understand what Icinga DB actually is and how it interconnects.

[^0]: https://icinga.com/docs/icinga-notifications/latest/#big-picture
The logging was slightly modified in #920, resulting in a few log
messages being shown regardless of the user configured log level. Since
this may not be the expected behavior, it is now mentioned in the docs.
@oxzi oxzi force-pushed the bugfix-week-docs-docs-docs branch from 26170f2 to 308e9d1 Compare May 7, 2025 12:03
@oxzi oxzi requested a review from theFeu May 7, 2025 12:05
theFeu
theFeu previously approved these changes May 7, 2025
Copy link
Contributor

@theFeu theFeu left a comment

Choose a reason for hiding this comment

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

👍

The newly introduced Operations section is a first attempt at an
operational Icinga DB documentation.

It covers
- essential Icinga DB monitoring,
- backups and corner cases for MySQL/MariaDB,
- MySQL/MariaDB configuration options, including AWS RDS and Galera,
- and memory overcommitment for Redis.

As such a section can never be completed, this documentation is a target
for continuous improvement.

Fixes #745.
@oxzi oxzi force-pushed the bugfix-week-docs-docs-docs branch from 308e9d1 to d8f42a3 Compare May 7, 2025 13:56
@oxzi oxzi requested a review from julianbrost May 7, 2025 13:59
@julianbrost julianbrost merged commit cfee820 into main May 9, 2025
31 checks passed
@julianbrost julianbrost deleted the bugfix-week-docs-docs-docs branch May 9, 2025 14:00
@oxzi oxzi added this to the 1.4.0 milestone May 9, 2025
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 cla/signed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: Admin/Usage Guide
3 participants