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: fix lxc network load-balancer backend add command syntax #14643

Merged
merged 1 commit into from
Dec 12, 2024

Conversation

minaelee
Copy link
Contributor

This PR removes an unnecessary <listen_ports> option in the syntax for lxc network load-balancer backend add. This is correct in the man page but incorrect in the how-to guide this PR fixes. There is no listen_ports backend property. listen_ports is a port property that is used in lxc network load-balancer port add.

@github-actions github-actions bot added the Documentation Documentation needs updating label Dec 12, 2024
@minaelee
Copy link
Contributor Author

minaelee commented Dec 12, 2024

@tomponline: I'm also concerned about this line that appears in the docs, right under the syntax for lxc network load-balancer backend add:

The target ports are optional. If not specified, the load balancer will use the listen ports for the backend for the backend target ports.

Since we've established that there are is no listen_port property of the load balancer backend, only of the load balancer port, the phrase listen ports for the backend doesn't seem applicable. Should this read ...the listen ports defined in the load balancer port properties... instead?

This line in the source seems to indicate that is the case. That the target ports, if not specified, fall back to the listen ports on the NetworkLoadBalancerPort.

If that's true, would I be correct to assume that whenever a backend is created, if no port options (such as listen_port) are configured explicitly, there is a default set of port options configured on the load balancer that includes a listen_port?

@tomponline tomponline merged commit aee54e3 into canonical:main Dec 12, 2024
25 checks passed
@tomponline
Copy link
Member

@tomponline: I'm also concerned about this line that appears in the docs, right under the syntax for lxc network load-balancer backend add:

The target ports are optional. If not specified, the load balancer will use the listen ports for the backend for the backend target ports.

Since we've established that there are is no listen_port property of the load balancer backend, only of the load balancer port, the phrase listen ports for the backend doesn't seem applicable. Should this read ...the listen ports defined in the load balancer port properties... instead?

This line in the source seems to indicate that is the case. That the target ports, if not specified, fall back to the listen ports on the NetworkLoadBalancerPort.

If that's true, would I be correct to assume that whenever a backend is created, if no port options (such as listen_port) are configured explicitly, there is a default set of port options configured on the load balancer that includes a listen_port?

Yeah I agree.

Suggest something like

The target ports are optional. If not specified, the load balancer listener ports will be used for the backend target ports.

If that's true, would I be correct to assume that whenever a backend is created, if no port options (such as listen_port) are configured explicitly, there is a default set of port options configured on the load balancer that includes a listen_port?

No thats not correct, creating a load balancer simply reserves a listen IP (and no ports) then listen ports are added using:

lxc network load-balancer port add

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants