"Fossies" - the Fresh Open Source Software Archive

Member "octavia-8.0.0/doc/source/user/feature-classification/feature-matrix-pool.ini" (14 Apr 2021, 8780 Bytes) of package /linux/misc/openstack/octavia-8.0.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) INI source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

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