# octavia.amphorae.drivers package

## Subpackages

- octavia.amphorae.drivers.haproxy package
  - Submodules
  - octavia.amphorae.drivers.haproxy.data_models module
  - octavia.amphorae.drivers.haproxy.exceptions module
  - octavia.amphorae.drivers.haproxy.rest_api_driver module
  - Module contents
- octavia.amphorae.drivers.health package
  - Submodules
  - octavia.amphorae.drivers.health.heartbeat_udp module
  - Module contents
- octavia.amphorae.drivers.keepalived package
  - Subpackages
    - octavia.amphorae.drivers.keepalived.jinja package
      - Submodules
      - octavia.amphorae.drivers.keepalived.jinja.jinja_cfg module
      - Module contents
  - Submodules
  - octavia.amphorae.drivers.keepalived.vrrp_rest_driver module
  - Module contents
- octavia.amphorae.drivers.noop_driver package
  - Submodules
  - octavia.amphorae.drivers.noop_driver.driver module
  - Module contents

## Submodules

## octavia.amphorae.drivers.driver_base module

class `AmphoraLoadBalancerDriver`

  Bases: `object`

  `delete`(listener)

    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)

    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)

    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)

    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)

    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)

    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)

    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.

  `start_health_check`(health_mixin)

    Start health checks.

    Parameters: | health_mixin (HealthMixin) – health mixin object

    Starts listener process and calls HealthMixin to update databases information.

  `stop_health_check`()

    Stop health checks.

    Stops listener process and calls HealthMixin to update databases information.

  `update`(loadbalancer)

    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)

    Upload and update the amphora agent configuration.

    Parameters:

    - amphora (octavia.db.models.Amphora) – amphora object, needs id and network ip(s)
    - agent_config (string) – The new amphora agent configuration file.

  `update_amphora_listeners`(loadbalancer, amphora, timeout_dict)

    Update the amphora with a new configuration.

    Parameters:

    - loadbalancer (list(octavia.db.models.Listener)) – List of listeners to update.
    - amphora (octavia.db.models.Amphora) – The index of the specific amphora to update
    - timeout_dict (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

    Builds a new configuration, pushes it to the amphora, and reloads the listener on one amphora.

  `upload_cert_amp`(amphora, pem_file)

    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.

class `HealthMixin`

  Bases: `object`

  `update_health`(health)

    Return ceilometer ready health

    Parameters: | health (bool) – health information emitted from the amphora
    Returns: | return health

    At this moment, we just build the basic structure for testing, will add more function along with the development, eventually, we want it return: map: {“amphora-status”:HEALTHY, loadbalancers: {“loadbalancer-id”: {“loadbalancer-status”: HEALTHY, “listeners”:{“listener-id”:{“listener-status”:HEALTHY, “nodes”:{“node-id”:HEALTHY, …}}, …}, …}} only items whose health has changed need to be submitted awesome update code

class `StatsMixin`

  Bases: `object`

  `update_stats`(stats)

    Return ceilometer ready stats

    Parameters: | stats (string) – statistic information emitted from the amphora
    Returns: | return stats

    At this moment, we just build the basic structure for testing, will add more function along with the development, eventually, we want it return: uses map {“loadbalancer-id”:{“listener-id”: {“bytes-in”: 123, “bytes_out”:123, “active_connections”:123, “total_connections”, 123}, …} elements are named to keep it extsnsible for future versions awesome update code and code to send to ceilometer

class `VRRPDriverMixin`

  Bases: `object`

  Abstract mixin class for VRRP support in loadbalancer amphorae

  Usage: To plug VRRP support in another service driver XYZ, use: @plug_mixin(XYZ) class XYZ: …

  `get_vrrp_interface`(amphora)

    Get the VRRP interface object for a specific amphora

    Parameters: | amphora – amphora object

  `reload_vrrp_service`(loadbalancer)

    Reload the VRRP services of all amphorae of the loadbalancer

    Parameters: | loadbalancer – loadbalancer object

  `start_vrrp_service`(loadbalancer)

    Start the VRRP services of all amphorae of the loadbalancer

    Parameters: | loadbalancer – loadbalancer object

  `stop_vrrp_service`(loadbalancer)

    Stop the vrrp services running on the loadbalancer’s amphorae

    Parameters: | loadbalancer – loadbalancer object

  `update_vrrp_conf`(loadbalancer)

    Update amphorae of the loadbalancer with a new VRRP configuration

    Parameters: | loadbalancer – loadbalancer object

## Module contents

this page last updated: 2020-04-10 18:17:54

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug questions?