bc19e07923
The api documentation is now published on docs.openstack.org instead of developer.openstack.org. Update all links that are changed to the new location. Note that redirects will be set up as well but let's point now to the new location. For details, see: http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html Change-Id: I9f617159eddc8af532403e47c325048d92cc9ade
112 lines
3.4 KiB
INI
112 lines
3.4 KiB
INI
# Copyright (c) 2019 Red Hat, Inc.
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
[driver.amphora]
|
|
title=Amphora Provider
|
|
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html
|
|
|
|
[driver.ovn]
|
|
title=OVN Provider
|
|
link=https://docs.openstack.org/networking-ovn/latest/admin/loadbalancer.html
|
|
|
|
# Note: These should be in the order they appear in a create call.
|
|
|
|
[operation.admin_state_up]
|
|
title=admin_state_up
|
|
status=mandatory
|
|
notes=Enables and disables the member.
|
|
cli=openstack loadbalancer member create [--enable | --disable] <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=complete
|
|
|
|
[operation.address]
|
|
title=address
|
|
status=mandatory
|
|
notes=The IP address for the member.
|
|
cli=openstack loadbalancer member create --address <ip_address> <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=complete
|
|
|
|
[operation.backup]
|
|
title=backup
|
|
status=optional
|
|
notes=True if the member is a backup member server.
|
|
cli=openstack loadbalancer member create [--enable-backup] <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=missing
|
|
|
|
[operation.batch]
|
|
title=Batch update members
|
|
status=mandatory
|
|
notes=Ability to update the members of a pool in one API call.
|
|
driver.amphora=complete
|
|
driver.ovn=partial
|
|
driver-notes.ovn=The OVN provider does not support all of the member features.
|
|
|
|
[operation.monitor_address]
|
|
title=monitor_address
|
|
status=optional
|
|
notes=An alternate IP address used for health monitoring a backend member.
|
|
cli=openstack loadbalancer member create [--monitor-address <monitor_address>] <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=missing
|
|
|
|
[operation.monitor_port]
|
|
title=monitor_port
|
|
status=optional
|
|
notes=An alternate protocol port used for health monitoring a backend member.
|
|
cli=openstack loadbalancer member create [--monitor-port <monitor_port>] <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=missing
|
|
|
|
[operation.name]
|
|
title=name
|
|
status=optional
|
|
notes=The name for the member. Provided by the Octavia API service.
|
|
cli=openstack loadbalancer member create [--name <name>] <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=complete
|
|
|
|
[operation.protocol_port]
|
|
title=protocol_port
|
|
status=mandatory
|
|
notes=The protocol port number to connect with on the member server.
|
|
cli=openstack loadbalancer member create --protocol_port <protocol_port> <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=complete
|
|
|
|
[operation.subnet_id]
|
|
title=subnet_id
|
|
status=optional
|
|
notes=The subnet ID the member service is accessible from.
|
|
cli=openstack loadbalancer member create [--subnet-id <subnet_id>] <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=complete
|
|
|
|
[operation.tags]
|
|
title=tags
|
|
status=optional
|
|
notes=The tags for the member. Provided by the Octavia API service.
|
|
cli=openstack loadbalancer member create [--tag <tag>] <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=complete
|
|
|
|
[operation.weight]
|
|
title=weight
|
|
status=optional
|
|
notes=The weight of a member determines the portion of requests or connections it services compared to the other members of the pool.
|
|
cli=openstack loadbalancer member create [--weight <weight>] <pool>
|
|
driver.amphora=complete
|
|
driver.ovn=missing
|