openstack/ironic
Code Issues Proposed changes

Merge "Clean up CIMC driver docs and comments"

Browse Source
This commit is contained in:
Jenkins 2015-09-22 02:28:37 +00:00 committed by Gerrit Code Review
commit 6be0a3d78f
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/drivers/cimc.rst
View File

@ -43,7 +43,7 @@ Install the ``ImcSdk`` module
#. Install it:: #. Install it::
$ cd ImcSdk-0.7.1 $ cd ImcSdk-0.7.1
$ python setup.py install $ sudo python setup.py install
Tested Platforms Tested Platforms
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@ -53,10 +53,10 @@ This driver works with UCS C-Series servers and has been tested with:
Configuring and Enabling the driver Configuring and Enabling the driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Add ``pxe_cimc`` and/or ``agent_cimc`` to the list of ``enabled_drivers`` in 1. Add ``pxe_iscsi_cimc`` and/or ``pxe_agent_cimc`` to the list of ``enabled_drivers`` in
``/etc/ironic/ironic.conf``. For example:: ``/etc/ironic/ironic.conf``. For example::
enabled_drivers = pxe_ipmitool,pxe_cimc,agent_cimc enabled_drivers = pxe_ipmitool,pxe_iscsi_cimc,pxe_agent_cimc
2. Restart the Ironic conductor service: 2. Restart the Ironic conductor service:
@ -68,8 +68,8 @@ Configuring and Enabling the driver
$ sudo systemctl restart openstack-ironic-conductor $ sudo systemctl restart openstack-ironic-conductor
Registering Standalone UCS node in Ironic Registering CIMC Managed UCS node in Ironic
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Nodes configured for CIMC driver should have the ``driver`` property set to Nodes configured for CIMC driver should have the ``driver`` property set to
``pxe_iscsi_cimc`` or ``pxe_agent_cimc``. The following configuration values are ``pxe_iscsi_cimc`` or ``pxe_agent_cimc``. The following configuration values are
also required in ``driver_info``: also required in ``driver_info``:
@ -77,14 +77,14 @@ also required in ``driver_info``:
- ``cimc_address``: IP address or hostname for CIMC - ``cimc_address``: IP address or hostname for CIMC
- ``cimc_username``: CIMC login user name - ``cimc_username``: CIMC login user name
- ``cimc_password``: CIMC login password for the above CIMC user. - ``cimc_password``: CIMC login password for the above CIMC user.
- ``deploy_kernel``: The Glance UUID of the deployment kernel. - ``deploy_kernel``: Identifier for the deployment kernel e.g. a Glance UUID
- ``deploy_ramdisk``: The Glance UUID of the deployment ramdisk. - ``deploy_ramdisk``: Identifier for the deployment ramdisk e.g. a Glance UUID
The following sequence of commands can be used to enroll a UCS Standalone node. The following sequence of commands can be used to enroll a UCS Standalone node.
Create Node:: Create Node::
ironic node-create -d <pxe_cimc/agent_cimc> -i cimc_address=<CIMC hostname/ip-address> -i cimc_username=<cimc_username> -i cimc_password=<cimc_password> -i deploy_kernel=<glance_uuid_of_deploy_kernel> -i deploy_ramdisk=<glance_uuid_of_deploy_ramdisk> -p cpus=<number_of_cpus> -p memory_mb=<memory_size_in_MB> -p local_gb=<local_disk_size_in_GB> -p cpu_arch=<cpu_arch> ironic node-create -d <pxe_iscsi_cimc OR pxe_agent_cimc> -i cimc_address=<CIMC hostname OR ip-address> -i cimc_username=<cimc_username> -i cimc_password=<cimc_password> -i deploy_kernel=<glance_uuid_of_deploy_kernel> -i deploy_ramdisk=<glance_uuid_of_deploy_ramdisk> -p cpus=<number_of_cpus> -p memory_mb=<memory_size_in_MB> -p local_gb=<local_disk_size_in_GB> -p cpu_arch=<cpu_arch>
The above command 'ironic node-create' will return UUID of the node, which is the value of $NODE in the following command. The above command 'ironic node-create' will return UUID of the node, which is the value of $NODE in the following command.

2
driver-requirements.txt
View File

@ -27,5 +27,5 @@ UcsSdk==0.8.2.2
# http://docs.openstack.org/developer/ironic/drivers/vbox.html # http://docs.openstack.org/developer/ironic/drivers/vbox.html
pyremotevbox>=0.5.0 pyremotevbox>=0.5.0
# The CIMC drivers use the Cisco IMC SDK version 0.7.1, which is avaliable from # The CIMC drivers use the Cisco IMC SDK version 0.7.1, which is available from
# https://communities.cisco.com/docs/DOC-37174 # https://communities.cisco.com/docs/DOC-37174

2
ironic/common/exception.py
View File

@ -593,4 +593,4 @@ class ImageUploadFailed(IronicException):
class CIMCException(IronicException): class CIMCException(IronicException):
message = _("Cisco IMC exception occured for node %(node)s: %(error)s") message = _("Cisco IMC exception occurred for node %(node)s: %(error)s")

4
ironic/drivers/modules/cimc/common.py
View File

@ -34,7 +34,7 @@ LOG = logging.getLogger(__name__)
def parse_driver_info(node): def parse_driver_info(node):
"""Parses and creates Cisco driver info """Parses and creates Cisco driver info.
:param node: An Ironic node object. :param node: An Ironic node object.
:returns: dictionary that contains node.driver_info parameter/values. :returns: dictionary that contains node.driver_info parameter/values.
@ -71,7 +71,7 @@ def handle_login(task, handle, info):
@contextmanager @contextmanager
def cimc_handle(task): def cimc_handle(task):
"""Context manager for creating a CIMC handle and logging into it """Context manager for creating a CIMC handle and logging into it.
:param task: The current task object. :param task: The current task object.
:raises: CIMCException if login fails :raises: CIMCException if login fails