Skip to content

Fix documentation on global custom variables#10826

Merged
Al2Klimov merged 1 commit into
masterfrom
global-custom-vars-doc
Jul 1, 2026
Merged

Fix documentation on global custom variables#10826
Al2Klimov merged 1 commit into
masterfrom
global-custom-vars-doc

Conversation

@julianbrost

Copy link
Copy Markdown
Member

Global custom variables were moved from the global Vars constant to the vars attribute of the IcingaApplication object in v2.4 (84536da), however the documentation wasn't updated accordingly.

See #3238 for a bit of context of the change. The change was also mentioned in the v2.4.0 changelog:

* The global constants Enable* and Vars have been removed. Use the IcingaApplication object attributes instead.

This commit updates the documentation accordingly. The vars attribute of IcingaApplication is already documented in 09-object-types.md, so no addition for this is needed.

There is still a reference in 24-appendix.md that I left unchanged because it is related to the IDO, which is deprecated and scheduled for removal in v2.18, so I didn't bother checking what the IDO actually does in respect to global custom variables.

Global custom variables were moved from the global `Vars` constant to the
`vars` attribute of the `IcingaApplication` object in v2.4
(84536da), however the documentation wasn't
updated accordingly.

This commit updates the documentation accordingly. The `vars` attribute of
`IcingaApplication` is already documented in `09-object-types.md`, so no
addition for this is needed.

There is still a reference in `24-appendix.md` that I left unchanged because it
is related to the IDO, which is deprecated and scheduled for removal in v2.18,
so I didn't bother checking what the IDO actually does in respect to global
custom variables.
@julianbrost julianbrost added this to the 2.17.0 milestone Apr 27, 2026
@julianbrost julianbrost added the area/documentation End-user or developer help label Apr 27, 2026
@cla-bot cla-bot Bot added the cla/signed label Apr 27, 2026
@Al2Klimov Al2Klimov merged commit 4fef250 into master Jul 1, 2026
55 of 57 checks passed
@Al2Klimov Al2Klimov deleted the global-custom-vars-doc branch July 1, 2026 08:34
@julianbrost

Copy link
Copy Markdown
Member Author

By the way, if anyone wonder how on earth I came across that topic: while writing this blog post for icinga.com, I initially thought I would want to make use of these global custom variables, but later noticed that I can also achieve the same without using them.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants