acdf1dc772
Updates ironic documentation to change "openstack baremetal" to "baremetal" Change-Id: I95afa010aeb4fb08aff05adf0cfb7a200db8a53f Story: #2008194 Task: #40962
69 lines
1.9 KiB
ReStructuredText
69 lines
1.9 KiB
ReStructuredText
Developing a new Deploy Step
|
|
============================
|
|
|
|
To support customized deployment step, implement a new method in an interface
|
|
class and use the decorator ``deploy_step`` defined in
|
|
``ironic/drivers/base.py``. For example, we will implement a ``do_nothing``
|
|
deploy step in the ``AgentDeploy`` class.
|
|
|
|
.. code-block:: python
|
|
|
|
class AgentDeploy(AgentDeployMixin, base.DeployInterface):
|
|
...
|
|
|
|
@base.deploy_step(priority=200, argsinfo={
|
|
'test_arg': {
|
|
'description': (
|
|
"This is a test argument."
|
|
),
|
|
'required': True
|
|
}
|
|
})
|
|
def do_nothing(self, task, **kwargs):
|
|
return None
|
|
|
|
After deployment of the baremetal node, check the updated deploy steps::
|
|
|
|
baremetal node show $node_ident -f json -c driver_internal_info
|
|
|
|
The above command outputs the ``driver_internal_info`` as following::
|
|
|
|
{
|
|
"driver_internal_info": {
|
|
...
|
|
"deploy_steps": [
|
|
{
|
|
"priority": 200,
|
|
"interface": "deploy",
|
|
"step": "do_nothing",
|
|
"argsinfo":
|
|
{
|
|
"test_arg":
|
|
{
|
|
"required": True,
|
|
"description": "This is a test argument."
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"priority": 100,
|
|
"interface": "deploy",
|
|
"step": "deploy",
|
|
"argsinfo": null
|
|
}
|
|
],
|
|
"deploy_step_index": 1
|
|
}
|
|
}
|
|
|
|
.. note::
|
|
|
|
Similarly, clean steps can be implemented using the ``clean_step``
|
|
decorator.
|
|
|
|
In-band deploy steps (deploy steps that are run inside the ramdisk) have to be
|
|
implemented in a custom :ironic-python-agent-doc:`IPA hardware manager
|
|
<contributor/hardware_managers.html#custom-hardwaremanagers-and-deploying>`.
|
|
All in-band deploy steps must have priorities between 41 and 99, see
|
|
:ref:`node-deployment-core-steps` for details.
|