diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/admin/boot-from-volume.rst | 57 | ||||
| -rw-r--r-- | doc/source/admin/drivers/cimc.rst | 31 | ||||
| -rw-r--r-- | doc/source/admin/drivers/idrac.rst | 15 | ||||
| -rw-r--r-- | doc/source/admin/drivers/irmc.rst | 270 | ||||
| -rw-r--r-- | doc/source/admin/drivers/oneview.rst | 125 | ||||
| -rw-r--r-- | doc/source/admin/drivers/ucs.rst | 27 | ||||
| -rw-r--r-- | doc/source/admin/interfaces/deploy.rst | 3 | ||||
| -rw-r--r-- | doc/source/install/enabling-drivers.rst | 2 |
8 files changed, 106 insertions, 424 deletions
diff --git a/doc/source/admin/boot-from-volume.rst b/doc/source/admin/boot-from-volume.rst index da875cf25..3c13ea1f5 100644 --- a/doc/source/admin/boot-from-volume.rst +++ b/doc/source/admin/boot-from-volume.rst @@ -93,6 +93,63 @@ A target record can be created using a command similar to the example below:: node. As the ``boot-index`` is per-node in sequential order, only one boot volume is permitted for each node. +Use Without Cinder +------------------ + +In the Rocky release, an ``external`` storage interface is available that +can be utilized without a Block Storage Service installation. + +Under normal circumstances the ``cinder`` storage interface +interacts with the Block Storage Service to orchestrate and manage +attachment and detachment of volumes from the underlying block service +system. + +The ``external`` storage interface contains the logic to allow the Bare +Metal service to determine if the Bare Metal node has been requested with +a remote storage volume for booting. This is in contrast to the default +``noop`` storage interface which does not contain logic to determine if +the node should or could boot from a remote volume. + +It must be noted that minimal configuration or value validation occurs +with the ``external`` storage interface. The ``cinder`` storage interface +contains more extensive validation, that is likely un-necessary in a +``external`` scenario. + +Setting the external storage interface:: + + openstack baremetal node set --storage-interface external $NODE_UUID + +Setting a volume:: + + openstack baremetal volume target create --node $NODE_UUID \ + --type iscsi --boot-index 0 --volume-id $VOLUME_UUID \ + --property target_iqn="iqn.2010-10.com.example:vol-X" \ + --property target_lun="0" \ + --property target_portal="192.168.0.123:3260" \ + --property auth_method="CHAP" \ + --property auth_username="ABC" \ + --property auth_password="XYZ" \ + +Ensure that no image_source is defined:: + + openstack baremetal node unset \ + --instance-info image_source $NODE_UUID + +Deploy the node:: + + openstack baremetal node deploy $NODE_UUID + +Upon deploy, the boot interface for the baremetal node will attempt +to either create iPXE configuration OR set boot parameters out-of-band via +the management controller. Such action is boot interface specific and may not +support all forms of volume target configuration. As of the Rocky release, +the bare metal service does not support writing an Operating System image +to a remote boot from volume target, so that also must be ensured by +the user in advance. + +Records of volume targets are removed upon the node being undeployed, +and as such are not presistent across deployments. + Cinder Multi-attach ------------------- diff --git a/doc/source/admin/drivers/cimc.rst b/doc/source/admin/drivers/cimc.rst index 55e779c5a..9d10a6ff4 100644 --- a/doc/source/admin/drivers/cimc.rst +++ b/doc/source/admin/drivers/cimc.rst @@ -6,23 +6,14 @@ CIMC drivers Overview ======== -The CIMC drivers are targeted for standalone Cisco UCS C series servers. -These drivers enable you to take advantage of CIMC by using the -python SDK. -``pxe_iscsi_cimc`` driver uses PXE boot + iSCSI deploy (just like ``pxe_ipmitool`` -driver) to deploy the image and uses CIMC to do all management operations on -the baremetal node (instead of using IPMI). +The ``cisco-ucs-standalone`` hardware type targets standalone Cisco UCS C +series servers. It enables you to take advantage of CIMC by using +the python SDK. -``pxe_agent_cimc`` driver uses PXE boot + Agent deploy (just like ``agent_ipmitool`` -and ``agent_ipminative`` drivers.) to deploy the image and uses CIMC to do all -management operations on the baremetal node (instead of using IPMI). Unlike with -iSCSI deploy in Agent deploy, the ramdisk is responsible for writing the image to -the disk, instead of the conductor. - -The CIMC drivers can use the Ironic Inspector service for in-band inspection of -equipment. For more information see the `Ironic Inspector documentation -<https://docs.openstack.org/ironic-inspector/latest>`_. +The CIMC hardware type can use the Ironic Inspector service for in-band +inspection of equipment. For more information see the `Ironic Inspector +documentation <https://docs.openstack.org/ironic-inspector/latest>`_. Prerequisites ============= @@ -50,10 +41,10 @@ This driver works with UCS C-Series servers and has been tested with: Configuring and Enabling the driver ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Add ``pxe_iscsi_cimc`` and/or ``pxe_agent_cimc`` to the list of ``enabled_drivers`` in +1. Add ``cisco-ucs-standalone`` to ``enabled_hardware_types`` in ``/etc/ironic/ironic.conf``. For example:: - enabled_drivers = pxe_ipmitool,pxe_iscsi_cimc,pxe_agent_cimc + enabled_hardware_types = ipmi,cisco-ucs-standalone 2. Restart the Ironic conductor service: @@ -68,8 +59,8 @@ Configuring and Enabling the driver 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``: +``cisco-ucs-standalone``. The following configuration values are also required +in ``driver_info``: - ``cimc_address``: IP address or hostname for CIMC - ``cimc_username``: CIMC login user name @@ -81,7 +72,7 @@ The following sequence of commands can be used to enroll a UCS Standalone node. * Create Node:: - openstack baremetal node create --driver <pxe_iscsi_cimc OR pxe_agent_cimc> \ + openstack baremetal node create --driver cisco-ucs-standalone \ --driver-info cimc_address=<CIMC hostname OR ip-address> \ --driver-info cimc_username=<cimc_username> \ --driver-info cimc_password=<cimc_password> \ diff --git a/doc/source/admin/drivers/idrac.rst b/doc/source/admin/drivers/idrac.rst index f4126c5f5..fbe21f0c6 100644 --- a/doc/source/admin/drivers/idrac.rst +++ b/doc/source/admin/drivers/idrac.rst @@ -5,22 +5,17 @@ iDRAC drivers Overview ======== -iDRAC_ hardware is supported by the ``idrac`` hardware type and the following -classic drivers: - -* ``pxe_drac`` (using out-of-band inspection) -* ``pxe_drac_inspector`` (using in-band inspection via **ironic-inspector**) - -It is also supported by the standard ``ipmi`` hardware type, though with -a smaller feature set. +iDRAC_ hardware is supported by the ``idrac`` hardware type. It is also +supported by the standard ``ipmi`` hardware type, though with a smaller +feature set. .. TODO(dtantsur): supported hardware Enabling ======== -All iDRAC drivers require the ``python-dracclient`` library to be installed, -for example:: +The ``idrac`` hardware type requires the ``python-dracclient`` library to be +installed, for example:: sudo pip install 'python-dracclient>=1.3.0' diff --git a/doc/source/admin/drivers/irmc.rst b/doc/source/admin/drivers/irmc.rst index 5af489af5..355e47f04 100644 --- a/doc/source/admin/drivers/irmc.rst +++ b/doc/source/admin/drivers/irmc.rst @@ -174,264 +174,6 @@ Node configuration - ``driver_info/irmc_snmp_community`` property overrides ``snmp_community``. - ``driver_info/irmc_snmp_security`` property overrides ``snmp_security``. -Upgrading to ``irmc`` hardware type -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -When upgrading from a classic driver to the ``irmc`` hardware type, -make sure you specify the hardware interfaces that are used by the -classic driver. :doc:`/admin/upgrade-to-hardware-types` has more -information, including the hardware interfaces corresponding to -the classic drivers. - -Classic Drivers (Deprecated) -============================ - -These are the classic drivers (deprecated) for FUJITSU PRIMERGY servers. - -* ``pxe_irmc`` -* ``iscsi_irmc`` -* ``agent_irmc`` - -.. warning:: - The classic drivers are deprecated in the Queens release and will be removed - in the Rocky release. The ``irmc`` hardware type should be used instead of - the classic drivers. - -pxe_irmc driver -^^^^^^^^^^^^^^^ - -This driver enables PXE deploy and power control via ServerView Common -Command Interface (SCCI). - -Enabling the driver -~~~~~~~~~~~~~~~~~~~ - -- Add ``pxe_irmc`` to the list of ``enabled_drivers`` in ``[DEFAULT]`` - section of ``/etc/ironic/ironic.conf``. -- Ironic Conductor must be restarted for the new driver to be loaded. - -Node configuration -~~~~~~~~~~~~~~~~~~ - -* Each node is configured for iRMC with PXE deploy by setting the - following ironic node object’s properties: - - - ``driver`` property to be ``pxe_irmc`` - - ``driver_info/irmc_address`` property to be ``IP address`` or - ``hostname`` of the iRMC. - - ``driver_info/irmc_username`` property to be ``username`` for - the iRMC with administrator privileges. - - ``driver_info/irmc_password`` property to be ``password`` for - irmc_username. - - ``properties/capabilities`` property to be ``boot_mode:uefi`` if - UEFI boot is required. - - ``properties/capabilities`` property to be ``secure_boot:true`` if - UEFI Secure Boot is required. Please refer to `UEFI Secure Boot Support`_ - for more information. - -* All of nodes are configured by setting the following configuration - options in ``[irmc]`` section of ``/etc/ironic/ironic.conf``: - - - ``port``: Port to be used for iRMC operations; either 80 - or 443. The default value is 443. Optional. - - ``auth_method``: Authentication method for iRMC operations; - either ``basic`` or ``digest``. The default value is ``basic``. Optional. - - ``client_timeout``: Timeout (in seconds) for iRMC - operations. The default value is 60. Optional. - - ``sensor_method``: Sensor data retrieval method; either - ``ipmitool`` or ``scci``. The default value is ``ipmitool``. Optional. - -* The following options are only required for inspection: - - - ``snmp_version``: SNMP protocol version; either ``v1``, ``v2c`` or - ``v3``. The default value is ``v2c``. Optional. - - ``snmp_port``: SNMP port. The default value is ``161``. Optional. - - ``snmp_community``: SNMP community required for versions ``v1`` - and ``v2c``. The default value is ``public``. Optional. - - ``snmp_security``: SNMP security name required for version ``v3``. - Optional. - -* Each node can be further configured by setting the following ironic - node object’s properties which override the parameter values in - ``[irmc]`` section of ``/etc/ironic/ironic.conf``: - - - ``driver_info/irmc_port`` property overrides ``port``. - - ``driver_info/irmc_auth_method`` property overrides ``auth_method``. - - ``driver_info/irmc_client_timeout`` property overrides ``client_timeout``. - - ``driver_info/irmc_sensor_method`` property overrides ``sensor_method``. - - ``driver_info/irmc_snmp_version`` property overrides ``snmp_version``. - - ``driver_info/irmc_snmp_port`` property overrides ``snmp_port``. - - ``driver_info/irmc_snmp_community`` property overrides ``snmp_community``. - - ``driver_info/irmc_snmp_security`` property overrides ``snmp_security``. - - -iscsi_irmc driver -^^^^^^^^^^^^^^^^^ - -This driver enables Virtual Media deploy with image build from -Diskimage Builder and power control via ServerView Common Command -Interface (SCCI). - -Enabling the driver -~~~~~~~~~~~~~~~~~~~ - -- Add ``iscsi_irmc`` to the list of ``enabled_drivers`` in - ``[DEFAULT]`` section of ``/etc/ironic/ironic.conf``. -- Ironic Conductor must be restarted for the new driver to be loaded. - -Node configuration -~~~~~~~~~~~~~~~~~~ - -* Each node is configured for iRMC with PXE deploy by setting the - followings ironic node object’s properties: - - - ``driver`` property to be ``iscsi_irmc`` - - ``driver_info/irmc_address`` property to be ``IP address`` or - ``hostname`` of the iRMC. - - ``driver_info/irmc_username`` property to be ``username`` for - the iRMC with administrator privileges. - - ``driver_info/irmc_password`` property to be ``password`` for - irmc_username. - - ``properties/capabilities`` property to be ``boot_mode:uefi`` if - UEFI boot is required. - - ``properties/capabilities`` property to be ``secure_boot:true`` if - Secure Boot is required. Please refer to `UEFI Secure Boot Support`_ - for more information. - - ``driver_info/irmc_deploy_iso`` property to be either deploy iso - file name, Glance UUID, or Image Service URL. - - ``instance info/irmc_boot_iso`` property to be either boot iso - file name, Glance UUID, or Image Service URL. This is optional - property when ``boot_option`` is set to ``netboot``. - -* All of nodes are configured by setting the following configuration - options in ``[irmc]`` section of ``/etc/ironic/ironic.conf``: - - - ``port``: Port to be used for iRMC operations; either ``80`` - or ``443``. The default value is ``443``. Optional. - - ``auth_method``: Authentication method for iRMC operations; - either ``basic`` or ``digest``. The default value is ``basic``. Optional. - - ``client_timeout``: Timeout (in seconds) for iRMC - operations. The default value is 60. Optional. - - ``sensor_method``: Sensor data retrieval method; either - ``ipmitool`` or ``scci``. The default value is ``ipmitool``. Optional. - - ``remote_image_share_root``: Ironic conductor node's ``NFS`` or - ``CIFS`` root path. The default value is ``/remote_image_share_root``. - - ``remote_image_server``: IP of remote image server. - - ``remote_image_share_type``: Share type of virtual media, either - ``NFS`` or ``CIFS``. The default is ``CIFS``. - - ``remote_image_share_name``: share name of ``remote_image_server``. - The default value is ``share``. - - ``remote_image_user_name``: User name of ``remote_image_server``. - - ``remote_image_user_password``: Password of ``remote_image_user_name``. - - ``remote_image_user_domain``: Domain name of ``remote_image_user_name``. - -* The following options are only required for inspection: - - - ``snmp_version``: SNMP protocol version; either ``v1``, ``v2c`` or - ``v3``. The default value is ``v2c``. Optional. - - ``snmp_port``: SNMP port. The default value is ``161``. Optional. - - ``snmp_community``: SNMP community required for versions ``v1`` - and ``v2c``. The default value is ``public``. Optional. - - ``snmp_security``: SNMP security name required for version ``v3``. - Optional. - -* Each node can be further configured by setting the following ironic - node object’s properties which override the parameter values in - ``[irmc]`` section of ``/etc/ironic/ironic.conf``: - - - ``driver_info/irmc_port`` property overrides ``port``. - - ``driver_info/irmc_auth_method`` property overrides ``auth_method``. - - ``driver_info/irmc_client_timeout`` property overrides ``client_timeout``. - - ``driver_info/irmc_sensor_method`` property overrides ``sensor_method``. - - ``driver_info/irmc_snmp_version`` property overrides ``snmp_version``. - - ``driver_info/irmc_snmp_port`` property overrides ``snmp_port``. - - ``driver_info/irmc_snmp_community`` property overrides ``snmp_community``. - - ``driver_info/irmc_snmp_security`` property overrides ``snmp_security``. - - -agent_irmc driver -^^^^^^^^^^^^^^^^^ - -This driver enables Virtual Media deploy with IPA (Ironic Python -Agent) and power control via ServerView Common Command Interface -(SCCI). - -Enabling the driver -~~~~~~~~~~~~~~~~~~~ - -- Add ``agent_irmc`` to the list of ``enabled_drivers`` in - ``[DEFAULT]`` section of ``/etc/ironic/ironic.conf``. -- Ironic Conductor must be restarted for the new driver to be loaded. - -Node configuration -~~~~~~~~~~~~~~~~~~ - -* Each node is configured for iRMC with PXE deploy by setting the - followings ironic node object’s properties: - - - ``driver`` property to be ``agent_irmc`` - - ``driver_info/irmc_address`` property to be ``IP address`` or - ``hostname`` of the iRMC. - - ``driver_info/irmc_username`` property to be ``username`` for - the iRMC with administrator privileges. - - ``driver_info/irmc_password`` property to be ``password`` for - irmc_username. - - ``properties/capabilities`` property to be ``boot_mode:uefi`` if - UEFI boot is required. - - ``properties/capabilities`` property to be ``secure_boot:true`` if - Secure Boot is required. Please refer to `UEFI Secure Boot Support`_ - for more information. - - ``driver_info/irmc_deploy_iso`` property to be either deploy iso - file name, Glance UUID, or Image Service URL. - - ``instance info/irmc_boot_iso`` property to be either boot iso - file name, Glance UUID, or Image Service URL. This is optional - property when ``boot_option`` is set to ``netboot``. - -* All of nodes are configured by setting the following configuration - options in ``[irmc]`` section of ``/etc/ironic/ironic.conf``: - - - ``port``: Port to be used for iRMC operations; either 80 - or 443. The default value is 443. Optional. - - ``auth_method``: Authentication method for iRMC operations; - either ``basic`` or ``digest``. The default value is ``basic``. Optional. - - ``client_timeout``: Timeout (in seconds) for iRMC - operations. The default value is 60. Optional. - - ``sensor_method``: Sensor data retrieval method; either - ``ipmitool`` or ``scci``. The default value is ``ipmitool``. Optional. - - ``remote_image_share_root``: Ironic conductor node's ``NFS`` or - ``CIFS`` root path. The default value is ``/remote_image_share_root``. - - ``remote_image_server``: IP of remote image server. - - ``remote_image_share_type``: Share type of virtual media, either - ``NFS`` or ``CIFS``. The default is ``CIFS``. - - ``remote_image_share_name``: share name of ``remote_image_server``. - The default value is ``share``. - - ``remote_image_user_name``: User name of ``remote_image_server``. - - ``remote_image_user_password``: Password of ``remote_image_user_name``. - - ``remote_image_user_domain``: Domain name of ``remote_image_user_name``. - -* The following options are only required for inspection: - - - ``snmp_version``: SNMP protocol version; either ``v1``, ``v2c`` or - ``v3``. The default value is ``v2c``. Optional. - - ``snmp_port``: SNMP port. The default value is ``161``. Optional. - - ``snmp_community``: SNMP community required for versions ``v1`` - and ``v2c``. The default value is ``public``. Optional. - - ``snmp_security``: SNMP security name required for version ``v3``. - Optional. - -* Each node can be further configured by setting the following ironic - node object’s properties which override the parameter values in - ``[irmc]`` section of ``/etc/ironic/ironic.conf``: - - - ``driver_info/irmc_port`` property overrides ``port``. - - ``driver_info/irmc_auth_method`` property overrides ``auth_method``. - - ``driver_info/irmc_client_timeout`` property overrides ``client_timeout``. - - ``driver_info/irmc_sensor_method`` property overrides ``sensor_method``. - - ``driver_info/irmc_snmp_version`` property overrides ``snmp_version``. - - ``driver_info/irmc_snmp_port`` property overrides ``snmp_port``. - - ``driver_info/irmc_snmp_community`` property overrides ``snmp_community``. - - ``driver_info/irmc_snmp_security`` property overrides ``snmp_security``. - Optional functionalities for the ``irmc`` hardware type ======================================================= @@ -497,18 +239,16 @@ For more information on node automated cleaning, see :ref:`automated_cleaning` Boot from Remote Volume ^^^^^^^^^^^^^^^^^^^^^^^ -The ``irmc`` hardware type (and ``pxe_irmc`` classic driver) supports the -generic iPXE-based remote volume booting when using the following boot -interfaces: +The ``irmc`` hardware type supports the generic iPXE-based remote volume +booting when using the following boot interfaces: * ``irmc-pxe`` * ``pxe`` In addition, the ``irmc`` hardware type supports remote volume booting without -iPXE. This is available when using the ``irmc-virtual-media`` boot interface -(and ``iscsi_irmc`` and ``agent_irmc`` classic drivers). This feature -configures a node to boot from a remote volume by using the API of iRMC. It -supports iSCSI and FibreChannel. +iPXE. This is available when using the ``irmc-virtual-media`` boot interface. +This feature configures a node to boot from a remote volume by using the API +of iRMC. It supports iSCSI and FibreChannel. Configuration ~~~~~~~~~~~~~ diff --git a/doc/source/admin/drivers/oneview.rst b/doc/source/admin/drivers/oneview.rst index eac1e47dc..fc953eb79 100644 --- a/doc/source/admin/drivers/oneview.rst +++ b/doc/source/admin/drivers/oneview.rst @@ -5,8 +5,8 @@ OneView drivers =============== .. note:: - The `oneview` drivers and hardware type, along with related interfaces - to support OneView, have been deprecated, and should be expected to be + The `oneview` hardware type, along with related interfaces to support + OneView, have been deprecated, and should be expected to be removed from ironic in the Stein cycle. Please see `storyboard <https://storyboard.openstack.org/#!/story/2001924>`_ for additional details. @@ -21,30 +21,14 @@ instance. In this context, the ``HP OneView driver`` for ironic enables the users of OneView to use ironic as a bare metal provider to their managed physical hardware. -HPE OneView hardware is supported by the ``oneview`` hardware type and the -following classic drivers: - -* ``iscsi_pxe_oneview`` -* ``agent_pxe_oneview`` - -Classic Drivers -=============== - -The ``iscsi_pxe_oneview`` and ``agent_pxe_oneview`` drivers implement the core -interfaces of an ironic Driver [2]_, and use the ``hpOneView`` [3]_ library -to provide communication between ironic and OneView through OneView's REST API. - -.. note:: - Classic drivers will be deprecated in favor of Hardware Types. +HPE OneView hardware is supported by the ``oneview`` hardware type. To provide a bare metal instance there are four components involved in the process: * The ironic service * The ironic-inspector service (if using hardware inspection) -* The ironic driver for OneView, which can be: - * `iscsi_pxe_oneview` or - * `agent_pxe_oneview` +* The ironic hardware type for OneView * The hpOneView library * The OneView appliance @@ -70,9 +54,6 @@ the node is no longer in use, these tasks will make place them back in Prerequisites ============= -The following requirements apply for both ``iscsi_pxe_oneview`` and -``agent_pxe_oneview`` drivers: - * ``OneView appliance`` is the HP physical infrastructure manager to be integrated with the OneView drivers. @@ -216,49 +197,11 @@ hardware type: --driver oneview \ --deploy-interface oneview-iscsi +Deploy process with oneview-iscsi deploy interface +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Drivers -======= - -iscsi_pxe_oneview driver -^^^^^^^^^^^^^^^^^^^^^^^^ - -Overview -~~~~~~~~ - -``iscsi_pxe_oneview`` driver uses PXEBoot for boot and ISCSIDeploy for deploy. - -Configuring and enabling the driver -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Add ``iscsi_pxe_oneview`` to the list of ``enabled_drivers`` in your - ``ironic.conf`` file. For example:: - - enabled_drivers = iscsi_pxe_oneview - -2. Update the [oneview] section of your ``ironic.conf`` file with your - OneView credentials and CA certificate files information. - -.. note:: - An operator can set the ``periodic_check_interval`` option in the [oneview] - section to set the interval between running the periodic check. The default - value is 300 seconds (5 minutes). A lower value will reduce the likelihood - of races between ironic and OneView at the cost of being more resource - intensive. - -3. Restart the ironic conductor service. For Ubuntu users, do:: - - $ sudo service ironic-conductor restart - -See :doc:`/install/index` for more information. - -Deploy process -~~~~~~~~~~~~~~ - -Here is an overview of the deploy process for this driver: - -1. Admin configures the Proliant baremetal node to use ``iscsi_pxe_oneview`` - driver. +1. Admin configures the Proliant baremetal node to use ``oneview-iscsi`` + deploy interface. 2. ironic gets a request to deploy a Glance image on the baremetal node. 3. Driver sets the boot device to PXE. 4. Driver powers on the baremetal node. @@ -270,45 +213,11 @@ Here is an overview of the deploy process for this driver: 10. Driver powers on the machine. 11. Baremetal node is active and ready to be used. -agent_pxe_oneview driver -^^^^^^^^^^^^^^^^^^^^^^^^ - -Overview -~~~~~~~~ - -``agent_pxe_oneview`` driver uses PXEBoot for boot and AgentDeploy for deploy. - -Configuring and enabling the driver -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Add ``agent_pxe_oneview`` to the list of ``enabled_drivers`` in your - ``ironic.conf``. For example:: - - enabled_drivers = pxe_ipmitool,agent_pxe_oneview - -2. Update the [oneview] section of your ``ironic.conf`` file with your - OneView credentials and CA certificate files information. - -.. note:: - An operator can set the ``periodic_check_interval`` option in the [oneview] - section to set the interval between running the periodic check. The default - value is 300 seconds (5 minutes). A lower value will reduce the likelihood - of races between ironic and OneView at the cost of being more resource - intensive. - -3. Restart the ironic conductor service. For Ubuntu users, do:: - - $ service ironic-conductor restart - -See :doc:`/install/index` for more information. - -Deploy process -~~~~~~~~~~~~~~ - -Here is an overview of the deploy process for this driver: +Deploy process with oneview-direct deploy interface +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Admin configures the Proliant baremetal node to use ``agent_pxe_oneview`` - driver. +1. Admin configures the Proliant baremetal node to use ``oneview-direct`` + deploy interface. 2. ironic gets a request to deploy a Glance image on the baremetal node. 3. Driver sets the boot device to PXE. 4. Driver powers on the baremetal node. @@ -339,8 +248,8 @@ Registering a OneView node in ironic ==================================== Nodes configured to use any of the OneView drivers should have the ``driver`` -property set to ``iscsi_pxe_oneview`` or ``agent_pxe_oneview``. Considering -our context, a node is the representation of a ``Server Hardware`` in OneView, +property set to ``oneview``. Considering our context, a node is the +representation of a ``Server Hardware`` in OneView, and should be consistent with all its properties and related components, such as ``Server Hardware Type``, ``Server Profile Template``, ``Enclosure Group``, etc. In this case, to be enrolled, the node must have the following parameters: @@ -419,7 +328,7 @@ In order to ease user manual tasks, which are often time-consuming, we provide useful tools that work nicely with the OneView drivers. ironic-oneview-cli -^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~ The ``ironic-oneView`` CLI is a command line interface for management tasks involving OneView nodes. Its features include a facility to create of ironic @@ -430,7 +339,7 @@ For more details on how Ironic-OneView CLI works and how to set it up, see [8]_. ironic-oneviewd -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ The ``ironic-oneviewd`` daemon monitors the ironic inventory of resources and provides facilities to operators managing OneView driver deployments. @@ -440,8 +349,6 @@ For more details on how Ironic-OneViewd works and how to set it up, see [7]_. References ========== .. [1] HP OneView - https://www.hpe.com/us/en/integrated-systems/software.html -.. [2] :ref:`architecture_drivers` -.. [3] hpOneView - https://pypi.org/project/hpOneView .. [6] Dynamic Allocation in OneView drivers - https://specs.openstack.org/openstack/ironic-specs/specs/not-implemented/oneview-drivers-dynamic-allocation.html .. [7] ironic-oneviewd - https://pypi.org/project/ironic-oneviewd/ .. [8] ironic-oneview-cli - https://pypi.org/project/ironic-oneview-cli/ diff --git a/doc/source/admin/drivers/ucs.rst b/doc/source/admin/drivers/ucs.rst index 7b38ca6ae..dd8d9f858 100644 --- a/doc/source/admin/drivers/ucs.rst +++ b/doc/source/admin/drivers/ucs.rst @@ -6,21 +6,14 @@ UCS drivers Overview ======== -The UCS driver is targeted for UCS Manager managed Cisco UCS B/C series -servers. The pxe_ucs, agent_ucs drivers enables you to take advantage of -UCS Manager by using the python SDK. - -``pxe_ucs`` driver uses PXE/iSCSI (just like ``pxe_ipmitool`` driver) to -deploy the image and uses UCS to do all management operations on the -baremetal node (instead of using IPMI). -``agent_ucs`` driver uses IPA ramdisk (just like ``agent_ipmitool`` and -``agent_ipminative`` drivers.) to deploy the image and uses UCS to do all -management operations on the baremetal node (instead of using IPMI). +The UCS driver is targeted for UCS Manager managed Cisco UCS B/C series +servers. The ``cisco-ucs-managed`` hardware type enables you to take advantage +of UCS Manager by using the python SDK. -The UCS drivers can use the Ironic Inspector service for in-band inspection of -equipment. For more information see the `Ironic Inspector documentation -<https://docs.openstack.org/ironic-inspector/latest>`_. +The UCS hardware type can use the Ironic Inspector service for in-band +inspection of equipment. For more information see the `Ironic Inspector +documentation <https://docs.openstack.org/ironic-inspector/latest>`_. Prerequisites ============= @@ -48,10 +41,10 @@ by this driver. Configuring and Enabling the driver ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Add ``pxe_ucs`` and/or ``agent_ucs`` to the list of ``enabled_drivers`` in +1. Add ``cisco-ucs-managed`` to the ``enabled_hardware_types`` in ``/etc/ironic/ironic.conf``. For example:: - enabled_drivers = pxe_ipmitool,pxe_ucs,agent_ucs + enabled_hardware_types = ipmi,cisco-ucs-managed 2. Restart the Ironic conductor service:: @@ -60,7 +53,7 @@ Configuring and Enabling the driver Registering UCS node in Ironic ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Nodes configured for UCS driver should have the ``driver`` property set to -``pxe_ucs/agent_ucs``. The following configuration values are also required in +``cisco-ucs-managed``. The following configuration values are also required in ``driver_info``: - ``ucs_address``: IP address or hostname of the UCS Manager @@ -75,7 +68,7 @@ The following sequence of commands can be used to enroll a UCS node. * Create Node:: - openstack baremetal node create --driver <pxe_ucs/agent_ucs> \ + openstack baremetal node create --driver cisco-ucs-managed \ --driver-info ucs_address=<UCS Manager hostname/ip-address> \ --driver-info ucs_username=<ucsm_username> \ --driver-info ucs_password=<ucsm_password> \ diff --git a/doc/source/admin/interfaces/deploy.rst b/doc/source/admin/interfaces/deploy.rst index a450b33bb..550a0a897 100644 --- a/doc/source/admin/interfaces/deploy.rst +++ b/doc/source/admin/interfaces/deploy.rst @@ -25,8 +25,7 @@ when creating or updating a node:: openstack baremetal node set <NODE> --deploy-interface iscsi The ``iscsi`` deploy interface is also used in all of the *classic drivers* -with names starting with ``pxe_`` (except for ``pxe_agent_cimc``) -and ``iscsi_``. +with names starting with ``pxe_`` and ``iscsi_``. .. _iSCSI: https://en.wikipedia.org/wiki/ISCSI diff --git a/doc/source/install/enabling-drivers.rst b/doc/source/install/enabling-drivers.rst index f2584df81..9363ade15 100644 --- a/doc/source/install/enabling-drivers.rst +++ b/doc/source/install/enabling-drivers.rst @@ -311,7 +311,7 @@ option, for example: .. code-block:: ini [DEFAULT] - enabled_drivers = pxe_ipmitool,pxe_drac + enabled_drivers = pxe_ipmitool The names in this comma-separated list are entry point names of the drivers. They have to be available at conductor start-up, and all dependencies must |