octavia.amphorae.drivers.haproxy package¶
Submodules¶
octavia.amphorae.drivers.haproxy.data_models module¶
-
class
Details
(hostname=None, uuid=None, version=None, api_version=None, network_tx=None, network_rx=None, active=None, haproxy_count=None, cpu=None, memory=None, disk=None, load=None, listeners=None, packages=None)[source]¶
-
class
ListenerStatus
(status=None, uuid=None, provisioning_status=None, type=None, pools=None)[source]¶
-
class
Memory
(total=None, free=None, available=None, buffers=None, cached=None, swap_used=None, shared=None, slab=None, committed_as=None)[source]¶
octavia.amphorae.drivers.haproxy.exceptions module¶
-
exception
APIException
(**kwargs)[source]¶ Bases:
webob.exc.HTTPClientError
-
code
= 500¶
-
msg
= 'Something unknown went wrong'¶
-
-
exception
Conflict
(**kwargs)[source]¶ Bases:
octavia.amphorae.drivers.haproxy.exceptions.APIException
-
code
= 409¶
-
msg
= 'Conflict'¶
-
-
exception
Forbidden
(**kwargs)[source]¶ Bases:
octavia.amphorae.drivers.haproxy.exceptions.APIException
-
code
= 403¶
-
msg
= 'Forbidden'¶
-
-
exception
InternalServerError
(**kwargs)[source]¶ Bases:
octavia.amphorae.drivers.haproxy.exceptions.APIException
-
code
= 500¶
-
msg
= 'Internal Server Error'¶
-
-
exception
InvalidRequest
(**kwargs)[source]¶ Bases:
octavia.amphorae.drivers.haproxy.exceptions.APIException
-
code
= 400¶
-
msg
= 'Invalid request'¶
-
-
exception
NotFound
(**kwargs)[source]¶ Bases:
octavia.amphorae.drivers.haproxy.exceptions.APIException
-
code
= 404¶
-
msg
= 'Not Found'¶
-
octavia.amphorae.drivers.haproxy.rest_api_driver module¶
-
class
AmphoraAPIClient0_5
[source]¶ Bases:
octavia.amphorae.drivers.haproxy.rest_api_driver.AmphoraAPIClientBase
-
class
AmphoraAPIClient1_0
[source]¶ Bases:
octavia.amphorae.drivers.haproxy.rest_api_driver.AmphoraAPIClientBase
-
class
CustomHostNameCheckingAdapter
(pool_connections=10, pool_maxsize=10, max_retries=0, pool_block=False)[source]¶ Bases:
requests.adapters.HTTPAdapter
-
cert_verify
(conn, url, verify, cert)[source]¶ Verify a SSL certificate. This method should not be called from user code, and is only exposed for use when subclassing the
HTTPAdapter
.Parameters: - conn – The urllib3 connection object associated with the cert.
- url – The requested URL.
- verify – Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use
- cert – The SSL certificate to verify.
-
init_poolmanager
(*pool_args, **pool_kwargs)[source]¶ Initializes a urllib3 PoolManager.
This method should not be called from user code, and is only exposed for use when subclassing the
HTTPAdapter
.Parameters: - connections – The number of urllib3 connection pools to cache.
- maxsize – The maximum number of connections to save in the pool.
- block – Block when no free connections are available.
- pool_kwargs – Extra keyword arguments used to initialize the Pool Manager.
-
-
class
HaproxyAmphoraLoadBalancerDriver
[source]¶ Bases:
octavia.amphorae.drivers.driver_base.AmphoraLoadBalancerDriver
,octavia.amphorae.drivers.keepalived.vrrp_rest_driver.KeepalivedAmphoraDriverMixin
-
delete
(listener)[source]¶ Delete the listener on the vip.
Parameters: listener (octavia.db.models.Listener) – listener object, need to use its protocol_port property Returns: return a value list (listener, vip, status flag–delete) At this moment, we just build the basic structure for testing, will add more function along with the development.
-
finalize_amphora
(amphora)[source]¶ Finalize the amphora before any listeners are configured.
Parameters: amphora (octavia.db.models.Amphora) – amphora object, need to use its id property Returns: None At this moment, we just build the basic structure for testing, will add more function along with the development. This is a hook for drivers who need to do additional work before an amphora becomes ready to accept listeners. Please keep in mind that amphora might be kept in an offline pool after this call.
-
get_diagnostics
(amphora)[source]¶ Return ceilometer ready diagnostic data.
Parameters: amphora (octavia.db.models.Amphora) – amphora object, need to use its id property Returns: return a value list (amphora.id, status flag–‘ge t_diagnostics’) At this moment, we just build the basic structure for testing, will add more function along with the development, eventually, we want it run some expensive self tests to determine if the amphora and the lbs are healthy the idea is that those tests are triggered more infrequent than the health gathering.
-
get_info
(amphora, raise_retry_exception=False)[source]¶ Returns information about the amphora.
Parameters: - amphora (octavia.db.models.Amphora) – amphora object, need to use its id property
- raise_retry_exception – Flag if outside task should be retried
Returns: return a value list (amphora.id, status flag–‘info’)
At this moment, we just build the basic structure for testing, will add more function along with the development, eventually, we want it to return information as: {“Rest Interface”: “1.0”, “Amphorae”: “1.0”, “packages”:{“ha proxy”:”1.5”}} some information might come from querying the amphora
-
post_network_plug
(amphora, port)[source]¶ Called after amphora added to network
Parameters: - amphora (octavia.db.models.Amphora) – amphora object, needs id and network ip(s)
- port (octavia.network.data_models.Port) – contains information of the plugged port
This method is optional to implement. After adding an amphora to a network, there may be steps necessary on the amphora to allow it to access said network. Ex: creating an interface on an amphora for a neutron network to utilize.
-
post_vip_plug
(amphora, load_balancer, amphorae_network_config, vrrp_port=None, vip_subnet=None)[source]¶ Called after network driver has allocated and plugged the VIP
Parameters: - amphora (octavia.db.models.Amphora) –
- load_balancer (octavia.common.data_models.LoadBalancer) – A load balancer that just had its vip allocated and plugged in the network driver.
- amphorae_network_config – A data model containing information about the subnets and ports that an amphorae owns.
- vrrp_port (octavia.network.data_models.Port) – VRRP port associated with the load balancer
- vip_subnet (octavia.network.data_models.Subnet) – VIP subnet associated with the load balancer
Returns: None
This is to do any additional work needed on the amphorae to plug the vip, such as bring up interfaces.
-
start
(loadbalancer, amphora=None)[source]¶ Start the listeners on the amphora.
Parameters: - loadbalancer (octavia.db.models.LoadBalancer) – loadbalancer object to start listeners
- amphora (octavia.db.models.Amphora) – Amphora to start. If None, start on all amphora
Returns: return a value list (listener, vip, status flag–enable)
At this moment, we just build the basic structure for testing, will add more function along with the development.
-
update
(loadbalancer)[source]¶ Update the amphora with a new configuration.
Parameters: loadbalancer (octavia.db.models.LoadBalancer) – loadbalancer object, need to use its vip.ip_address property Returns: None At this moment, we just build the basic structure for testing, will add more function along with the development.
-
update_amphora_agent_config
(amphora, agent_config, timeout_dict=None)[source]¶ Update the amphora agent configuration file.
Parameters: - amphora (object) – The amphora to update.
- agent_config (string) – The new amphora agent configuration.
- timeout_dict – Dictionary of timeout values for calls to the amphora. May contain: req_conn_timeout, req_read_timeout, conn_max_retries, conn_retry_interval
Returns: None
- Note: This will mutate the amphora agent config and adopt the
- new values.
-
update_amphora_listeners
(loadbalancer, amphora, timeout_dict=None)[source]¶ Update the amphora with a new configuration.
Parameters: - loadbalancer (object) – The load balancer to update
- amphora (object) – The amphora to update
- timeout_dict – Dictionary of timeout values for calls to the amphora. May contain: req_conn_timeout, req_read_timeout, conn_max_retries, conn_retry_interval
Returns: None
Updates the configuration of the listeners on a single amphora.
-
upload_cert_amp
(amp, pem)[source]¶ Upload cert info to the amphora.
Parameters: - amphora (octavia.db.models.Amphora) – amphora object, needs id and network ip(s)
- pem_file (file object) – a certificate file
Upload cert file to amphora for Controller Communication.
-