Fixes some docstring warnings
Some warnings related to whitespace, improper indentation, and improper use of literals are fixed. Change-Id: I86b245e44a48518ca077b4b84a09e7d72d372702 Partial-Bug: 1277282
This commit is contained in:
parent
5df3bd1dac
commit
0818ffd3b0
|
@ -276,8 +276,8 @@ class TaskManager(object):
|
|||
|
||||
:param event: the name of the event to process
|
||||
:param callback: optional callback to invoke upon event transition
|
||||
:param call_args: optional *args to pass to the callback method
|
||||
:param call_kwargs: optional **kwargs to pass to the callback method
|
||||
:param call_args: optional \*args to pass to the callback method
|
||||
:param call_kwargs: optional \**kwargs to pass to the callback method
|
||||
:param err_handler: optional error handler to invoke if the
|
||||
callback fails, eg. because there are no workers available
|
||||
(err_handler should accept arguments node, prev_prov_state, and
|
||||
|
|
|
@ -73,6 +73,7 @@ class BaseDHCP(object):
|
|||
'opt_value': '123.123.123.456'},
|
||||
{'opt_name': 'tftp-server',
|
||||
'opt_value': '123.123.123.123'}]
|
||||
|
||||
:param vifs: a dict of Neutron port dicts to update DHCP options on.
|
||||
The keys should be Ironic port UUIDs, and the values should be
|
||||
Neutron port UUIDs
|
||||
|
|
|
@ -90,7 +90,7 @@ class AgentAndVirtualBoxDriver(base.BaseDriver):
|
|||
|
||||
This driver implements the `core` functionality, combining
|
||||
:class:`ironic.drivers.modules.virtualbox.VirtualBoxPower` (for power
|
||||
on/off and reboot of VirtualBox virtual machines), with
|
||||
on/off and reboot of VirtualBox virtual machines), with
|
||||
:class:`ironic.drivers.modules.agent.AgentDeploy` (for image
|
||||
deployment). Implementations are in those respective classes; this class
|
||||
is merely the glue between them.
|
||||
|
|
|
@ -160,9 +160,11 @@ class AMTManagement(base.ManagementInterface):
|
|||
|
||||
:param task: a task from TaskManager.
|
||||
:returns: a dictionary containing:
|
||||
:boot_device: the boot device
|
||||
:persistent: Whether the boot device will persist to all
|
||||
|
||||
:boot_device: the boot device
|
||||
:persistent: Whether the boot device will persist to all
|
||||
future boots or not, None if it is unknown.
|
||||
|
||||
"""
|
||||
driver_internal_info = task.node.driver_internal_info
|
||||
device = driver_internal_info.get('amt_boot_device')
|
||||
|
|
|
@ -244,7 +244,7 @@ class AMTPower(base.PowerInterface):
|
|||
Turn the node power on or off.
|
||||
|
||||
:param task: a TaskManager instance contains the target node.
|
||||
:param pstate : The desired power state of the node.
|
||||
:param pstate: The desired power state of the node.
|
||||
:raises: PowerStateFailure if the power cannot set to pstate.
|
||||
:raises: AMTFailure.
|
||||
:raises: AMTConnectFailure.
|
||||
|
|
|
@ -765,8 +765,9 @@ class VendorPassthru(agent_base_vendor.BaseAgentVendor):
|
|||
then it sets provisioning as failed and powers off the node.
|
||||
|
||||
:param task: A TaskManager object.
|
||||
:param kwargs: The arguments sent with vendor passthru. The expected
|
||||
:param kwargs: The arguments sent with vendor passthru. The expected
|
||||
kwargs are::
|
||||
|
||||
'key': The deploy key for authorization
|
||||
'status': 'SUCCEEDED' or 'FAILED'
|
||||
'error': The error message if status == 'FAILED'
|
||||
|
@ -782,8 +783,9 @@ class VendorPassthru(agent_base_vendor.BaseAgentVendor):
|
|||
"""Continues the iSCSI deployment from where ramdisk left off.
|
||||
|
||||
This method continues the iSCSI deployment from the conductor node
|
||||
and writes the deploy image to the bare metal's disk. After that,
|
||||
and writes the deploy image to the bare metal's disk. After that,
|
||||
it does the following depending on boot_option for deploy:
|
||||
|
||||
- If the boot_option requested for this deploy is 'local', then it
|
||||
sets the node to boot from disk (ramdisk installs the boot loader
|
||||
present within the image to the bare metal's disk).
|
||||
|
|
|
@ -178,6 +178,7 @@ class IRMCManagement(ipmitool.IPMIManagement):
|
|||
:raises: MissingParameterValue if a required parameter is missing.
|
||||
:returns: Returns a consistent formatted dict of sensor data grouped
|
||||
by sensor type, which can be processed by Ceilometer.
|
||||
Example::
|
||||
|
||||
{
|
||||
'Sensor Type 1': {
|
||||
|
|
|
@ -98,9 +98,11 @@ class MSFTOCSManagement(base.ManagementInterface):
|
|||
|
||||
:param task: a task from TaskManager.
|
||||
:returns: a dictionary containing:
|
||||
|
||||
:boot_device: the boot device
|
||||
:persistent: Whether the boot device will persist to all
|
||||
future boots or not, None if it is unknown.
|
||||
|
||||
"""
|
||||
client, blade_id = msftocs_common.get_client_info(
|
||||
task.node.driver_info)
|
||||
|
|
|
@ -68,7 +68,7 @@ class MSFTOCSPower(base.PowerInterface):
|
|||
Turn the node power on or off.
|
||||
|
||||
:param task: a TaskManager instance contains the target node.
|
||||
:param pstate : The desired power state of the node.
|
||||
:param pstate: The desired power state of the node.
|
||||
:raises: PowerStateFailure if the power cannot set to pstate.
|
||||
:raises: InvalidParameterValue
|
||||
"""
|
||||
|
|
|
@ -570,13 +570,16 @@ class VendorPassthru(agent_base_vendor.BaseAgentVendor):
|
|||
successful, then it notifies the bare metal to proceed to reboot
|
||||
and makes the instance active. If the bootloader installation failed,
|
||||
then it sets provisioning as failed and powers off the node.
|
||||
|
||||
:param task: A TaskManager object.
|
||||
:param kwargs: The arguments sent with vendor passthru. The expected
|
||||
kwargs are::
|
||||
|
||||
'key': The deploy key for authorization
|
||||
'status': 'SUCCEEDED' or 'FAILED'
|
||||
'error': The error message if status == 'FAILED'
|
||||
'address': The IP address of the ramdisk
|
||||
|
||||
"""
|
||||
task.process_event('resume')
|
||||
LOG.debug('Continuing the deployment on node %s', task.node.uuid)
|
||||
|
|
|
@ -362,6 +362,6 @@ class VirtualBoxManagement(base.ManagementInterface):
|
|||
:raises: FailedToGetSensorData when getting the sensor data fails.
|
||||
:raises: FailedToParseSensorData when parsing sensor data fails.
|
||||
:returns: returns a consistent format dict of sensor data grouped by
|
||||
sensor type, which can be processed by Ceilometer.
|
||||
sensor type, which can be processed by Ceilometer.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
|
|
Loading…
Reference in New Issue