ironic.drivers.modules.agent_base.
AgentBaseMixin
[source]¶Bases: object
Mixin with base methods not relying on any deploy steps.
clean_up
(task)[source]¶Clean up the deployment environment for the task’s node.
Unlinks TFTP and instance images and triggers image cache cleanup. Removes the TFTP configuration files for this node.
Parameters: | task – a TaskManager instance containing the node to act on. |
---|
prepare_cleaning
(task)[source]¶Boot into the agent to prepare for cleaning.
Parameters: | task – a TaskManager object containing the node |
---|---|
Raises: | NodeCleaningFailure, NetworkError if the previous cleaning ports cannot be removed or if new cleaning ports cannot be created. |
Raises: | InvalidParameterValue if cleaning network UUID config option has an invalid value. |
Returns: | states.CLEANWAIT to signify an asynchronous prepare |
take_over
(task)[source]¶Take over management of this node from a dead conductor.
Parameters: | task – a TaskManager instance. |
---|
tear_down
(task)[source]¶Tear down a previous deployment on the task’s node.
Power off the node. All actual clean-up is done in the clean_up() method which should be called separately.
Parameters: | task – a TaskManager instance containing the node to act on. |
---|---|
Returns: | deploy state DELETED. |
Raises: | NetworkError if the cleaning ports cannot be removed. |
Raises: | InvalidParameterValue when the wrong state is specified or the wrong driver info is specified. |
Raises: | StorageError when volume detachment fails. |
Raises: | other exceptions by the node’s power driver if something wrong occurred during the power action. |
ironic.drivers.modules.agent_base.
AgentDeployMixin
[source]¶Bases: ironic.drivers.modules.agent_base.HeartbeatMixin
, ironic.drivers.modules.agent_base.AgentOobStepsMixin
Mixin with deploy methods.
configure_local_boot
(task, root_uuid=None, efi_system_part_uuid=None, prep_boot_part_uuid=None)[source]¶Helper method to configure local boot on the node.
This method triggers bootloader installation on the node. On successful installation of bootloader, this method sets the node to boot from disk.
Parameters: |
|
---|---|
Raises: | InstanceDeployFailure if bootloader installation failed or on encountering error while setting the boot device on the node. |
execute_clean_step
(task, step)[source]¶Execute a clean step asynchronously on the agent.
Parameters: |
|
---|---|
Raises: | NodeCleaningFailure if the agent does not return a command status |
Returns: | states.CLEANWAIT to signify the step will be completed async |
execute_deploy_step
(task, step)[source]¶Execute a deploy step.
We’re trying to find a step among both out-of-band and in-band steps. In case of duplicates, out-of-band steps take priority. This property allows having an out-of-band deploy step that calls into a corresponding in-band step after some preparation (e.g. with additional input).
Parameters: |
|
---|---|
Raises: | InstanceDeployFailure if the agent does not return a command status |
Returns: | states.DEPLOYWAIT to signify the step will be completed async |
get_clean_steps
(task)[source]¶Get the list of clean steps from the agent.
Parameters: | task – a TaskManager object containing the node |
---|---|
Raises: | NodeCleaningFailure – if the clean steps are not yet available (cached), for example, when a node has just been enrolled and has not been cleaned yet. |
Returns: | A list of clean step dictionaries |
get_deploy_steps
(task)[source]¶Get the list of deploy steps from the agent.
Parameters: | task – a TaskManager object containing the node |
---|---|
Raises: | InstanceDeployFailure – if the deploy steps are not yet available (cached), for example, when a node has just been enrolled and has not been deployed yet. |
Returns: | A list of deploy step dictionaries |
prepare_instance_to_boot
(task, root_uuid, efi_sys_uuid, prep_boot_part_uuid=None)[source]¶Prepares instance to boot.
Parameters: |
|
---|---|
Raises: | InvalidState if fails to prepare instance |
process_next_step
(task, step_type, **kwargs)[source]¶Start the next clean/deploy step if the previous one is complete.
In order to avoid errors and make agent upgrades painless, the agent compares the version of all hardware managers at the start of the process (the agent’s get_clean|deploy_steps() call) and before executing each step. If the version has changed between steps, the agent is unable to tell if an ordering change will cause an issue so it returns VERSION_MISMATCH. For automated cleaning, we restart the entire cleaning cycle. For manual cleaning or deploy, we don’t.
Additionally, if a step includes the reboot_requested property set to True, this method will coordinate the reboot once the step is completed.
reboot_and_finish_deploy
(task)[source]¶Helper method to trigger reboot on the node and finish deploy.
This method initiates a reboot on the node. On success, it marks the deploy as complete. On failure, it logs the error and marks deploy as failure.
Parameters: | task – a TaskManager object containing the node |
---|---|
Raises: | InstanceDeployFailure, if node reboot failed. |
refresh_steps
(task, step_type)[source]¶Refresh the node’s cached clean/deploy steps from the booted agent.
Gets the node’s steps from the booted agent and caches them. The steps are cached to make get_clean_steps() calls synchronous, and should be refreshed as soon as the agent boots to start cleaning/deploy or if cleaning is restarted because of a hardware manager version mismatch.
Parameters: |
|
---|---|
Raises: | NodeCleaningFailure or InstanceDeployFailure if the agent returns invalid results |
ironic.drivers.modules.agent_base.
AgentOobStepsMixin
[source]¶Bases: object
Mixin with out-of-band deploy steps.
ironic.drivers.modules.agent_base.
HeartbeatMixin
[source]¶Bases: object
Mixin class implementing heartbeat processing.
continue_cleaning
(task)[source]¶Start the next cleaning step if the previous one is complete.
Parameters: | task – a TaskManager instance |
---|
continue_deploy
(task)[source]¶Continues the deployment of baremetal node.
This method continues the deployment of the baremetal node after the ramdisk have been booted.
Parameters: | task – a TaskManager instance |
---|
deploy_has_started
(task)[source]¶Check if the deployment has started already.
Returns: | True if the deploy has started, False otherwise. |
---|
deploy_is_done
(task)[source]¶Check if the deployment is already completed.
Returns: | True if the deployment is completed. False otherwise |
---|
has_decomposed_deploy_steps
= False¶Whether the driver supports decomposed deploy steps.
Previously (since Rocky), drivers used a single ‘deploy’ deploy step on the deploy interface. Some additional steps were added for the ‘direct’ and ‘iscsi’ deploy interfaces in the Ussuri cycle, which means that more of the deployment flow is driven by deploy steps.
heartbeat
(task, callback_url, agent_version, agent_verify_ca=None)[source]¶Process a heartbeat.
Parameters: |
|
---|
heartbeat_allowed_states
¶Define node states where heartbeating is allowed
in_core_deploy_step
(task)[source]¶Check if we are in the deploy.deploy deploy step.
Assumes that we are in the DEPLOYWAIT state.
Parameters: | task – a TaskManager instance |
---|---|
Returns: | True if the current deploy step is deploy.deploy. |
process_next_step
(task, step_type)[source]¶Start the next clean/deploy step if the previous one is complete.
Parameters: |
|
---|
reboot_to_instance
(task)[source]¶Method invoked after the deployment is completed.
Parameters: | task – a TaskManager instance |
---|
ironic.drivers.modules.agent_base.
execute_step
(task, step, step_type, client=None)[source]¶Execute a clean or deploy step asynchronously on the agent.
Parameters: |
|
---|---|
Raises: | NodeCleaningFailure (clean step) or InstanceDeployFailure (deploy step) if the agent does not return a command status. |
Returns: | states.CLEANWAIT/DEPLOYWAIT to signify the step will be completed async |
ironic.drivers.modules.agent_base.
find_step
(task, step_type, interface, name)[source]¶Find the given in-band step.
ironic.drivers.modules.agent_base.
get_steps
(task, step_type, interface=None, override_priorities=None)[source]¶Get the list of cached clean or deploy steps from the agent.
The steps cache is updated at the beginning of cleaning or deploy.
Parameters: |
|
---|---|
Returns: | A list of clean/deploy step dictionaries |
ironic.drivers.modules.agent_base.
log_and_raise_deployment_error
(task, msg, collect_logs=True, exc=None)[source]¶Helper method to log the error and raise exception.
Parameters: |
|
---|
ironic.drivers.modules.agent_base.
post_clean_step_hook
(interface, step)[source]¶Decorator method for adding a post clean step hook.
This is a mechanism for adding a post clean step hook for a particular clean step. The hook will get executed after the clean step gets executed successfully. The hook is not invoked on failure of the clean step.
Any method to be made as a hook may be decorated with @post_clean_step_hook mentioning the interface and step after which the hook should be executed. A TaskManager instance and the object for the last completed command (provided by agent) will be passed to the hook method. The return value of this method will be ignored. Any exception raised by this method will be treated as a failure of the clean step and the node will be moved to CLEANFAIL state.
Parameters: |
|
---|---|
Returns: | A method which registers the given method as a post clean step hook. |
ironic.drivers.modules.agent_base.
post_deploy_step_hook
(interface, step)[source]¶Decorator method for adding a post deploy step hook.
This is a mechanism for adding a post deploy step hook for a particular deploy step. The hook will get executed after the deploy step gets executed successfully. The hook is not invoked on failure of the deploy step.
Any method to be made as a hook may be decorated with @post_deploy_step_hook mentioning the interface and step after which the hook should be executed. A TaskManager instance and the object for the last completed command (provided by agent) will be passed to the hook method. The return value of this method will be ignored. Any exception raised by this method will be treated as a failure of the deploy step and the node will be moved to DEPLOYFAIL state.
Parameters: |
|
---|---|
Returns: | A method which registers the given method as a post deploy step hook. |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.