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

Fix inverted feature names #883

Open
andsens opened this issue Mar 6, 2025 · 2 comments
Open

Fix inverted feature names #883

andsens opened this issue Mar 6, 2025 · 2 comments
Milestone

Comments

@andsens
Copy link

andsens commented Mar 6, 2025

I would like to suggest renaming some loadbalancer annotations and their defaults in the upcoming v2.0.

The following annotations have negated names:

load-balancer.hetzner.cloud/ipv6-disabled (false)
load-balancer.hetzner.cloud/disable-public-network (false)
load-balancer.hetzner.cloud/disable-private-ingress (false)

Generally it is confusing to read code with negations, e.g. dontDoTheThing=false. It requires unnecessary brainpower to calculate whether that means that the thing is being done or not. So my suggestion would be to negate the names and the defaults:

load-balancer.hetzner.cloud/enable-ipv6 (true)
load-balancer.hetzner.cloud/use-public-network (true)
load-balancer.hetzner.cloud/allow-private-ingress (true)

I haven't checked whether there are other places where this would make sense.

@andsens
Copy link
Author

andsens commented Mar 6, 2025

Also, there is no real naming convention for boolean flags
Sometimes its <imperative-verb>-<thing> like use-private-ip, other times its uses-proxyprotocol, but there's also http-sticky-sessions

@lukasmetzner
Copy link
Contributor

Hey,

thank you for creating the issue. We already planned to revise configuration options, their naming, their defaults and also would like to introduce a proper config file as an alternative to a large set of environment variables. #656 is also related to this.

I will add this issue to the v2.0 milestone.

Best Regards,
Lukas

@lukasmetzner lukasmetzner added this to the v2.0.0 milestone Mar 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants