Skip to content

docs: Icinga DB Setup for every Distribution#10481

Merged
oxzi merged 1 commit intomasterfrom
docs-02-installation-icingadb-for-everyone
Jul 3, 2025
Merged

docs: Icinga DB Setup for every Distribution#10481
oxzi merged 1 commit intomasterfrom
docs-02-installation-icingadb-for-everyone

Conversation

@oxzi
Copy link
Member

@oxzi oxzi commented Jun 18, 2025

Within the GNU/Linux distribution specific installation guides, the "Set up Icinga DB" section was only excluded for openSUSE. However, since there is an openSUSE installation guide within Icinga DB1, this is not consistent. Thus, the if-guard was removed, resulting in this section being available for each distribution. Windows is already excluded through an if-guard above.

Some cases for Fedora were missing, which were also added.

Footnotes

  1. https://icinga.com/docs/icinga-db/latest/doc/02-Installation/openSUSE/

@oxzi oxzi added the area/documentation End-user or developer help label Jun 18, 2025
@cla-bot cla-bot bot added the cla/signed label Jun 18, 2025
Copy link
Member

@Al2Klimov Al2Klimov left a comment

Choose a reason for hiding this comment

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

Indeed, https://icinga.com/docs/icinga-db/latest/doc/02-Installation/openSUSE/ is a thing now and you seem to have undisabled the correct section. But the latter doesn't even contain "openSUSE", in contrast to other OS.

@oxzi
Copy link
Member Author

oxzi commented Jul 3, 2025

But the latter doesn't even contain "openSUSE", in contrast to other OS.

@Al2Klimov: Could you please rephrase your comment? Unfortunately, I failed to understand your objection.

I have just build the docs on this PR locally and compared the installation sections for each distribution. There is one diff: The "Set up Icinga DB" section is now available for openSUSE, as intended.

@Al2Klimov
Copy link
Member

Ok and how does the section look like now for openSUSE?

Within the GNU/Linux distribution specific installation guides, the "Set
up Icinga DB" section was only excluded for openSUSE. However, since
there is an openSUSE installation guide within Icinga DB[^0], this is
not consistent. Thus, the if-guard was removed, resulting in this
section being available for each distribution. Windows is already
excluded through an if-guard above.

Some cases for Fedora were missing, which were also added.

[^0]: https://icinga.com/docs/icinga-db/latest/doc/02-Installation/openSUSE/
@oxzi oxzi force-pushed the docs-02-installation-icingadb-for-everyone branch from 7ef69b7 to 950c801 Compare July 3, 2025 13:44
@oxzi
Copy link
Member Author

oxzi commented Jul 3, 2025

Ok and how does the section look like now for openSUSE?

Exactly like for every other distribution.

Click here for an ridiculous long screenshot

Screenshot 2025-07-03 at 15-46-47 OpenSUSE - Icinga 2

However, thanks to your Socratic questioning I realized cases for openSUSE and also Fedora were missing, which I have now added. Assuming you were aiming in this direction. Otherwise, please formulate your specific problem with the state of this PR.


<!-- {% if sles or opensuse %} -->
<!-- {% if not icingaDocs %} -->
##### SLES / openSUSE
Copy link
Member

Choose a reason for hiding this comment

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

While we're on combining multiple OS in one section,

Copy link
Member Author

Choose a reason for hiding this comment

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

We are already using common "SLES / openSUSE" sections at other places. I am just mimicking current behavior.

<!-- {% if sles or opensuse %} -->
<!-- {% if not icingaDocs %} -->
#### SLES / openSUSE
<!-- {% endif %} -->
```bash
zypper install icinga2
```
<!-- {% endif %} -->

Copy link
Member

Choose a reason for hiding this comment

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

I know and I agree.

##### Fedora
<!-- {% endif %} -->
```bash
dnf install icingadb-redis
Copy link
Member

Choose a reason for hiding this comment

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

why not here, too? The command is the same as for RHEL.

Copy link
Member Author

Choose a reason for hiding this comment

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

Following my prior comment, at other places Fedora and RHEL are separated. Thus, I am following this pattern here as well.

<!-- {% if rhel %} -->
#### RHEL 8 or Later
```bash
dnf install icinga2
systemctl enable icinga2
systemctl start icinga2
```
<!-- {% endif %} -->
<!-- {% if fedora %} -->
<!-- {% if not icingaDocs %} -->
#### Fedora
<!-- {% endif %} -->
```bash
dnf install icinga2
systemctl enable icinga2
systemctl start icinga2
```
<!-- {% endif %} -->

Copy link
Member

@Al2Klimov Al2Klimov left a comment

Choose a reason for hiding this comment

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

This is fine.

@oxzi oxzi enabled auto-merge July 3, 2025 14:53
@oxzi oxzi added this to the 2.16.0 milestone Jul 3, 2025
@oxzi oxzi merged commit a13751d into master Jul 3, 2025
25 checks passed
@oxzi oxzi deleted the docs-02-installation-icingadb-for-everyone branch July 3, 2025 15:50
@Al2Klimov Al2Klimov added the consider backporting Should be considered for inclusion in a bugfix release label Jan 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation End-user or developer help cla/signed consider backporting Should be considered for inclusion in a bugfix release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants