Skip to content

Doc: Admin/Usage Guide #745

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

Open
oxzi opened this issue Apr 19, 2024 · 2 comments · May be fixed by #950
Open

Doc: Admin/Usage Guide #745

oxzi opened this issue Apr 19, 2024 · 2 comments · May be fixed by #950
Assignees
Labels
area/documentation Improvements or additions to documentation enhancement New feature or request

Comments

@oxzi
Copy link
Member

oxzi commented Apr 19, 2024

This is mostly a loose idea I had while reading various topics, especially those in the community forum. The current documentation roughly describes Icinga DB, tells you how to install and configure it, but not really how to run it on a day-to-day basis.

For example, there's nothing about backups, and I haven't found anything in the Icinga 2 docs either. Next to a cron job running mysqldump, there may be some stumbling blocks with larger databases as shown in #742 where the mysqldump LOCK over a bigger database made Icinga DB crash.

These and other potential issues could be documented for others to find, but I don't think it will scale to put them between the lines of the configuration chapter.

Thus, I would like to start a more end user/admin focused documentation section about your daily life with Icinga DB.

@oxzi oxzi added area/documentation Improvements or additions to documentation enhancement New feature or request labels Apr 19, 2024
@lippserd
Copy link
Member

lippserd commented Apr 1, 2025

Things to consider when improving the documentation:

  • max_allowed_packet for MySQL/MariaDB should be large enough, e.g. 64M (which should be the default, but we have seen customers with lower values)
  • overcommit_memory=1 for Redis

@oxzi
Copy link
Member Author

oxzi commented Apr 3, 2025

Information regarding specific database setups may be useful. I am thinking about Galera (addressed in v1.2.0), ProxySQL (addressed in #750), Amazon RDS (reported in #929).

@oxzi oxzi self-assigned this Apr 23, 2025
oxzi added a commit that referenced this issue Apr 25, 2025
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.
@oxzi oxzi linked a pull request Apr 25, 2025 that will close this issue
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants