octavia.controller.worker package¶

Subpackages¶

Submodules¶

octavia.controller.worker.amphora_rate_limit module¶

class AmphoraBuildRateLimit[source]¶

Bases: object

add_to_build_request_queue(amphora_id, build_priority)[source]¶

has_build_slot()[source]¶

has_highest_priority(amphora_id)[source]¶

remove_all_from_build_req_queue()[source]¶

remove_from_build_req_queue(amphora_id)[source]¶

update_build_status_and_available_build_slots(amphora_id)[source]¶

wait_for_build_slot(amphora_id)[source]¶

octavia.controller.worker.controller_worker module¶

class ControllerWorker[source]¶

Bases: octavia.common.base_taskflow.BaseTaskFlowEngine

amphora_cert_rotation(amphora_id)[source]¶

Perform cert rotation for an amphora.

Parameters:	amphora_id – ID for amphora to rotate
Returns:	None
Raises:	AmphoraNotFound – The referenced amphora was not found

batch_update_members(old_member_ids, new_member_ids, updated_members)[source]¶

create_amphora()[source]¶

Creates an Amphora.

This is used to create spare amphora.

Returns:	amphora_id

create_health_monitor(health_monitor_id)[source]¶

Creates a health monitor.

Parameters:	pool_id – ID of the pool to create a health monitor on
Returns:	None
Raises:	NoResultFound – Unable to find the object

create_l7policy(l7policy_id)[source]¶

Creates an L7 Policy.

Parameters:	l7policy_id – ID of the l7policy to create
Returns:	None
Raises:	NoResultFound – Unable to find the object

create_l7rule(l7rule_id)[source]¶

Creates an L7 Rule.

Parameters:	l7rule_id – ID of the l7rule to create
Returns:	None
Raises:	NoResultFound – Unable to find the object

create_listener(listener_id)[source]¶

Creates a listener.

Parameters:	listener_id – ID of the listener to create
Returns:	None
Raises:	NoResultFound – Unable to find the object

create_load_balancer(load_balancer_id)[source]¶

Creates a load balancer by allocating Amphorae.

First tries to allocate an existing Amphora in READY state. If none are available it will attempt to build one specifically for this load balancer.

Parameters:	load_balancer_id – ID of the load balancer to create
Returns:	None
Raises:	NoResultFound – Unable to find the object

create_member(member_id)[source]¶

Creates a pool member.

Parameters:	member_id – ID of the member to create
Returns:	None
Raises:	NoSuitablePool – Unable to find the node pool

create_pool(pool_id)[source]¶

Creates a node pool.

Parameters:	pool_id – ID of the pool to create
Returns:	None
Raises:	NoResultFound – Unable to find the object

delete_amphora(amphora_id)[source]¶

Deletes an existing Amphora.

Parameters:	amphora_id – ID of the amphora to delete
Returns:	None
Raises:	AmphoraNotFound – The referenced Amphora was not found

delete_health_monitor(health_monitor_id)[source]¶

Deletes a health monitor.

Parameters:	pool_id – ID of the pool to delete its health monitor
Returns:	None
Raises:	HMNotFound – The referenced health monitor was not found

delete_l7policy(l7policy_id)[source]¶

Deletes an L7 policy.

Parameters:	l7policy_id – ID of the l7policy to delete
Returns:	None
Raises:	L7PolicyNotFound – The referenced l7policy was not found

delete_l7rule(l7rule_id)[source]¶

Deletes an L7 rule.

Parameters:	l7rule_id – ID of the l7rule to delete
Returns:	None
Raises:	L7RuleNotFound – The referenced l7rule was not found

delete_listener(listener_id)[source]¶

Deletes a listener.

Parameters:	listener_id – ID of the listener to delete
Returns:	None
Raises:	ListenerNotFound – The referenced listener was not found

delete_load_balancer(load_balancer_id, cascade=False)[source]¶

Deletes a load balancer by de-allocating Amphorae.

Parameters:	load_balancer_id – ID of the load balancer to delete
Returns:	None
Raises:	LBNotFound – The referenced load balancer was not found

delete_member(member_id)[source]¶

Deletes a pool member.

Parameters:	member_id – ID of the member to delete
Returns:	None
Raises:	MemberNotFound – The referenced member was not found

delete_pool(pool_id)[source]¶

Deletes a node pool.

Parameters:	pool_id – ID of the pool to delete
Returns:	None
Raises:	PoolNotFound – The referenced pool was not found

failover_amphora(amphora_id)[source]¶

Perform failover operations for an amphora.

Parameters:	amphora_id – ID for amphora to failover
Returns:	None
Raises:	AmphoraNotFound – The referenced amphora was not found

failover_loadbalancer(load_balancer_id)[source]¶

Perform failover operations for a load balancer.

Parameters:	load_balancer_id – ID for load balancer to failover
Returns:	None
Raises:	LBNotFound – The referenced load balancer was not found

update_health_monitor(health_monitor_id, health_monitor_updates)[source]¶

Updates a health monitor.

