From 564fdf67c4c95c6a812dc25d76df670ae0370052 Mon Sep 17 00:00:00 2001 From: Sam Betts Date: Mon, 21 Sep 2015 18:20:25 +0100 Subject: Clean up CIMC driver docs and comments Based on comments on the original commit, this patch fixes a few minor issues that were picked up. Change-Id: If71680ac37558caa76cd0e0dae610967485e8a48 Implements: blueprint cisco-imc-pxe-driver --- doc/source/drivers/cimc.rst | 16 ++++++++-------- driver-requirements.txt | 2 +- ironic/common/exception.py | 2 +- ironic/drivers/modules/cimc/common.py | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/source/drivers/cimc.rst b/doc/source/drivers/cimc.rst index b7c22efa9..583e29df6 100644 --- a/doc/source/drivers/cimc.rst +++ b/doc/source/drivers/cimc.rst @@ -43,7 +43,7 @@ Install the ``ImcSdk`` module #. Install it:: $ cd ImcSdk-0.7.1 - $ python setup.py install + $ sudo python setup.py install Tested Platforms ~~~~~~~~~~~~~~~~ @@ -53,10 +53,10 @@ This driver works with UCS C-Series servers and has been tested with: 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:: - enabled_drivers = pxe_ipmitool,pxe_cimc,agent_cimc + enabled_drivers = pxe_ipmitool,pxe_iscsi_cimc,pxe_agent_cimc 2. Restart the Ironic conductor service: @@ -68,8 +68,8 @@ Configuring and Enabling the driver $ 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 ``pxe_iscsi_cimc`` or ``pxe_agent_cimc``. The following configuration values are also required in ``driver_info``: @@ -77,14 +77,14 @@ also required in ``driver_info``: - ``cimc_address``: IP address or hostname for CIMC - ``cimc_username``: CIMC login user name - ``cimc_password``: CIMC login password for the above CIMC user. -- ``deploy_kernel``: The Glance UUID of the deployment kernel. -- ``deploy_ramdisk``: The Glance UUID of the deployment ramdisk. +- ``deploy_kernel``: Identifier for the deployment kernel e.g. a Glance UUID +- ``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. Create Node:: - ironic node-create -d -i cimc_address= -i cimc_username= -i cimc_password= -i deploy_kernel= -i deploy_ramdisk= -p cpus= -p memory_mb= -p local_gb= -p cpu_arch= + ironic node-create -d -i cimc_address= -i cimc_username= -i cimc_password= -i deploy_kernel= -i deploy_ramdisk= -p cpus= -p memory_mb= -p local_gb= -p cpu_arch= The above command 'ironic node-create' will return UUID of the node, which is the value of $NODE in the following command. diff --git a/driver-requirements.txt b/driver-requirements.txt index 692c7e062..e0294437f 100644 --- a/driver-requirements.txt +++ b/driver-requirements.txt @@ -27,5 +27,5 @@ UcsSdk==0.8.2.2 # http://docs.openstack.org/developer/ironic/drivers/vbox.html 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 diff --git a/ironic/common/exception.py b/ironic/common/exception.py index 3eb83cbaa..13273bf9f 100644 --- a/ironic/common/exception.py +++ b/ironic/common/exception.py @@ -593,4 +593,4 @@ class ImageUploadFailed(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") diff --git a/ironic/drivers/modules/cimc/common.py b/ironic/drivers/modules/cimc/common.py index 1340477d4..6b8c6ac3f 100644 --- a/ironic/drivers/modules/cimc/common.py +++ b/ironic/drivers/modules/cimc/common.py @@ -34,7 +34,7 @@ LOG = logging.getLogger(__name__) def parse_driver_info(node): - """Parses and creates Cisco driver info + """Parses and creates Cisco driver info. :param node: An Ironic node object. :returns: dictionary that contains node.driver_info parameter/values. @@ -71,7 +71,7 @@ def handle_login(task, handle, info): @contextmanager 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. :raises: CIMCException if login fails -- cgit v1.2.1