1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
# 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/ovn-octavia-provider/latest/admin/driver.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 pool.
cli=openstack loadbalancer pool create [--enable | --disable] --listener <listener>
driver.amphora=complete
driver.ovn=complete
[operation.alpn_protocol]
title=alpn_protocol
status=optional
notes=List of accepted ALPN protocols (can be set multiple times).
cli=openstack loadbalancer pool create [--alpn-protocol <protocol>] --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.ca_tls_container_ref]
title=ca_tls_container_ref
status=optional
notes=The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
cli=openstack loadbalancer pool create [--ca-tls-container-ref <ca_tls_container_ref>] --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.crl_container_ref]
title=crl_container_ref
status=optional
notes=The reference of the key manager service secret containing a PEM format CA revocation list file for tls_enabled pools.
cli=openstack loadbalancer pool create [--crl-container-ref <crl_container_ref>] --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.lb_algorithm.LEAST_CONNECTIONS]
title=lb_algorithm - LEAST_CONNECTIONS
notes=The pool will direct connections to the member server with the least connections in use.
cli=openstack loadbalancer pool create --lb-algorithm LEAST_CONNECTIONS --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.lb_algorithm.ROUND_ROBIN]
title=lb_algorithm - ROUND_ROBIN
notes=The pool will direct connections to the next member server, one after the other, rotating through the available member servers.
cli=openstack loadbalancer pool create --lb-algorithm ROUND_ROBIN --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.lb_algorithm.SOURCE_IP]
title=lb_algorithm - SOURCE_IP
notes=The pool will direct connections to the member server based on a hash of the source IP.
cli=openstack loadbalancer pool create --lb-algorithm SOURCE_IP --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.lb_algorithm.SOURCE_IP_PORT]
title=lb_algorithm - SOURCE_IP_PORT
notes=The pool will direct connections to the member server based on a hash of the source IP and Port.
cli=openstack loadbalancer pool create --lb-algorithm SOURCE_IP_PORT --listener <listener>
driver.amphora=missing
driver.ovn=complete
[operation.description]
title=description
status=optional
notes=The description of the pool. Provided by the Octavia API service.
cli=openstack loadbalancer pool create [--description <description>] --listener <listener>
driver.amphora=complete
driver.ovn=complete
[operation.name]
title=name
status=optional
notes=The name of the pool. Provided by the Octavia API service.
cli=openstack loadbalancer pool create [--name <name>] --listener <listener>
driver.amphora=complete
driver.ovn=complete
[operation.protocol.HTTP]
title=protocol - HTTP
status=optional
notes=HTTP protocol support for the pool.
cli=openstack loadbalancer pool create --protocol HTTP --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.protocol.HTTPS]
title=protocol - HTTPS
status=optional
notes=HTTPS protocol support for the pool.
cli=openstack loadbalancer pool create --protocol HTTP --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.protocol.PROXY]
title=protocol - PROXY
status=optional
notes=PROXY protocol support for the pool.
cli=openstack loadbalancer pool create --protocol PROXY --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.protocol.PROXYV2]
title=protocol - PROXYV2
status=optional
notes=PROXY protocol version 2 support for the pool.
cli=openstack loadbalancer pool create --protocol PROXYV2 --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.protocol.TCP]
title=protocol - TCP
status=optional
notes=TCP protocol support for the pool.
cli=openstack loadbalancer pool create --protocol TCP --listener <listener>
driver.amphora=complete
driver.ovn=complete
[operation.protocol.UDP]
title=protocol - UDP
status=optional
notes=UDP protocol support for the pool.
cli=openstack loadbalancer pool create --protocol UDP --listener <listener>
driver.amphora=complete
driver.ovn=complete
[operation.protocol.SCTP]
title=protocol - SCTP
status=optional
notes=SCTP protocol support for the pool.
cli=openstack loadbalancer pool create --protocol SCTP --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.session_persistence.APP_COOKIE]
title=session_persistence - APP_COOKIE
status=optional
notes=Session persistence using an application supplied cookie.
cli=openstack loadbalancer pool create --session-persistence type=APP_COOKIE --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.session_persistence.cookie_name]
title=session_persistence - cookie_name
status=optional
notes=The name of the application cookie to use for session persistence.
cli=openstack loadbalancer pool create --session-persistence cookie_name=chocolate --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.session_persistence.HTTP_COOKIE]
title=session_persistence - HTTP_COOKIE
status=optional
notes=Session persistence using a cookie created by the load balancer.
cli=openstack loadbalancer pool create --session-persistence type=HTTP_COOKIE --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.session_persistence.persistence_timeout]
title=session_persistence - persistence_timeout
status=optional
notes=The timeout, in seconds, after which a SCTP or UDP flow may be rescheduled to a different member.
cli=openstack loadbalancer pool create --session-persistence persistence_timeout=360 --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.session_persistence.persistence_granularity]
title=session_persistence - persistence_granularity
status=optional
notes=The netmask used to determine SCTP or UDP SOURCE_IP session persistence.
cli=openstack loadbalancer pool create --session-persistence persistence_granularity=255.255.255.255 --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.session_persistence.SOURCE_IP]
title=session_persistence - SOURCE_IP
status=optional
notes=Session persistence using the source IP address.
cli=openstack loadbalancer pool create --session-persistence type=SOURCE_IP --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.tags]
title=tags
status=optional
notes=The tags for the pool. Provided by the Octavia API service.
cli=openstack loadbalancer pool create [--tag <tag>] --listener <listener>
driver.amphora=complete
driver.ovn=complete
[operation.tls_ciphers]
title=tls_ciphers
status=optional
notes=List of TLS ciphers available for member connections.
cli=openstack loadbalancer pool create [--tls-ciphers <ciphers>] --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.tls_container_ref]
title=tls_container_ref
status=optional
notes=The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for tls_enabled pools for TLS client authentication to the member servers.
cli=openstack loadbalancer pool create [--tls-container-ref <container-ref>] --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.tls_enabled]
title=tls_enabled
status=optional
notes=When true connections to backend member servers will use TLS encryption.
cli=openstack loadbalancer pool create [--enable-tls] --listener <listener>
driver.amphora=complete
driver.ovn=missing
[operation.tls_versions]
title=tls_versions
status=optional
notes=List of TLS protocol versions available for member connections.
cli=openstack loadbalancer pool create [--tls-versions <versions>] --listener <listener>
driver.amphora=complete
driver.ovn=missing
|