Parameters:	pool_id – ID of the pool to have it’s health monitor updated health_monitor_updates – Dict containing updated health monitor
Returns:	None
Raises:	HMNotFound – The referenced health monitor was not found

update_l7policy(l7policy_id, l7policy_updates)[source]¶

Updates an L7 policy.

Parameters:	l7policy_id – ID of the l7policy to update l7policy_updates – Dict containing updated l7policy attributes
Returns:	None
Raises:	L7PolicyNotFound – The referenced l7policy was not found

update_l7rule(l7rule_id, l7rule_updates)[source]¶

Updates an L7 rule.

Parameters:	l7rule_id – ID of the l7rule to update l7rule_updates – Dict containing updated l7rule attributes
Returns:	None
Raises:	L7RuleNotFound – The referenced l7rule was not found

update_listener(listener_id, listener_updates)[source]¶

Updates a listener.

Parameters:	listener_id – ID of the listener to update listener_updates – Dict containing updated listener attributes
Returns:	None
Raises:	ListenerNotFound – The referenced listener was not found

update_load_balancer(load_balancer_id, load_balancer_updates)[source]¶

Updates a load balancer.

Parameters:	load_balancer_id – ID of the load balancer to update load_balancer_updates – Dict containing updated load balancer
Returns:	None
Raises:	LBNotFound – The referenced load balancer was not found

update_member(member_id, member_updates)[source]¶

Updates a pool member.

Parameters:	member_id – ID of the member to update member_updates – Dict containing updated member attributes
Returns:	None
Raises:	MemberNotFound – The referenced member was not found

update_pool(pool_id, pool_updates)[source]¶

Updates a node pool.

Parameters:	pool_id – ID of the pool to update pool_updates – Dict containing updated pool attributes
Returns:	None
Raises:	PoolNotFound – The referenced pool was not found

octavia.controller.worker.task_utils module¶

Methods common to the controller work tasks.

class TaskUtils(**kwargs)[source]¶

Bases: object

Class of helper/utility methods used by tasks.

get_current_loadbalancer_from_db(loadbalancer_id)[source]¶

Gets a Loadbalancer from db.

Param:	loadbalancer_id: Load balancer ID which to get from db

mark_amphora_status_error(amphora_id)[source]¶

Sets an amphora status to ERROR.

NOTE: This should only be called from revert methods.

Parameters:	amphora_id – Amphora ID to set the status to ERROR

mark_health_mon_prov_status_error(health_mon_id)[source]¶

Sets a health monitor provisioning status to ERROR.

NOTE: This should only be called from revert methods.

Parameters:	health_mon_id – Health Monitor ID to set prov status to ERROR

mark_l7policy_prov_status_error(l7policy_id)[source]¶

Sets a L7 policy provisioning status to ERROR.

NOTE: This should only be called from revert methods.

Parameters:	l7policy_id – L7 Policy ID to set provisioning status to ERROR

mark_l7rule_prov_status_error(l7rule_id)[source]¶

Sets a L7 rule provisioning status to ERROR.

NOTE: This should only be called from revert methods.

Parameters:	l7rule_id – L7 Rule ID to set provisioning status to ERROR

mark_listener_prov_status_active(listener_id)[source]¶

Sets a listener provisioning status to ACTIVE.

NOTE: This should only be called from revert methods.

Parameters:	listener_id – Listener ID to set provisioning status to ACTIVE

mark_listener_prov_status_error(listener_id)[source]¶

Sets a listener provisioning status to ERROR.

NOTE: This should only be called from revert methods.

Parameters:	listener_id – Listener ID to set provisioning status to ERROR

mark_loadbalancer_prov_status_active(loadbalancer_id)[source]¶

Sets a load balancer provisioning status to ACTIVE.

NOTE: This should only be called from revert methods.

Parameters:	loadbalancer_id – Load balancer ID to set provisioning status to ACTIVE

mark_loadbalancer_prov_status_error(loadbalancer_id)[source]¶

Sets a load balancer provisioning status to ERROR.

NOTE: This should only be called from revert methods.

Parameters:	loadbalancer_id – Load balancer ID to set provisioning status to ERROR

mark_member_prov_status_error(member_id)[source]¶

Sets a member provisioning status to ERROR.

NOTE: This should only be called from revert methods.

Parameters:	member_id – Member ID to set provisioning status to ERROR

mark_pool_prov_status_active(pool_id)[source]¶

Sets a pool provisioning status to ACTIVE.

NOTE: This should only be called from revert methods.

Parameters:	pool_id – Pool ID to set provisioning status to ACTIVE

mark_pool_prov_status_error(pool_id)[source]¶

Sets a pool provisioning status to ERROR.

NOTE: This should only be called from revert methods.

Parameters:	pool_id – Pool ID to set provisioning status to ERROR

unmark_amphora_health_busy(amphora_id)[source]¶

Unmark the amphora_health record busy for an amphora.

NOTE: This should only be called from revert methods.

Parameters:	amphora_id – The amphora id to unmark busy

Module contents¶