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

doc/03-Configuration.md: Environment Variables #897

Merged
merged 1 commit into from
Mar 26, 2025

Conversation

oxzi
Copy link
Member

@oxzi oxzi commented Mar 5, 2025

New ways to configure Icinga DB were introduced in #831 and Icinga/icinga-go-library#113. The first change allows configuring Icinga DB using environment variables instead of or next to the YAML configuration file. In addition, the second change allows setting certificates and keys as PEM-encoded strings next to referencing files. This was now documented.

As a structural change, the order of the Database and Redis sections were changed to reflect the order in the example configuration file.

Some words about the Logging Components were written, as the documentation previously that they exist.


Requires:

@oxzi oxzi added the area/documentation Improvements or additions to documentation label Mar 5, 2025
@oxzi oxzi added this to the 1.2.2 milestone Mar 5, 2025
@oxzi oxzi requested a review from lippserd March 5, 2025 14:11
@cla-bot cla-bot bot added the cla/signed label Mar 5, 2025
Copy link
Member

@lippserd lippserd left a comment

Choose a reason for hiding this comment

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

Looks solid and comprehensible, thank you very much. There is only one correction that needs to be made.

@oxzi oxzi force-pushed the docs-03-configuration-env-support branch from 49ecf4e to adffde9 Compare March 17, 2025 11:29
@oxzi oxzi requested a review from lippserd March 17, 2025 11:30
New ways to configure Icinga DB were introduced in [icingadb-831] and
[igl-113]. The first change allows configuring Icinga DB using
environment variables instead of or next to the YAML configuration file.
In addition, the second change allows setting certificates and keys as
PEM-encoded strings next to referencing files. This was now documented.

As a structural change, the order of the Database and Redis sections
were changed to reflect the order in the example configuration file.

Some words about the Logging Components were written, as the
documentation previously that they exist.

[icingadb-831]: #831
[igl-113]: Icinga/icinga-go-library#113
@oxzi oxzi force-pushed the docs-03-configuration-env-support branch from adffde9 to 701983a Compare March 17, 2025 11:33
Copy link
Member

@lippserd lippserd left a comment

Choose a reason for hiding this comment

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

This can be marked as ready for merging review from my side.

@lippserd lippserd marked this pull request as ready for review March 20, 2025 08:27
@lippserd lippserd merged commit d0ef6cf into main Mar 26, 2025
50 of 51 checks passed
@lippserd lippserd deleted the docs-03-configuration-env-support branch March 26, 2025 12:22
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.

2 participants