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

Misleading variable names in Icinga 2 API feature #265

Open
tbauriedel opened this issue Feb 1, 2024 · 1 comment
Open

Misleading variable names in Icinga 2 API feature #265

tbauriedel opened this issue Feb 1, 2024 · 1 comment
Labels
breaking change This marks a breaking change docs Improvements or additions to documentation

Comments

@tbauriedel
Copy link
Member

As already discussed 'in real life' there are some variables with misleading names.

The variable ca_host inside the API feature for example is incorrect from an Icinga 2 technical point of view, as the "parent host" must be specified here in a distributed system with satellites. Naming to parent_host or similar would be more suitable.

Other examples are ca_host_port and icinga2_delegate_to.

As @mkayontour said, we need to make sure to have a transition phase for that. We could deprecate them and remove them in future versions.

@mkayontour mkayontour added docs Improvements or additions to documentation breaking change This marks a breaking change labels Feb 1, 2024
@mocdaniel
Copy link
Contributor

The way this feature works, ca_host is the correct name to go with, in my opinion, as the collection will indeed default to delegating the certificate creation to the ca_host.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change This marks a breaking change docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants