Skip to content

Commit

Permalink
Merge pull request #2489 from ProbstDJakob/ovn-lb-provider-docs
Browse files Browse the repository at this point in the history
[occm] update docs in order to reflect the current state of the ovn lb-provider support
  • Loading branch information
zetaab authored Dec 28, 2023
2 parents ee06cc1 + ee055da commit 8dd55b3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Request Body:

Defines whether to create health monitor for the load balancer pool, if not specified, use `create-monitor` config. The health monitor can be created or deleted dynamically. A health monitor is required for services with `externalTrafficPolicy: Local`.

Not supported when `lb-provider=ovn` is configured in openstack-cloud-controller-manager.
NOTE: Health monitors for the `ovn` provider are only supported on OpenStack Wallaby and later.

- `loadbalancer.openstack.org/health-monitor-delay`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,17 @@ Although the openstack-cloud-controller-manager was initially implemented with N
Optional. Tags for the external network subnet used to create floating IP for the load balancer VIP. Can be overridden by the Service annotation `loadbalancer.openstack.org/floating-subnet-tags`. If multiple subnets match the first one with still available IPs is used.

* `lb-method`
The load balancing algorithm used to create the load balancer pool. The value can be `ROUND_ROBIN`, `LEAST_CONNECTIONS`, or `SOURCE_IP`. Default: `ROUND_ROBIN`
The load balancing algorithm used to create the load balancer pool.

If `lb-provider` is set to "amphora" or "octavia" the value can be one of:
* `ROUND_ROBIN` (default)
* `LEAST_CONNECTIONS`
* `SOURCE_IP`

If `lb-provider` is set to "ovn" the value must be set to `SOURCE_IP_PORT`.

* `lb-provider`
Optional. Used to specify the provider of the load balancer, e.g. "amphora" or "octavia". Only "amphora" or "octavia" provider are officially tested, other provider will cause a warning log.
Optional. Used to specify the provider of the load balancer, e.g. "amphora" (default), "octavia" (deprecated alias for "amphora"), or "ovn". Only the "amphora", "octavia", and "ovn" providers are officially tested, other providers will cause a warning log.

* `lb-version`
Optional. If specified, only "v2" is supported.
Expand All @@ -224,6 +231,8 @@ Although the openstack-cloud-controller-manager was initially implemented with N
* `create-monitor`
Indicates whether or not to create a health monitor for the service load balancer. A health monitor required for services that declare `externalTrafficPolicy: Local`. Default: false

NOTE: Health monitors for the `ovn` provider are only supported on OpenStack Wallaby and later.

* `monitor-delay`
The time, in seconds, between sending probes to members of the load balancer. Default: 5

Expand Down Expand Up @@ -295,8 +304,6 @@ Although the openstack-cloud-controller-manager was initially implemented with N
NOTE:
* When using `ovn` provider service has limited scope - `create_monitor` is not supported and only supported `lb-method` is `SOURCE_IP`.
* environment variable `OCCM_WAIT_LB_ACTIVE_STEPS` is used to provide steps of waiting loadbalancer to be ready. Current default wait steps is 23 and setup the environment variable overrides default value. Refer to [Backoff.Steps](https://pkg.go.dev/k8s.io/apimachinery/pkg/util/wait#Backoff) for further information.
### Metadata
Expand Down

0 comments on commit 8dd55b3

Please sign in to comment.