AbstractNetworkDriver
[source]¶Bases: object
This class defines the methods for a fully functional network driver.
Implementations of this interface can expect a rollback to occur if any of the non-nullipotent methods raise an exception.
allocate_vip
(load_balancer)[source]¶Allocates a virtual ip.
Reserves it for later use as the frontend connection of a load balancer.
load_balancer – octavia.common.data_models.LoadBalancer instance
octavia.common.data_models.VIP
AllocateVIPException, PortNotFound, SubnetNotFound
deallocate_vip
(vip)[source]¶Removes any resources that reserved this virtual ip.
vip – octavia.common.data_models.VIP instance
None
DeallocateVIPException, VIPInUseException, VIPConfiigurationNotFound
failover_preparation
(amphora)[source]¶Prepare an amphora for failover.
amphora – amphora object to failover
None
PortNotFound
get_network
(network_id, context=None)[source]¶Retrieves network from network id.
network_id – id of an network to retrieve
context – A request context
octavia.network.data_models.Network
NetworkException, NetworkNotFound
get_network_by_name
(network_name)[source]¶Retrieves network from network name.
network_name – name of a network to retrieve
octavia.network.data_models.Network
NetworkException, NetworkNotFound
get_network_configs
(load_balancer, amphora=None)[source]¶Retrieve network configurations
This method assumes that a dictionary of AmphoraNetworkConfigs keyed off of the related amphora id are returned. The configs contain data pertaining to each amphora that is later used for finalization of the entire load balancer configuration. The data provided to these configs is left up to the driver, this means the driver is responsible for providing data that is appropriate for the amphora network configurations.
Example return: {<amphora.id>: <AmphoraNetworkConfig>}
load_balancer – The load_balancer configuration
amphora – Optional amphora to only query.
dict of octavia.network.data_models.AmphoraNetworkConfig keyed off of the amphora id the config is associated with.
NotFound, NetworkNotFound, SubnetNotFound, PortNotFound
get_network_ip_availability
(network)[source]¶Retrieves network IP availability.
network – octavia.network.data_models.Network
octavia.network.data_models.Network_IP_Availability
NetworkException, NetworkNotFound
get_plugged_networks
(compute_id)[source]¶Retrieves the current plugged networking configuration.
compute_id – id of an amphora in the compute service
[octavia.network.data_models.Instance]
get_port
(port_id, context=None)[source]¶Retrieves port from port id.
port_id – id of a port to retrieve
context – A request context
octavia.network.data_models.Port
NetworkException, PortNotFound
get_port_by_name
(port_name)[source]¶Retrieves port from port name.
port_name – name of a port to retrieve
octavia.network.data_models.Port
NetworkException, PortNotFound
get_port_by_net_id_device_id
(network_id, device_id)[source]¶Retrieves port from network id and device id.
network_id – id of a network to filter by
device_id – id of a network device to filter by
octavia.network.data_models.Port
NetworkException, PortNotFound
get_subnet
(subnet_id, context=None)[source]¶Retrieves subnet from subnet id.
subnet_id – id of a subnet to retrieve
context – A request context
octavia.network.data_models.Subnet
NetworkException, SubnetNotFound
get_subnet_by_name
(subnet_name)[source]¶Retrieves subnet from subnet name.
subnet_name – name of a subnet to retrieve
octavia.network.data_models.Subnet
NetworkException, SubnetNotFound
plug_aap_port
(load_balancer, vip, amphora, subnet)[source]¶Plugs the AAP port to the amp
load_balancer – Load Balancer to prepare the VIP for
vip – The VIP to plug
amphora – The amphora to plug the VIP into
subnet – The subnet to plug the aap into
plug_network
(compute_id, network_id, ip_address=None)[source]¶Connects an existing amphora to an existing network.
compute_id – id of an amphora in the compute service
network_id – id of a network
ip_address – ip address to attempt to be assigned to interface
octavia.network.data_models.Interface instance
PlugNetworkException, AmphoraNotFound, NetworkNotFound
plug_port
(amphora, port)[source]¶Plug a neutron port in to a compute instance
amphora – amphora object to plug the port into
port – port to plug into the compute instance
None
PlugNetworkException, AmphoraNotFound, NetworkNotFound
plug_vip
(load_balancer, vip)[source]¶Plugs a virtual ip as the frontend connection of a load balancer.
Sets up the routing of traffic from the vip to the load balancer and its amphorae.
load_balancer – octavia.common.data_models.LoadBalancer instance
vip – octavia.common.data_models.VIP instance
dict consisting of amphora_id as key and bind_ip as value. bind_ip is the ip that the amphora should listen on to receive traffic to load balance.
PlugVIPException, PortNotFound
unplug_aap_port
(vip, amphora, subnet)[source]¶Unplugs the AAP port to the amp
vip – The VIP to plug
amphora – The amphora to plug the VIP into
subnet – The subnet to plug the aap into
unplug_network
(compute_id, network_id, ip_address=None)[source]¶Disconnects an existing amphora from an existing network.
If ip_address is not specificed, all the interfaces plugged on network_id should be unplugged.
compute_id – id of an amphora in the compute service
network_id – id of a network
ip_address – specific ip_address to unplug
None
UnplugNetworkException, AmphoraNotFound, NetworkNotFound, NetworkException
unplug_vip
(load_balancer, vip)[source]¶Unplugs a virtual ip as the frontend connection of a load balancer.
Removes the routing of traffic from the vip to the load balancer and its amphorae.
load_balancer – octavia.common.data_models.LoadBalancer instance
vip – octavia.common.data_models.VIP instance
octavia.common.data_models.VIP instance
UnplugVIPException, PluggedVIPNotFound
update_vip
(load_balancer, for_delete)[source]¶Hook for the driver to update the VIP information.
This method will be called upon the change of a load_balancer configuration. It is an optional method to be implemented by drivers. It allows the driver to update any VIP information based on the state of the passed in load_balancer.
load_balancer – octavia.common.data_models.LoadBalancer instance
for_delete – Boolean indicating if this update is for a delete
MissingVIPSecurityGroup
None
update_vip_sg
(load_balancer, vip)[source]¶Updates the security group for a VIP
load_balancer – Load Balancer to rpepare the VIP for
vip – The VIP to plug
wait_for_port_detach
(amphora)[source]¶Waits for the amphora ports device_id to be unset.
This method waits for the ports on an amphora device_id parameter to be ‘’ or None which signifies that nova has finished detaching the port from the instance.
amphora – Amphora to wait for ports to detach.
None
TimeoutException – Port did not detach in interval.
PortNotFound – Port was not found by neutron.
AmphoraNetworkConfig
(amphora=None, vip_subnet=None, vip_port=None, vrrp_subnet=None, vrrp_port=None, ha_subnet=None, ha_port=None)[source]¶FloatingIP
(id=None, description=None, project_id=None, status=None, router_id=None, port_id=None, floating_network_id=None, floating_ip_address=None, fixed_ip_address=None, fixed_port_id=None)[source]¶Network
(id=None, name=None, subnets=None, project_id=None, admin_state_up=None, mtu=None, provider_network_type=None, provider_physical_network=None, provider_segmentation_id=None, router_external=None)[source]¶Network_IP_Availability
(network_id=None, tenant_id=None, project_id=None, network_name=None, total_ips=None, used_ips=None, subnet_ip_availability=None)[source]¶Port
(id=None, name=None, device_id=None, device_owner=None, mac_address=None, network_id=None, status=None, project_id=None, admin_state_up=None, fixed_ips=None, network=None, qos_policy_id=None)[source]¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.