diff --git a/doc/source/admin/drivers.rst b/doc/source/admin/drivers.rst index 9f4563101c..00f6cf72f2 100644 --- a/doc/source/admin/drivers.rst +++ b/doc/source/admin/drivers.rst @@ -21,6 +21,7 @@ Hardware Types drivers/ibmc drivers/idrac drivers/ilo + drivers/intel-ipmi drivers/ipmitool drivers/irmc drivers/redfish diff --git a/doc/source/admin/drivers/intel-ipmi.rst b/doc/source/admin/drivers/intel-ipmi.rst new file mode 100644 index 0000000000..92806c8c1e --- /dev/null +++ b/doc/source/admin/drivers/intel-ipmi.rst @@ -0,0 +1,159 @@ +================= +Intel IPMI driver +================= + +Overview +======== + +The ``intel-ipmi`` hardware type is same as the :doc:`ipmitool` hardware +type except for the support of Intel Speed Select Performance Profile +(Intel SST-PP_) feature. Intel SST-PP allows a server to run different +workloads by configuring the CPU to run at 3 distinct operating points +or profiles. + +Intel SST-PP supports three configuration levels: + +* 0 - Intel SST-PP Base Config +* 1 - Intel SST-PP Config 1 +* 2 - Intel SST-PP Config 2 + +The following table shows the list of active cores and their base frequency at +different SST-PP config levels:: + + +-------------+---------+-------------------+ + | Config | Cores | Base Freq (GHz) | + +=============+=========+===================+ + | Base | 24 | 2.4 | + +-------------+---------+-------------------+ + | Config 1 | 20 | 2.5 | + +-------------+---------+-------------------+ + | Config 2 | 16 | 2.7 | + +-------------+---------+-------------------+ + +This configuration is managed by the management interface ``intel-ipmitool`` +for IntelIPMI hardware. + +IntelIPMI manages nodes by using IPMI_ (Intelligent Platform +Management Interface) protocol versions 2.0 or 1.5. It uses the IPMItool_ +utility which is an open-source command-line interface (CLI) for controlling +IPMI-enabled devices. + +Glossary +======== + +* IPMI - Intelligent Platform Management Interface. +* Intel SST-PP - Intel Speed Select Performance Profile. + +Enabling the IntelIPMI hardware type +==================================== + +Please see :doc:`/install/configure-ipmi` for the required dependencies. + +#. To enable ``intel-ipmi`` hardware, add the following configuration to your + ``ironic.conf``: + + .. code-block:: ini + + [DEFAULT] + enabled_hardware_types = intel-ipmi + enabled_management_interfaces = intel-ipmitool + +#. Restart the Ironic conductor service:: + + sudo service ironic-conductor restart + + # Or, for RDO: + sudo systemctl restart openstack-ironic-conductor + +Registering a node with the IntelIPMI driver +============================================ + +Nodes configured to use the IntelIPMI drivers should have the +``driver`` field set to ``intel-ipmi``. + +All the configuration value required for IntelIPMI is the same as the IPMI +hardware type except the management interface which is ``intel-ipmitool``. +Refer :doc:`ipmitool` for details. + +The ``openstack baremetal node create`` command can be used to enroll a node +with an IntelIPMI driver. For example:: + + openstack baremetal node create --driver intel-ipmi \ + --driver-info ipmi_address=
\ + --driver-info ipmi_username=