Difference between revisions of "Ironic/Drivers/iLODrivers"

Revision as of 16:35, 20 October 2014 (view source) Rameshg87 (talk | contribs) m (→‎=) ← Older edit		Revision as of 16:39, 20 October 2014 (view source) Rameshg87 (talk | contribs) m (→‎iLO drivers) Newer edit →
Line 13:		Line 13:
	Currently there are 3 iLO drivers:		Currently there are 3 iLO drivers:
−	* ``iscsi_ilo``	+	* '''iscsi_ilo'''
−	* ``agent_ilo``	+	* '''agent_ilo'''
−	* ``pxe_ilo``.	+	* '''pxe_ilo'''.
−	The ``iscsi_ilo`` and ``agent_ilo`` drivers provide security enhanced	+	The '''iscsi_ilo''' and '''agent_ilo''' drivers provide security enhanced
	PXE-less deployment by using iLO virtual media to boot up the baremetal node.		PXE-less deployment by using iLO virtual media to boot up the baremetal node.
	These drivers send management info through management channel and separates		These drivers send management info through management channel and separates
−	it from data channel which is used for deployment.  ``iscsi_ilo`` driver uses	+	it from data channel which is used for deployment.  '''iscsi_ilo''' driver uses
−	deployment ramdisk built from ``diskimage-builder``, deploys from Ironic	+	deployment ramdisk built from '''diskimage-builder''', deploys from Ironic
−	conductor node and always does net-boot. ``agent_ilo`` driver uses deployment	+	conductor node and always does net-boot. '''agent_ilo''' driver uses deployment
	ramdisk built from IPA, deploys from baremetal node and always does local boot.		ramdisk built from IPA, deploys from baremetal node and always does local boot.
−	``pxe_ilo`` driver uses PXE/iSCSI for deployment (just like normal PXE driver),	+	'''pxe_ilo''' driver uses PXE/iSCSI for deployment (just like normal PXE driver),
	but support automatic setting of requested boot mode from nova. This driver		but support automatic setting of requested boot mode from nova. This driver
	doesn't require iLO Advanced license.		doesn't require iLO Advanced license.
Line 33:		Line 33:
	=== Prerequisites ===		=== Prerequisites ===
−	* ``proliantutils`` is a python package which contains a set of modules for	+	* '''proliantutils''' is a python package which contains a set of modules for
	managing HP Proliant hardware.		managing HP Proliant hardware.
−	Install ``proliantutils`` [2]_ module on the Ironic conductor node. Minimum	+	Install '''proliantutils''' [2]_ module on the Ironic conductor node. Minimum
	version required is 0.1.0.::		version required is 0.1.0.::
	$ pip install "proliantutils>=0.1.0"		$ pip install "proliantutils>=0.1.0"
−	* ``ipmitool`` command must be present on the service node(s) where	+	* '''ipmitool''' command must be present on the service node(s) where
−	``ironic-conductor`` is running. On most distros, this is provided as part	+	'''ironic-conductor''' is running. On most distros, this is provided as part
−	of the ``ipmitool`` package. Source code is available at	+	of the '''ipmitool''' package. Source code is available at
	http://ipmitool.sourceforge.net/.		http://ipmitool.sourceforge.net/.
Line 53:		Line 53:
	===== Overview =====		===== Overview =====
−	``iscsi_ilo`` driver was introduced as an alternative to ``pxe_ipmitool``	+	'''iscsi_ilo''' driver was introduced as an alternative to '''pxe_ipmitool'''
−	and ``pxe_ipminative`` drivers for HP Proliant servers. ``iscsi_ilo`` uses	+	and '''pxe_ipminative''' drivers for HP Proliant servers. '''iscsi_ilo''' uses
	virtual media feature in iLO to boot up the baremetal node instead of using		virtual media feature in iLO to boot up the baremetal node instead of using
	PXE or iPXE.		PXE or iPXE.
Line 62:		Line 62:
	* Users who do not want to use PXE/TFTP protocol on their data centres.		* Users who do not want to use PXE/TFTP protocol on their data centres.
	* Current PXE driver passes authentication token in clear-text over		* Current PXE driver passes authentication token in clear-text over
−	tftp to the baremetal node. ``iscsi_ilo`` driver enhances the security	+	tftp to the baremetal node. '''iscsi_ilo''' driver enhances the security
	by passing keystone authtoken and management info over encrypted		by passing keystone authtoken and management info over encrypted
	management network. This driver may be used by users who have concerns		management network. This driver may be used by users who have concerns
Line 102:		Line 102:
	FAT images as well as boot ISO images.		FAT images as well as boot ISO images.
	* **Glance Image Service with Swift configured as its backend** - When using		* **Glance Image Service with Swift configured as its backend** - When using
−	``iscsi_ilo`` driver, the image containing the deploy ramdisk is retrieved	+	'''iscsi_ilo''' driver, the image containing the deploy ramdisk is retrieved
	from Swift directly by the iLO.		from Swift directly by the iLO.
Line 109:		Line 109:
	* Admin configures the Proliant baremetal node for iscsi_ilo driver. The		* Admin configures the Proliant baremetal node for iscsi_ilo driver. The
−	Ironic node configured will have the ``ilo_deploy_iso`` property in its	+	Ironic node configured will have the '''ilo_deploy_iso''' property in its
−	``driver_info``.  This will contain the Glance UUID of the ISO	+	'''driver_info'''.  This will contain the Glance UUID of the ISO
	deploy ramdisk image.		deploy ramdisk image.
	* Ironic gets a request to deploy a Glance image on the baremetal node.		* Ironic gets a request to deploy a Glance image on the baremetal node.
−	* ``iscsi_ilo`` driver powers off the baremetal node.	+	* '''iscsi_ilo''' driver powers off the baremetal node.
	* The driver generates a swift-temp-url for the deploy ramdisk image		* The driver generates a swift-temp-url for the deploy ramdisk image
	and attaches it as Virtual Media CDROM on the iLO.		and attaches it as Virtual Media CDROM on the iLO.
Line 130:		Line 130:
	for booting the deployed instance.		for booting the deployed instance.
	* The driver reboots the node.		* The driver reboots the node.
−	* On the first and subsequent reboots ``iscsi_ilo`` driver attaches this boot	+	* On the first and subsequent reboots '''iscsi_ilo''' driver attaches this boot
	ISO image in Swift as Virtual Media CDROM and then sets iLO to boot from it.		ISO image in Swift as Virtual Media CDROM and then sets iLO to boot from it.
	===== Configuring and Enabling the driver =====		===== Configuring and Enabling the driver =====
−	1. Prepare an ISO deploy ramdisk image from ``diskimage-builder`` [3]_.  This	+	1. Prepare an ISO deploy ramdisk image from '''diskimage-builder''' [3]_.  This
−	can be done by adding the ``iso`` element to the ``ramdisk-image-create``	+	can be done by adding the '''iso''' element to the '''ramdisk-image-create'''
	command.  This command creates the deploy kernel/ramdisk as well as a		command.  This command creates the deploy kernel/ramdisk as well as a
	bootable ISO image containing the deploy kernel and ramdisk.		bootable ISO image containing the deploy kernel and ramdisk.
−	The below command creates files named ``deploy-ramdisk.kernel``,	+	The below command creates files named '''deploy-ramdisk.kernel''',
−	``deploy-ramdisk.initramfs`` and ``deploy-ramdisk.iso`` in the current	+	'''deploy-ramdisk.initramfs''' and '''deploy-ramdisk.iso''' in the current
	working directory.::		working directory.::
Line 154:		Line 154:
	4. Set a temp-url key for Glance user in Swift. For example, if you have		4. Set a temp-url key for Glance user in Swift. For example, if you have
−	configured Glance with user ``glance-swift`` and tenant as ``service``,	+	configured Glance with user '''glance-swift''' and tenant as '''service''',
	then run the below command::		then run the below command::
	swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance		swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance
−	5. Fill the required parameters in the ``[glance]`` section  in	+	5. Fill the required parameters in the '''[glance]''' section  in
−	``/etc/ironic/ironic.conf``. Normally you would be required to fill in the	+	'''/etc/ironic/ironic.conf'''. Normally you would be required to fill in the
	following details.::		following details.::
Line 179:		Line 179:
	6. Swift must be accessible with the same admin credentials configured in		6. Swift must be accessible with the same admin credentials configured in
	Ironic. For example, if Ironic is configured with the below credentials in		Ironic. For example, if Ironic is configured with the below credentials in
−	``/etc/ironic/ironic.conf``.::	+	'''/etc/ironic/ironic.conf'''.::
	[keystone_authtoken]		[keystone_authtoken]
Line 186:		Line 186:
	admin_tenant_name = service		admin_tenant_name = service
−	Ensure ``auth_version`` in ``keystone_authtoken`` to 2.	+	Ensure '''auth_version''' in '''keystone_authtoken''' to 2.
	Then, the below command should work.::		Then, the below command should work.::
Line 204:		Line 204:
−	7. Add ``iscsi_ilo`` to the list of ``enabled_drivers`` in	+	7. Add '''iscsi_ilo''' to the list of '''enabled_drivers''' in
−	``/etc/ironic/ironic.conf``.  For example:::	+	'''/etc/ironic/ironic.conf'''.  For example:::
	enabled_drivers = fake,pxe_ssh,pxe_ipmitool,iscsi_ilo		enabled_drivers = fake,pxe_ssh,pxe_ipmitool,iscsi_ilo
Line 215:		Line 215:
	===== Registering Proliant node in Ironic =====		===== Registering Proliant node in Ironic =====
−	Nodes configured for iLO driver should have the ``driver`` property set to	+	Nodes configured for iLO driver should have the '''driver''' property set to
−	``iscsi_ilo``.  The following configuration values are also required in	+	'''iscsi_ilo'''.  The following configuration values are also required in
−	``driver_info``:	+	'''driver_info''':
−	- ``ilo_address``: IP address or hostname of the iLO.	+	- '''ilo_address''': IP address or hostname of the iLO.
−	- ``ilo_username``: Username for the iLO with administrator privileges.	+	- '''ilo_username''': Username for the iLO with administrator privileges.
−	- ``ilo_password``: Password for the above iLO user.	+	- '''ilo_password''': Password for the above iLO user.
−	- ``ilo_deploy_iso``: The Glance UUID of the deploy ramdisk ISO image.	+	- '''ilo_deploy_iso''': The Glance UUID of the deploy ramdisk ISO image.
−	- ``client_port``: (optional) Port to be used for iLO operations if you are	+	- '''client_port''': (optional) Port to be used for iLO operations if you are
	using a custom port on the iLO.  Default port used is 443.		using a custom port on the iLO.  Default port used is 443.
−	- ``client_timeout``: (optional) Timeout for iLO operations. Default timeout	+	- '''client_timeout''': (optional) Timeout for iLO operations. Default timeout
	is 60 seconds.		is 60 seconds.
−	- ``console_port``: (optional) Node's UDP port for console access. Any unused	+	- '''console_port''': (optional) Node's UDP port for console access. Any unused
	port on the Ironic conductor node may be used.		port on the Ironic conductor node may be used.
	===== Boot modes =====		===== Boot modes =====
−	``iscsi_ilo`` driver supports automatic detection and setting of boot mode	+	'''iscsi_ilo''' driver supports automatic detection and setting of boot mode
	(Legacy BIOS or UEFI).		(Legacy BIOS or UEFI).
−	* When no boot mode setting is provided, ``iscsi_ilo`` driver preserves the	+	* When no boot mode setting is provided, '''iscsi_ilo''' driver preserves the
	current boot mode on the deployed instance.		current boot mode on the deployed instance.
	* A requirement of a specific boot mode may be provided by adding		* A requirement of a specific boot mode may be provided by adding
−	``boot_mode:bios`` or ``boot_mode:uefi`` to ``capabilities`` property within	+	'''boot_mode:bios''' or '''boot_mode:uefi''' to '''capabilities''' property within
−	the ``properties`` field of an Ironic node. Then ``iscsi_ilo`` driver will	+	the '''properties''' field of an Ironic node. Then '''iscsi_ilo''' driver will
	deploy and configure the instance in the appropriate boot mode.		deploy and configure the instance in the appropriate boot mode.
Line 249:		Line 249:
	**NOTES**:		**NOTES**:
−	* We recommend setting the ``boot_mode`` property on systems that support both	+	* We recommend setting the '''boot_mode''' property on systems that support both
	UEFI and legacy modes if user wants facility in Nova to choose a baremetal		UEFI and legacy modes if user wants facility in Nova to choose a baremetal
	node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9		node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9
	systems.		systems.
−	* ``iscsi_ilo`` driver automatically set boot mode from BIOS to UEFI, if the	+	* '''iscsi_ilo''' driver automatically set boot mode from BIOS to UEFI, if the
	requested boot mode in nova boot is UEFI. However, users will need to		requested boot mode in nova boot is UEFI. However, users will need to
	pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they		pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they
Line 259:		Line 259:
	* Currently for UEFI boot mode, automatic creation of boot ISO doesn't		* Currently for UEFI boot mode, automatic creation of boot ISO doesn't
	work. The boot ISO for the deploy image needs to be built separately and the		work. The boot ISO for the deploy image needs to be built separately and the
−	deploy image's ``boot_iso`` property in Glance should contain the Glance UUID	+	deploy image's '''boot_iso''' property in Glance should contain the Glance UUID
	of the boot ISO. For instructions on building boot ISO, refer iLO driver wiki		of the boot ISO. For instructions on building boot ISO, refer iLO driver wiki
	[6]_.		[6]_.
	* From nova, specific boot mode may be requested by using the		* From nova, specific boot mode may be requested by using the
−	``ComputeCapabilitesFilter``. For example, it can be set in a flavor like	+	'''ComputeCapabilitesFilter'''. For example, it can be set in a flavor like
	below::		below::
Line 272:		Line 272:
	===== Overview =====		===== Overview =====
−	``agent_ilo`` driver was introduced as an alternative to ``agent_ipmitool``	+	'''agent_ilo''' driver was introduced as an alternative to '''agent_ipmitool'''
−	and ``agent_ipminative`` drivers for HP Proliant servers. ``agent_ilo`` driver	+	and '''agent_ipminative''' drivers for HP Proliant servers. '''agent_ilo''' driver
	uses virtual media feature in HP Proliant baremetal servers to boot up the		uses virtual media feature in HP Proliant baremetal servers to boot up the
	Ironic Python Agent (IPA) on the baremetal node instead of using PXE. For		Ironic Python Agent (IPA) on the baremetal node instead of using PXE. For
Line 311:		Line 311:
	FAT images as well as boot ISO images.		FAT images as well as boot ISO images.
	* **Glance Image Service with Swift configured as its backend** - When using		* **Glance Image Service with Swift configured as its backend** - When using
−	``agent_ilo`` driver, the image containing the agent is retrieved from	+	'''agent_ilo''' driver, the image containing the agent is retrieved from
	Swift directly by the iLO.		Swift directly by the iLO.
	===== Deploy Process =====		===== Deploy Process =====
−	* Admin configures the Proliant baremetal node for ``agent_ilo`` driver. The	+	* Admin configures the Proliant baremetal node for '''agent_ilo''' driver. The
−	Ironic node configured will have the ``ilo_deploy_iso`` property in its	+	Ironic node configured will have the '''ilo_deploy_iso''' property in its
−	``driver_info``.  This will contain the Glance UUID of the ISO deploy agent	+	'''driver_info'''.  This will contain the Glance UUID of the ISO deploy agent
	image containing the agent.		image containing the agent.
	* Ironic gets a request to deploy a Glance image on the baremetal node.		* Ironic gets a request to deploy a Glance image on the baremetal node.
Line 339:		Line 339:
	1. Prepare an ISO deploy Ironic Python Agent image containing the agent [5]_.		1. Prepare an ISO deploy Ironic Python Agent image containing the agent [5]_.
	This can be done by using the iso-image-create script found within		This can be done by using the iso-image-create script found within
−	the agent. The below set of commands will create a file ``ipa-ramdisk.iso``	+	the agent. The below set of commands will create a file '''ipa-ramdisk.iso'''
−	in the below directory ``UPLOAD``::	+	in the below directory '''UPLOAD'''::
	$ cd <directory-containing-ironic-python-agent>		$ cd <directory-containing-ironic-python-agent>
Line 357:		Line 357:
	[4]_ for configuration instructions.		[4]_ for configuration instructions.
	4. Set a temp-url key for Glance user in Swift. For example, if you have		4. Set a temp-url key for Glance user in Swift. For example, if you have
−	configured Glance with user ``glance-swift`` and tenant as ``service``,	+	configured Glance with user '''glance-swift''' and tenant as '''service''',
	then run the below command::		then run the below command::
	swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance		swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance
−	5. Fill the required parameters in the ``[glance]`` section  in	+	5. Fill the required parameters in the '''[glance]''' section  in
−	``/etc/ironic/ironic.conf``. Normally you would be required to fill in the	+	'''/etc/ironic/ironic.conf'''. Normally you would be required to fill in the
	following details.::		following details.::
Line 382:		Line 382:
	6. Swift must be accessible with the same admin credentials configured in		6. Swift must be accessible with the same admin credentials configured in
	Ironic. For example, if Ironic is configured with the below credentials in		Ironic. For example, if Ironic is configured with the below credentials in
−	``/etc/ironic/ironic.conf``.::	+	'''/etc/ironic/ironic.conf'''.::
	[keystone_authtoken]		[keystone_authtoken]
Line 389:		Line 389:
	admin_tenant_name = service		admin_tenant_name = service
−	Ensure ``auth_version`` in ``keystone_authtoken`` to 2.	+	Ensure '''auth_version''' in '''keystone_authtoken''' to 2.
	Then, the below command should work.::		Then, the below command should work.::
Line 407:		Line 407:
−	7. Add ``agent_ilo`` to the list of ``enabled_drivers`` in	+	7. Add '''agent_ilo''' to the list of '''enabled_drivers''' in
−	``/etc/ironic/ironic.conf``.  For example:::	+	'''/etc/ironic/ironic.conf'''.  For example:::
	enabled_drivers = fake,pxe_ssh,pxe_ipmitool,agent_ilo		enabled_drivers = fake,pxe_ssh,pxe_ipmitool,agent_ilo
Line 419:		Line 419:
	===== Registering Proliant node in Ironic =====		===== Registering Proliant node in Ironic =====
−	Nodes configured for iLO driver should have the ``driver`` property set to	+	Nodes configured for iLO driver should have the '''driver''' property set to
−	``agent_ilo``.  The following configuration values are also required in	+	'''agent_ilo'''.  The following configuration values are also required in
−	``driver_info``:	+	'''driver_info''':
−	- ``ilo_address``: IP address or hostname of the iLO.	+	- '''ilo_address''': IP address or hostname of the iLO.
−	- ``ilo_username``: Username for the iLO with administrator privileges.	+	- '''ilo_username''': Username for the iLO with administrator privileges.
−	- ``ilo_password``: Password for the above iLO user.	+	- '''ilo_password''': Password for the above iLO user.
−	- ``ilo_deploy_iso``: The Glance UUID of the deploy agent ISO image containing	+	- '''ilo_deploy_iso''': The Glance UUID of the deploy agent ISO image containing
	the agent.		the agent.
−	- ``client_port``: (optional) Port to be used for iLO operations if you are	+	- '''client_port''': (optional) Port to be used for iLO operations if you are
	using a custom port on the iLO. Default port used is 443.		using a custom port on the iLO. Default port used is 443.
−	- ``client_timeout``: (optional) Timeout for iLO operations. Default timeout	+	- '''client_timeout''': (optional) Timeout for iLO operations. Default timeout
	is 60 seconds.		is 60 seconds.
−	- ``console_port``: (optional) Node's UDP port for console access. Any unused	+	- '''console_port''': (optional) Node's UDP port for console access. Any unused
	port on the Ironic conductor node may be used.		port on the Ironic conductor node may be used.
Line 441:		Line 441:
	===== Overview =====		===== Overview =====
−	``pxe_ilo`` driver uses PXE/iSCSI (just like ``pxe_ipmitool`` driver) to	+	'''pxe_ilo''' driver uses PXE/iSCSI (just like '''pxe_ipmitool''' driver) to
	deploy the image and uses iLO to do all management operations on the baremetal		deploy the image and uses iLO to do all management operations on the baremetal
	node(instead of using IPMI).		node(instead of using IPMI).
Line 474:		Line 474:
	===== Configuring and Enabling the driver =====		===== Configuring and Enabling the driver =====
−	1. Prepare an ISO deploy ramdisk image from ``diskimage-builder`` [3]_.	+	1. Prepare an ISO deploy ramdisk image from '''diskimage-builder''' [3]_.
−	The below command creates a file named ``deploy-ramdisk.kernel`` and	+	The below command creates a file named '''deploy-ramdisk.kernel''' and
−	``deploy-ramdisk.initramfs`` in the current working directory::	+	'''deploy-ramdisk.initramfs''' in the current working directory::
	cd <path-to-diskimage-builder>		cd <path-to-diskimage-builder>
Line 487:		Line 487:
	glance image-create --name deploy-ramdisk.initramfs --disk-format ari --container-format ari < deploy-ramdisk.initramfs		glance image-create --name deploy-ramdisk.initramfs --disk-format ari --container-format ari < deploy-ramdisk.initramfs
−	7. Add ``pxe_ilo`` to the list of ``enabled_drivers`` in	+	7. Add '''pxe_ilo''' to the list of '''enabled_drivers''' in
−	``/etc/ironic/ironic.conf``.  For example:::	+	'''/etc/ironic/ironic.conf'''.  For example:::
	enabled_drivers = fake,pxe_ssh,pxe_ipmitool,pxe_ilo		enabled_drivers = fake,pxe_ssh,pxe_ipmitool,pxe_ilo
Line 498:		Line 498:
	===== Registering Proliant node in Ironic =====		===== Registering Proliant node in Ironic =====
−	Nodes configured for iLO driver should have the ``driver`` property set to	+	Nodes configured for iLO driver should have the '''driver''' property set to
−	``pxe_ilo``.  The following configuration values are also required in	+	'''pxe_ilo'''.  The following configuration values are also required in
−	``driver_info``:	+	'''driver_info''':
−	- ``ilo_address``: IP address or hostname of the iLO.	+	- '''ilo_address''': IP address or hostname of the iLO.
−	- ``ilo_username``: Username for the iLO with administrator privileges.	+	- '''ilo_username''': Username for the iLO with administrator privileges.
−	- ``ilo_password``: Password for the above iLO user.	+	- '''ilo_password''': Password for the above iLO user.
−	- ``pxe_deploy_kernel``: The Glance UUID of the deployment kernel.	+	- '''pxe_deploy_kernel''': The Glance UUID of the deployment kernel.
−	- ``pxe_deploy_ramdisk``: The Glance UUID of the deployment ramdisk.	+	- '''pxe_deploy_ramdisk''': The Glance UUID of the deployment ramdisk.
−	- ``client_port``: (optional) Port to be used for iLO operations if you are	+	- '''client_port''': (optional) Port to be used for iLO operations if you are
	using a custom port on the iLO. Default port used is 443.		using a custom port on the iLO. Default port used is 443.
−	- ``client_timeout``: (optional) Timeout for iLO operations. Default timeout	+	- '''client_timeout''': (optional) Timeout for iLO operations. Default timeout
	is 60 seconds.		is 60 seconds.
−	- ``console_port``: (optional) Node's UDP port for console access. Any unused	+	- '''console_port''': (optional) Node's UDP port for console access. Any unused
	port on the Ironic conductor node may be used.		port on the Ironic conductor node may be used.
	===== Boot modes =====		===== Boot modes =====
−	``pxe_ilo`` driver supports automatic detection and setting of boot mode	+	'''pxe_ilo''' driver supports automatic detection and setting of boot mode
	(Legacy BIOS or UEFI).		(Legacy BIOS or UEFI).
−	* When no boot mode setting is provided, ``pxe_ilo`` driver preserves the	+	* When no boot mode setting is provided, '''pxe_ilo''' driver preserves the
	current boot mode on the deployed instance.		current boot mode on the deployed instance.
	* A requirement of a specific boot mode may be provided by adding		* A requirement of a specific boot mode may be provided by adding
−	``boot_mode:bios`` or ``boot_mode:uefi`` to ``capabilities`` property within	+	'''boot_mode:bios''' or '''boot_mode:uefi''' to '''capabilities''' property within
−	the ``properties`` field of an Ironic node. Then ``pxe_ilo`` driver will	+	the '''properties''' field of an Ironic node. Then '''pxe_ilo''' driver will
	deploy and configure the instance in the appropriate boot mode.::		deploy and configure the instance in the appropriate boot mode.::
Line 530:		Line 530:
	**NOTES**:		**NOTES**:
−	* We recommend setting the ``boot_mode`` property on systems that support both	+	* We recommend setting the '''boot_mode''' property on systems that support both
	UEFI and legacy modes if user wants facility in Nova to choose a baremetal		UEFI and legacy modes if user wants facility in Nova to choose a baremetal
	node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9		node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9
	systems.		systems.
−	* ``pxe_ilo`` driver automatically set boot mode from BIOS to UEFI, if the	+	* '''pxe_ilo''' driver automatically set boot mode from BIOS to UEFI, if the
	requested boot mode in nova boot is UEFI. However, users will need to		requested boot mode in nova boot is UEFI. However, users will need to
	pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they		pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they
	want to deploy the node in legacy mode.		want to deploy the node in legacy mode.
	* From nova, specific boot mode may be requested by using the		* From nova, specific boot mode may be requested by using the
−	``ComputeCapabilitesFilter``. For example, it can be set in a flavor like	+	'''ComputeCapabilitesFilter'''. For example, it can be set in a flavor like
	below::		below::
Line 562:		Line 562:
	Overview		Overview
	16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]])		16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]])
−	``iscsi_ilo`` driver was introduced as an alternative to ``pxe_ipmitool``	+	'''iscsi_ilo''' driver was introduced as an alternative to '''pxe_ipmitool'''
−	and ``pxe_ipminative`` drivers for HP Proliant servers. ``iscsi_ilo`` uses	+	and '''pxe_ipminative''' drivers for HP Proliant servers. '''iscsi_ilo''' uses
	virtual media feature in iLO to boot up the baremetal node instead of using		virtual media feature in iLO to boot up the baremetal node instead of using
	PXE or iPXE.		PXE or iPXE.
Line 572:		Line 572:
	* Users who do not want to use PXE/TFTP protocol on their data centres.		* Users who do not want to use PXE/TFTP protocol on their data centres.
	* Current PXE driver passes authentication token in clear-text over		* Current PXE driver passes authentication token in clear-text over
−	tftp to the baremetal node. ``iscsi_ilo`` driver enhances the security	+	tftp to the baremetal node. '''iscsi_ilo''' driver enhances the security
	by passing keystone authtoken and management info over encrypted		by passing keystone authtoken and management info over encrypted
	management network. This driver may be used by users who have concerns		management network. This driver may be used by users who have concerns
Line 614:		Line 614:
	FAT images as well as boot ISO images.		FAT images as well as boot ISO images.
	* **Glance Image Service with Swift configured as its backend** - When using		* **Glance Image Service with Swift configured as its backend** - When using
−	``iscsi_ilo`` driver, the image containing the deploy ramdisk is retrieved	+	'''iscsi_ilo''' driver, the image containing the deploy ramdisk is retrieved
	from Swift directly by the iLO.		from Swift directly by the iLO.
Line 621:		Line 621:
	16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]]) 16:25, 20 October 2014 (UTC)		16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]]) 16:25, 20 October 2014 (UTC)
	* Admin configures the Proliant baremetal node for iscsi_ilo driver. The		* Admin configures the Proliant baremetal node for iscsi_ilo driver. The
−	Ironic node configured will have the ``ilo_deploy_iso`` property in its	+	Ironic node configured will have the '''ilo_deploy_iso''' property in its
−	``driver_info``.  This will contain the Glance UUID of the ISO	+	'''driver_info'''.  This will contain the Glance UUID of the ISO
	deploy ramdisk image.		deploy ramdisk image.
	* Ironic gets a request to deploy a Glance image on the baremetal node.		* Ironic gets a request to deploy a Glance image on the baremetal node.
−	* ``iscsi_ilo`` driver powers off the baremetal node.	+	* '''iscsi_ilo''' driver powers off the baremetal node.
	* The driver generates a swift-temp-url for the deploy ramdisk image		* The driver generates a swift-temp-url for the deploy ramdisk image
	and attaches it as Virtual Media CDROM on the iLO.		and attaches it as Virtual Media CDROM on the iLO.
Line 642:		Line 642:
	for booting the deployed instance.		for booting the deployed instance.
	* The driver reboots the node.		* The driver reboots the node.
−	* On the first and subsequent reboots ``iscsi_ilo`` driver attaches this boot	+	* On the first and subsequent reboots '''iscsi_ilo''' driver attaches this boot
	ISO image in Swift as Virtual Media CDROM and then sets iLO to boot from it.		ISO image in Swift as Virtual Media CDROM and then sets iLO to boot from it.
	Configuring and Enabling the driver		Configuring and Enabling the driver
	16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)		16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)
−	1. Prepare an ISO deploy ramdisk image from ``diskimage-builder`` [3]_.  This	+	1. Prepare an ISO deploy ramdisk image from '''diskimage-builder''' [3]_.  This
−	can be done by adding the ``iso`` element to the ``ramdisk-image-create``	+	can be done by adding the '''iso''' element to the '''ramdisk-image-create'''
	command.  This command creates the deploy kernel/ramdisk as well as a		command.  This command creates the deploy kernel/ramdisk as well as a
	bootable ISO image containing the deploy kernel and ramdisk.		bootable ISO image containing the deploy kernel and ramdisk.
−	The below command creates files named ``deploy-ramdisk.kernel``,	+	The below command creates files named '''deploy-ramdisk.kernel''',
−	``deploy-ramdisk.initramfs`` and ``deploy-ramdisk.iso`` in the current	+	'''deploy-ramdisk.initramfs''' and '''deploy-ramdisk.iso''' in the current
	working directory.::		working directory.::
Line 667:		Line 667:
	4. Set a temp-url key for Glance user in Swift. For example, if you have		4. Set a temp-url key for Glance user in Swift. For example, if you have
−	configured Glance with user ``glance-swift`` and tenant as ``service``,	+	configured Glance with user '''glance-swift''' and tenant as '''service''',
	then run the below command::		then run the below command::
	swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance		swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance
−	5. Fill the required parameters in the ``[glance]`` section  in	+	5. Fill the required parameters in the '''[glance]''' section  in
−	``/etc/ironic/ironic.conf``. Normally you would be required to fill in the	+	'''/etc/ironic/ironic.conf'''. Normally you would be required to fill in the
	following details.::		following details.::
Line 692:		Line 692:
	6. Swift must be accessible with the same admin credentials configured in		6. Swift must be accessible with the same admin credentials configured in
	Ironic. For example, if Ironic is configured with the below credentials in		Ironic. For example, if Ironic is configured with the below credentials in
−	``/etc/ironic/ironic.conf``.::	+	'''/etc/ironic/ironic.conf'''.::
	[keystone_authtoken]		[keystone_authtoken]
Line 699:		Line 699:
	admin_tenant_name = service		admin_tenant_name = service
−	Ensure ``auth_version`` in ``keystone_authtoken`` to 2.	+	Ensure '''auth_version''' in '''keystone_authtoken''' to 2.
	Then, the below command should work.::		Then, the below command should work.::
Line 717:		Line 717:
−	7. Add ``iscsi_ilo`` to the list of ``enabled_drivers`` in	+	7. Add '''iscsi_ilo''' to the list of '''enabled_drivers''' in
−	``/etc/ironic/ironic.conf``.  For example:::	+	'''/etc/ironic/ironic.conf'''.  For example:::
	enabled_drivers = fake,pxe_ssh,pxe_ipmitool,iscsi_ilo		enabled_drivers = fake,pxe_ssh,pxe_ipmitool,iscsi_ilo
Line 728:		Line 728:
	Registering Proliant node in Ironic		Registering Proliant node in Ironic
	16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)		16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)
−	Nodes configured for iLO driver should have the ``driver`` property set to	+	Nodes configured for iLO driver should have the '''driver''' property set to
−	``iscsi_ilo``.  The following configuration values are also required in	+	'''iscsi_ilo'''.  The following configuration values are also required in
−	``driver_info``:	+	'''driver_info''':
−	- ``ilo_address``: IP address or hostname of the iLO.	+	- '''ilo_address''': IP address or hostname of the iLO.
−	- ``ilo_username``: Username for the iLO with administrator privileges.	+	- '''ilo_username''': Username for the iLO with administrator privileges.
−	- ``ilo_password``: Password for the above iLO user.	+	- '''ilo_password''': Password for the above iLO user.
−	- ``ilo_deploy_iso``: The Glance UUID of the deploy ramdisk ISO image.	+	- '''ilo_deploy_iso''': The Glance UUID of the deploy ramdisk ISO image.
−	- ``client_port``: (optional) Port to be used for iLO operations if you are	+	- '''client_port''': (optional) Port to be used for iLO operations if you are
	using a custom port on the iLO.  Default port used is 443.		using a custom port on the iLO.  Default port used is 443.
−	- ``client_timeout``: (optional) Timeout for iLO operations. Default timeout	+	- '''client_timeout''': (optional) Timeout for iLO operations. Default timeout
	is 60 seconds.		is 60 seconds.
−	- ``console_port``: (optional) Node's UDP port for console access. Any unused	+	- '''console_port''': (optional) Node's UDP port for console access. Any unused
	port on the Ironic conductor node may be used.		port on the Ironic conductor node may be used.
Line 746:		Line 746:
	Boot modes		Boot modes
	16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)		16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)
−	``iscsi_ilo`` driver supports automatic detection and setting of boot mode	+	'''iscsi_ilo''' driver supports automatic detection and setting of boot mode
	(Legacy BIOS or UEFI).		(Legacy BIOS or UEFI).
−	* When no boot mode setting is provided, ``iscsi_ilo`` driver preserves the	+	* When no boot mode setting is provided, '''iscsi_ilo''' driver preserves the
	current boot mode on the deployed instance.		current boot mode on the deployed instance.
	* A requirement of a specific boot mode may be provided by adding		* A requirement of a specific boot mode may be provided by adding
−	``boot_mode:bios`` or ``boot_mode:uefi`` to ``capabilities`` property within	+	'''boot_mode:bios''' or '''boot_mode:uefi''' to '''capabilities''' property within
−	the ``properties`` field of an Ironic node. Then ``iscsi_ilo`` driver will	+	the '''properties''' field of an Ironic node. Then '''iscsi_ilo''' driver will
	deploy and configure the instance in the appropriate boot mode.		deploy and configure the instance in the appropriate boot mode.
Line 763:		Line 763:
	**NOTES**:		**NOTES**:
−	* We recommend setting the ``boot_mode`` property on systems that support both	+	* We recommend setting the '''boot_mode''' property on systems that support both
	UEFI and legacy modes if user wants facility in Nova to choose a baremetal		UEFI and legacy modes if user wants facility in Nova to choose a baremetal
	node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9		node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9
	systems.		systems.
−	* ``iscsi_ilo`` driver automatically set boot mode from BIOS to UEFI, if the	+	* '''iscsi_ilo''' driver automatically set boot mode from BIOS to UEFI, if the
	requested boot mode in nova boot is UEFI. However, users will need to		requested boot mode in nova boot is UEFI. However, users will need to
	pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they		pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they
Line 773:		Line 773:
	* Currently for UEFI boot mode, automatic creation of boot ISO doesn't		* Currently for UEFI boot mode, automatic creation of boot ISO doesn't
	work. The boot ISO for the deploy image needs to be built separately and the		work. The boot ISO for the deploy image needs to be built separately and the
−	deploy image's ``boot_iso`` property in Glance should contain the Glance UUID	+	deploy image's '''boot_iso''' property in Glance should contain the Glance UUID
	of the boot ISO. For instructions on building boot ISO, refer iLO driver wiki		of the boot ISO. For instructions on building boot ISO, refer iLO driver wiki
	[6]_.		[6]_.
	* From nova, specific boot mode may be requested by using the		* From nova, specific boot mode may be requested by using the
−	``ComputeCapabilitesFilter``. For example, it can be set in a flavor like	+	'''ComputeCapabilitesFilter'''. For example, it can be set in a flavor like
	below::		below::
Line 788:		Line 788:
	Overview		Overview
	16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]])		16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]])
−	``agent_ilo`` driver was introduced as an alternative to ``agent_ipmitool``	+	'''agent_ilo''' driver was introduced as an alternative to '''agent_ipmitool'''
−	and ``agent_ipminative`` drivers for HP Proliant servers. ``agent_ilo`` driver	+	and '''agent_ipminative''' drivers for HP Proliant servers. '''agent_ilo''' driver
	uses virtual media feature in HP Proliant baremetal servers to boot up the		uses virtual media feature in HP Proliant baremetal servers to boot up the
	Ironic Python Agent (IPA) on the baremetal node instead of using PXE. For		Ironic Python Agent (IPA) on the baremetal node instead of using PXE. For
Line 827:		Line 827:
	FAT images as well as boot ISO images.		FAT images as well as boot ISO images.
	* **Glance Image Service with Swift configured as its backend** - When using		* **Glance Image Service with Swift configured as its backend** - When using
−	``agent_ilo`` driver, the image containing the agent is retrieved from	+	'''agent_ilo''' driver, the image containing the agent is retrieved from
	Swift directly by the iLO.		Swift directly by the iLO.
	Deploy Process		Deploy Process
	16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]]) 16:25, 20 October 2014 (UTC)		16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]]) 16:25, 20 October 2014 (UTC)
−	* Admin configures the Proliant baremetal node for ``agent_ilo`` driver. The	+	* Admin configures the Proliant baremetal node for '''agent_ilo''' driver. The
−	Ironic node configured will have the ``ilo_deploy_iso`` property in its	+	Ironic node configured will have the '''ilo_deploy_iso''' property in its
−	``driver_info``.  This will contain the Glance UUID of the ISO deploy agent	+	'''driver_info'''.  This will contain the Glance UUID of the ISO deploy agent
	image containing the agent.		image containing the agent.
	* Ironic gets a request to deploy a Glance image on the baremetal node.		* Ironic gets a request to deploy a Glance image on the baremetal node.
Line 855:		Line 855:
	1. Prepare an ISO deploy Ironic Python Agent image containing the agent [5]_.		1. Prepare an ISO deploy Ironic Python Agent image containing the agent [5]_.
	This can be done by using the iso-image-create script found within		This can be done by using the iso-image-create script found within
−	the agent. The below set of commands will create a file ``ipa-ramdisk.iso``	+	the agent. The below set of commands will create a file '''ipa-ramdisk.iso'''
−	in the below directory ``UPLOAD``::	+	in the below directory '''UPLOAD'''::
	$ cd <directory-containing-ironic-python-agent>		$ cd <directory-containing-ironic-python-agent>
Line 873:		Line 873:
	[4]_ for configuration instructions.		[4]_ for configuration instructions.
	4. Set a temp-url key for Glance user in Swift. For example, if you have		4. Set a temp-url key for Glance user in Swift. For example, if you have
−	configured Glance with user ``glance-swift`` and tenant as ``service``,	+	configured Glance with user '''glance-swift''' and tenant as '''service''',
	then run the below command::		then run the below command::
	swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance		swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance
−	5. Fill the required parameters in the ``[glance]`` section  in	+	5. Fill the required parameters in the '''[glance]''' section  in
−	``/etc/ironic/ironic.conf``. Normally you would be required to fill in the	+	'''/etc/ironic/ironic.conf'''. Normally you would be required to fill in the
	following details.::		following details.::
Line 898:		Line 898:
	6. Swift must be accessible with the same admin credentials configured in		6. Swift must be accessible with the same admin credentials configured in
	Ironic. For example, if Ironic is configured with the below credentials in		Ironic. For example, if Ironic is configured with the below credentials in
−	``/etc/ironic/ironic.conf``.::	+	'''/etc/ironic/ironic.conf'''.::
	[keystone_authtoken]		[keystone_authtoken]
Line 905:		Line 905:
	admin_tenant_name = service		admin_tenant_name = service
−	Ensure ``auth_version`` in ``keystone_authtoken`` to 2.	+	Ensure '''auth_version''' in '''keystone_authtoken''' to 2.
	Then, the below command should work.::		Then, the below command should work.::
Line 923:		Line 923:
−	7. Add ``agent_ilo`` to the list of ``enabled_drivers`` in	+	7. Add '''agent_ilo''' to the list of '''enabled_drivers''' in
−	``/etc/ironic/ironic.conf``.  For example:::	+	'''/etc/ironic/ironic.conf'''.  For example:::
	enabled_drivers = fake,pxe_ssh,pxe_ipmitool,agent_ilo		enabled_drivers = fake,pxe_ssh,pxe_ipmitool,agent_ilo
Line 935:		Line 935:
	Registering Proliant node in Ironic		Registering Proliant node in Ironic
	16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)		16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)
−	Nodes configured for iLO driver should have the ``driver`` property set to	+	Nodes configured for iLO driver should have the '''driver''' property set to
−	``agent_ilo``.  The following configuration values are also required in	+	'''agent_ilo'''.  The following configuration values are also required in
−	``driver_info``:	+	'''driver_info''':
−	- ``ilo_address``: IP address or hostname of the iLO.	+	- '''ilo_address''': IP address or hostname of the iLO.
−	- ``ilo_username``: Username for the iLO with administrator privileges.	+	- '''ilo_username''': Username for the iLO with administrator privileges.
−	- ``ilo_password``: Password for the above iLO user.	+	- '''ilo_password''': Password for the above iLO user.
−	- ``ilo_deploy_iso``: The Glance UUID of the deploy agent ISO image containing	+	- '''ilo_deploy_iso''': The Glance UUID of the deploy agent ISO image containing
	the agent.		the agent.
−	- ``client_port``: (optional) Port to be used for iLO operations if you are	+	- '''client_port''': (optional) Port to be used for iLO operations if you are
	using a custom port on the iLO. Default port used is 443.		using a custom port on the iLO. Default port used is 443.
−	- ``client_timeout``: (optional) Timeout for iLO operations. Default timeout	+	- '''client_timeout''': (optional) Timeout for iLO operations. Default timeout
	is 60 seconds.		is 60 seconds.
−	- ``console_port``: (optional) Node's UDP port for console access. Any unused	+	- '''console_port''': (optional) Node's UDP port for console access. Any unused
	port on the Ironic conductor node may be used.		port on the Ironic conductor node may be used.
Line 957:		Line 957:
	Overview		Overview
	16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]])		16:25, 20 October 2014 (UTC)[[User:Rameshg87|rameshg87]] ([[User talk:Rameshg87|talk]])
−	``pxe_ilo`` driver uses PXE/iSCSI (just like ``pxe_ipmitool`` driver) to	+	'''pxe_ilo''' driver uses PXE/iSCSI (just like '''pxe_ipmitool''' driver) to
	deploy the image and uses iLO to do all management operations on the baremetal		deploy the image and uses iLO to do all management operations on the baremetal
	node(instead of using IPMI).		node(instead of using IPMI).
Line 991:		Line 991:
	Configuring and Enabling the driver		Configuring and Enabling the driver
	16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)		16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)
−	1. Prepare an ISO deploy ramdisk image from ``diskimage-builder`` [3]_.	+	1. Prepare an ISO deploy ramdisk image from '''diskimage-builder''' [3]_.
−	The below command creates a file named ``deploy-ramdisk.kernel`` and	+	The below command creates a file named '''deploy-ramdisk.kernel''' and
−	``deploy-ramdisk.initramfs`` in the current working directory::	+	'''deploy-ramdisk.initramfs''' in the current working directory::
	cd <path-to-diskimage-builder>		cd <path-to-diskimage-builder>
Line 1,004:		Line 1,004:
	glance image-create --name deploy-ramdisk.initramfs --disk-format ari --container-format ari < deploy-ramdisk.initramfs		glance image-create --name deploy-ramdisk.initramfs --disk-format ari --container-format ari < deploy-ramdisk.initramfs
−	7. Add ``pxe_ilo`` to the list of ``enabled_drivers`` in	+	7. Add '''pxe_ilo''' to the list of '''enabled_drivers''' in
−	``/etc/ironic/ironic.conf``.  For example:::	+	'''/etc/ironic/ironic.conf'''.  For example:::
	enabled_drivers = fake,pxe_ssh,pxe_ipmitool,pxe_ilo		enabled_drivers = fake,pxe_ssh,pxe_ipmitool,pxe_ilo
Line 1,015:		Line 1,015:
	Registering Proliant node in Ironic		Registering Proliant node in Ironic
	16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)		16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)
−	Nodes configured for iLO driver should have the ``driver`` property set to	+	Nodes configured for iLO driver should have the '''driver''' property set to
−	``pxe_ilo``.  The following configuration values are also required in	+	'''pxe_ilo'''.  The following configuration values are also required in
−	``driver_info``:	+	'''driver_info''':
−	- ``ilo_address``: IP address or hostname of the iLO.	+	- '''ilo_address''': IP address or hostname of the iLO.
−	- ``ilo_username``: Username for the iLO with administrator privileges.	+	- '''ilo_username''': Username for the iLO with administrator privileges.
−	- ``ilo_password``: Password for the above iLO user.	+	- '''ilo_password''': Password for the above iLO user.
−	- ``pxe_deploy_kernel``: The Glance UUID of the deployment kernel.	+	- '''pxe_deploy_kernel''': The Glance UUID of the deployment kernel.
−	- ``pxe_deploy_ramdisk``: The Glance UUID of the deployment ramdisk.	+	- '''pxe_deploy_ramdisk''': The Glance UUID of the deployment ramdisk.
−	- ``client_port``: (optional) Port to be used for iLO operations if you are	+	- '''client_port''': (optional) Port to be used for iLO operations if you are
	using a custom port on the iLO. Default port used is 443.		using a custom port on the iLO. Default port used is 443.
−	- ``client_timeout``: (optional) Timeout for iLO operations. Default timeout	+	- '''client_timeout''': (optional) Timeout for iLO operations. Default timeout
	is 60 seconds.		is 60 seconds.
−	- ``console_port``: (optional) Node's UDP port for console access. Any unused	+	- '''console_port''': (optional) Node's UDP port for console access. Any unused
	port on the Ironic conductor node may be used.		port on the Ironic conductor node may be used.
	Boot modes		Boot modes
	16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)		16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)
−	``pxe_ilo`` driver supports automatic detection and setting of boot mode	+	'''pxe_ilo''' driver supports automatic detection and setting of boot mode
	(Legacy BIOS or UEFI).		(Legacy BIOS or UEFI).
−	* When no boot mode setting is provided, ``pxe_ilo`` driver preserves the	+	* When no boot mode setting is provided, '''pxe_ilo''' driver preserves the
	current boot mode on the deployed instance.		current boot mode on the deployed instance.
	* A requirement of a specific boot mode may be provided by adding		* A requirement of a specific boot mode may be provided by adding
−	``boot_mode:bios`` or ``boot_mode:uefi`` to ``capabilities`` property within	+	'''boot_mode:bios''' or '''boot_mode:uefi''' to '''capabilities''' property within
−	the ``properties`` field of an Ironic node. Then ``pxe_ilo`` driver will	+	the '''properties''' field of an Ironic node. Then '''pxe_ilo''' driver will
	deploy and configure the instance in the appropriate boot mode.::		deploy and configure the instance in the appropriate boot mode.::
Line 1,047:		Line 1,047:
	**NOTES**:		**NOTES**:
−	* We recommend setting the ``boot_mode`` property on systems that support both	+	* We recommend setting the '''boot_mode''' property on systems that support both
	UEFI and legacy modes if user wants facility in Nova to choose a baremetal		UEFI and legacy modes if user wants facility in Nova to choose a baremetal
	node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9		node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9
	systems.		systems.
−	* ``pxe_ilo`` driver automatically set boot mode from BIOS to UEFI, if the	+	* '''pxe_ilo''' driver automatically set boot mode from BIOS to UEFI, if the
	requested boot mode in nova boot is UEFI. However, users will need to		requested boot mode in nova boot is UEFI. However, users will need to
	pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they		pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they
	want to deploy the node in legacy mode.		want to deploy the node in legacy mode.
	* From nova, specific boot mode may be requested by using the		* From nova, specific boot mode may be requested by using the
−	``ComputeCapabilitesFilter``. For example, it can be set in a flavor like	+	'''ComputeCapabilitesFilter'''. For example, it can be set in a flavor like
	below::		below::
Line 1,065:		Line 1,065:
	References		References
	==========		==========
−	.. [1] HP iLO 4 User Guide - http://h20628.www2.hp.com/km-ext/kmcsdirect/emr_na-c03334051-11.pdf	+	* [1] HP iLO 4 User Guide - http://h20628.www2.hp.com/km-ext/kmcsdirect/emr_na-c03334051-11.pdf
−	.. [2] Proliantutils module - https://pypi.python.org/pypi/proliantutils	+	* [2] Proliantutils module - https://pypi.python.org/pypi/proliantutils
−	.. [3] DiskImage-Builder - https://github.com/openstack/diskimage-builder	+	* [3] DiskImage-Builder - https://github.com/openstack/diskimage-builder
−	.. [4] http://docs.openstack.org/developer/glance/configuring.html#configuring-the-swift-storage-backend	+	* [4] http://docs.openstack.org/developer/glance/configuring.html#configuring-the-swift-storage-backend
−	.. [5] Ironic Python Agent - https://github.com/openstack/ironic-python-agent	+	* [5] Ironic Python Agent - https://github.com/openstack/ironic-python-agent
−	.. [6] https://wiki.openstack.org/wiki/Ironic/Drivers/iLODrivers	+	* [6] https://wiki.openstack.org/wiki/Ironic/Drivers/iLODrivers

---

Revision as of 16:39, 20 October 2014

iLO drivers

Overview

iLO drivers enable to take advantage of features of iLO management engine in HP Proliant servers. iLO drivers are targetted for HP Proliant Gen 8 systems and above which have iLO 4 management engine. [1]_

For more detailed and up-to-date information (like tested platforms, known issues, etc), please check the iLO driver wiki page [6]_.

Currently there are 3 iLO drivers:

• iscsi_ilo
• agent_ilo
• pxe_ilo.

The iscsi_ilo and agent_ilo drivers provide security enhanced PXE-less deployment by using iLO virtual media to boot up the baremetal node. These drivers send management info through management channel and separates it from data channel which is used for deployment. iscsi_ilo driver uses deployment ramdisk built from diskimage-builder, deploys from Ironic conductor node and always does net-boot. agent_ilo driver uses deployment ramdisk built from IPA, deploys from baremetal node and always does local boot.

pxe_ilo driver uses PXE/iSCSI for deployment (just like normal PXE driver), but support automatic setting of requested boot mode from nova. This driver doesn't require iLO Advanced license.

Prerequisites

• proliantutils is a python package which contains a set of modules for

 managing HP Proliant hardware.

 Install proliantutils [2]_ module on the Ironic conductor node. Minimum
 version required is 0.1.0.::

  $ pip install "proliantutils>=0.1.0"

• ipmitool command must be present on the service node(s) where

 ironic-conductor is running. On most distros, this is provided as part
 of the ipmitool package. Source code is available at
 http://ipmitool.sourceforge.net/.

Drivers

iscsi_ilo driver

Overview

iscsi_ilo driver was introduced as an alternative to pxe_ipmitool and pxe_ipminative drivers for HP Proliant servers. iscsi_ilo uses virtual media feature in iLO to boot up the baremetal node instead of using PXE or iPXE.

Target Users

• Users who do not want to use PXE/TFTP protocol on their data centres.
• Current PXE driver passes authentication token in clear-text over

 tftp to the baremetal node. iscsi_ilo driver enhances the security
 by passing keystone authtoken and management info over encrypted
 management network. This driver may be used by users who have concerns
 on PXE drivers security issues and want to have a security enhanced
 PXE-less deployment mechanism.

Tested Platforms

This driver should work on HP Proliant Gen8 Servers and above with iLO 4. It has been tested with the following servers:

• ProLiant DL380e Gen8
• ProLiant DL380e Gen8
• ProLiant DL580 Gen8
• ProLiant DL180 Gen9

For more up-to-date information, check the iLO driver wiki [6]_.

Features

• PXE-less deploy with Virtual Media.
• Automatic detection of current boot mode.
• Automatic setting of the required boot mode if UEFI boot mode is requested

 by the nova flavor's extra spec.

• Always boot from network using Virtual Media.
• UEFI Boot Support
• Passing authentication token via secure, encrypted management network

 (Virtual Media). Provisioning is done using iSCSI over data network
 (like PXE driver), so this driver has the  benefit of security
 enhancement with the same performance. Hence it segregates management info
 from data channel.

• Remote Console
• HW Sensors
• Works well for machines with resource constraints (lesser amount of memory).

Requirements

• **iLO 4 Advanced License** needs to be installed on iLO to enable Virtual

 Media feature.

• **Swift Object Storage Service** - iLO driver uses Swift to store temporary

 FAT images as well as boot ISO images.

• **Glance Image Service with Swift configured as its backend** - When using

 iscsi_ilo driver, the image containing the deploy ramdisk is retrieved
 from Swift directly by the iLO.

Deploy Process

• Admin configures the Proliant baremetal node for iscsi_ilo driver. The

 Ironic node configured will have the ilo_deploy_iso property in its
 driver_info.  This will contain the Glance UUID of the ISO
 deploy ramdisk image.

• Ironic gets a request to deploy a Glance image on the baremetal node.
• iscsi_ilo driver powers off the baremetal node.
• The driver generates a swift-temp-url for the deploy ramdisk image

 and attaches it as Virtual Media CDROM on the iLO.

• The driver creates a small FAT32 image containing parameters to

 the deploy ramdisk. This image is uploaded to Swift and its swift-temp-url
 is attached as Virtual Media Floppy on the iLO.

• The driver sets the node to boot one-time from CDROM.
• The driver powers on the baremetal node.
• The deploy kernel/ramdisk is booted on the baremetal node. The ramdisk

 exposes the local disk over iSCSI and requests Ironic conductor to complete
 the deployment.

• The driver on the Ironic conductor writes the glance image to the

 baremetal node's disk.

• The driver bundles the boot kernel/ramdisk for the Glance deploy

 image into an ISO and then uploads it to Swift. This ISO image will be used
 for booting the deployed instance.

• The driver reboots the node.
• On the first and subsequent reboots iscsi_ilo driver attaches this boot

 ISO image in Swift as Virtual Media CDROM and then sets iLO to boot from it.

Configuring and Enabling the driver

1. Prepare an ISO deploy ramdisk image from diskimage-builder [3]_. This

  can be done by adding the iso element to the ramdisk-image-create
  command.  This command creates the deploy kernel/ramdisk as well as a
  bootable ISO image containing the deploy kernel and ramdisk.

  The below command creates files named deploy-ramdisk.kernel,
  deploy-ramdisk.initramfs and deploy-ramdisk.iso in the current
  working directory.::

   cd <path-to-diskimage-builder>
   ./bin/ramdisk-image-create -o deploy-ramdisk ubuntu deploy-ironic iso

2. Upload this image to Glance.::

   glance image-create --name deploy-ramdisk.iso --disk-format iso --container-format bare < deploy-ramdisk.iso

3. Configure Glance image service with its storage backend as Swift. See

  [4]_ for configuration instructions.

4. Set a temp-url key for Glance user in Swift. For example, if you have

  configured Glance with user glance-swift and tenant as service,
  then run the below command::

   swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance

5. Fill the required parameters in the [glance] section in

  /etc/ironic/ironic.conf. Normally you would be required to fill in the
  following details.::

   [glance]
   swift_temp_url_key=mysecretkeyforglance
   swift_endpoint_url=http://10.10.1.10:8080
   swift_api_version=v1
   swift_account=AUTH_51ea2fb400c34c9eb005ca945c0dc9e1
   swift_container=glance

 The details can be retrieved by running the below command:::

  $ swift --os-username=service:glance-swift stat -v | grep -i url
  StorageURL:     http://10.10.1.10:8080/v1/AUTH_51ea2fb400c34c9eb005ca945c0dc9e1
  Meta Temp-Url-Key: mysecretkeyforglance

6. Swift must be accessible with the same admin credentials configured in

  Ironic. For example, if Ironic is configured with the below credentials in
  /etc/ironic/ironic.conf.::

   [keystone_authtoken]
   admin_password = password
   admin_user = ironic
   admin_tenant_name = service

  Ensure auth_version in keystone_authtoken to 2.

  Then, the below command should work.::

   $ swift --os-username ironic --os-password password --os-tenant-name service --auth-version 2 stat
                        Account: AUTH_22af34365a104e4689c46400297f00cb
                     Containers: 2
                        Objects: 18
                          Bytes: 1728346241
   Objects in policy "policy-0": 18
     Bytes in policy "policy-0": 1728346241
              Meta Temp-Url-Key: mysecretkeyforglance
                    X-Timestamp: 1409763763.84427
                     X-Trans-Id: tx51de96a28f27401eb2833-005433924b
                   Content-Type: text/plain; charset=utf-8
                  Accept-Ranges: bytes

7. Add iscsi_ilo to the list of enabled_drivers in

  /etc/ironic/ironic.conf.  For example:::

   enabled_drivers = fake,pxe_ssh,pxe_ipmitool,iscsi_ilo

8. Restart the Ironic conductor service.::

   $ service ironic-conductor restart

Registering Proliant node in Ironic

Nodes configured for iLO driver should have the driver property set to iscsi_ilo. The following configuration values are also required in driver_info:

- ilo_address: IP address or hostname of the iLO. - ilo_username: Username for the iLO with administrator privileges. - ilo_password: Password for the above iLO user. - ilo_deploy_iso: The Glance UUID of the deploy ramdisk ISO image. - client_port: (optional) Port to be used for iLO operations if you are

 using a custom port on the iLO.  Default port used is 443.

- client_timeout: (optional) Timeout for iLO operations. Default timeout

 is 60 seconds.

- console_port: (optional) Node's UDP port for console access. Any unused

 port on the Ironic conductor node may be used.

Boot modes

iscsi_ilo driver supports automatic detection and setting of boot mode (Legacy BIOS or UEFI).

• When no boot mode setting is provided, iscsi_ilo driver preserves the

 current boot mode on the deployed instance.

• A requirement of a specific boot mode may be provided by adding

 boot_mode:bios or boot_mode:uefi to capabilities property within
 the properties field of an Ironic node. Then iscsi_ilo driver will
 deploy and configure the instance in the appropriate boot mode.

For example, to make a Proliant baremetal node boot in UEFI mode, run the following command::

  ironic node-update <node-id> add properties/capabilities='boot_mode:uefi'

• • NOTES**:

• We recommend setting the boot_mode property on systems that support both

 UEFI and legacy modes if user wants facility in Nova to choose a baremetal
 node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9
 systems.

• iscsi_ilo driver automatically set boot mode from BIOS to UEFI, if the

 requested boot mode in nova boot is UEFI. However, users will need to
 pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they
 want to deploy the node in legacy mode.

• Currently for UEFI boot mode, automatic creation of boot ISO doesn't

 work. The boot ISO for the deploy image needs to be built separately and the
 deploy image's boot_iso property in Glance should contain the Glance UUID
 of the boot ISO. For instructions on building boot ISO, refer iLO driver wiki
 [6]_.

• From nova, specific boot mode may be requested by using the

 ComputeCapabilitesFilter. For example, it can be set in a flavor like
 below::

  nova flavor-key ironic-test-3 set capabilities:boot_mode="uefi"
  nova boot --flavor ironic-test-3 --image test-image instance-1

agent_ilo driver

Overview

agent_ilo driver was introduced as an alternative to agent_ipmitool and agent_ipminative drivers for HP Proliant servers. agent_ilo driver uses virtual media feature in HP Proliant baremetal servers to boot up the Ironic Python Agent (IPA) on the baremetal node instead of using PXE. For more information on IPA, refer https://wiki.openstack.org/wiki/Ironic-python-agent.

Target Users

• Users who do not want to use PXE/TFTP protocol on their data centres.

Tested Platforms

This driver should work on HP Proliant Gen8 Servers and above with iLO 4. It has been tested with the following servers:

• ProLiant DL380e Gen8
• ProLiant DL380e Gen8
• ProLiant DL580 Gen8 legacy mode
• ProLiant DL180 Gen9

For more up-to-date information, check the iLO driver wiki [6]_.

Features

• PXE-less deploy with Virtual Media using Ironic Python Agent.
• Remote Console
• HW Sensors
• IPA runs on the baremetal node and pulls the image directly from Swift.
• IPA deployed instances always boots from local disk.
• Segregates management info from data channel.

Requirements

• **iLO 4 Advanced License** needs to be installed on iLO to enable Virtual

 Media feature.

• **Swift Object Storage Service** - iLO driver uses Swift to store temporary

 FAT images as well as boot ISO images.

• **Glance Image Service with Swift configured as its backend** - When using

 agent_ilo driver, the image containing the agent is retrieved from
 Swift directly by the iLO.

Deploy Process

• Admin configures the Proliant baremetal node for agent_ilo driver. The

 Ironic node configured will have the ilo_deploy_iso property in its
 driver_info.  This will contain the Glance UUID of the ISO deploy agent
 image containing the agent.

• Ironic gets a request to deploy a Glance image on the baremetal node.
• Driver powers off the baremetal node.
• Driver generates a swift-temp-url for the deploy agent image

 and attaches it as Virtual Media CDROM on the iLO.

• Driver creates a small FAT32 image containing parameters to

 the agent ramdisk. This image is uploaded to Swift and its swift-temp-url
 is attached as Virtual Media Floppy on the iLO.

• Driver sets the node to boot one-time from CDROM.
• Driver powers on the baremetal node.
• The deploy kernel/ramdisk containing the agent is booted on the baremetal

 node.  The agent ramdisk talks to the Ironic conductor, downloads the image
 directly from Swift and writes the node's disk.

• Driver sets the node to permanently boot from disk and then reboots

 the node.

Configuring and Enabling the driver

1. Prepare an ISO deploy Ironic Python Agent image containing the agent [5]_.

  This can be done by using the iso-image-create script found within
  the agent. The below set of commands will create a file ipa-ramdisk.iso
  in the below directory UPLOAD::

   $ cd <directory-containing-ironic-python-agent>
   $ cd ./imagebuild/coreos
   $ make iso
   $ cd UPLOAD
   $ ls
   $ coreos_production_pxe_image-oem.cpio.gz  coreos_production_pxe.vmlinuz  ipa-coreos.iso

2. Upload the IPA ramdisk image to Glance.::

   glance image-create --name ipa-ramdisk.iso --disk-format iso --container-format bare < ipa-coreos.iso

3. Configure Glance image service with its storage backend as Swift. See

  [4]_ for configuration instructions.

4. Set a temp-url key for Glance user in Swift. For example, if you have

  configured Glance with user glance-swift and tenant as service,
  then run the below command::

   swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance

5. Fill the required parameters in the [glance] section in

  /etc/ironic/ironic.conf. Normally you would be required to fill in the
  following details.::

   [glance]
   swift_temp_url_key=mysecretkeyforglance
   swift_endpoint_url=http://10.10.1.10:8080
   swift_api_version=v1
   swift_account=AUTH_51ea2fb400c34c9eb005ca945c0dc9e1
   swift_container=glance

 The details can be retrieved by running the below command:::

  $ swift --os-username=service:glance-swift stat -v | grep -i url
  StorageURL:     http://10.10.1.10:8080/v1/AUTH_51ea2fb400c34c9eb005ca945c0dc9e1
  Meta Temp-Url-Key: mysecretkeyforglance

6. Swift must be accessible with the same admin credentials configured in

  Ironic. For example, if Ironic is configured with the below credentials in
  /etc/ironic/ironic.conf.::

   [keystone_authtoken]
   admin_password = password
   admin_user = ironic
   admin_tenant_name = service

  Ensure auth_version in keystone_authtoken to 2.

  Then, the below command should work.::

   $ swift --os-username ironic --os-password password --os-tenant-name service --auth-version 2 stat
                        Account: AUTH_22af34365a104e4689c46400297f00cb
                     Containers: 2
                        Objects: 18
                          Bytes: 1728346241
   Objects in policy "policy-0": 18
     Bytes in policy "policy-0": 1728346241
              Meta Temp-Url-Key: mysecretkeyforglance
                    X-Timestamp: 1409763763.84427
                     X-Trans-Id: tx51de96a28f27401eb2833-005433924b
                   Content-Type: text/plain; charset=utf-8
                  Accept-Ranges: bytes

7. Add agent_ilo to the list of enabled_drivers in

  /etc/ironic/ironic.conf.  For example:::

   enabled_drivers = fake,pxe_ssh,pxe_ipmitool,agent_ilo

8. Restart the Ironic conductor service.::

   $ service ironic-conductor restart

Registering Proliant node in Ironic

Nodes configured for iLO driver should have the driver property set to agent_ilo. The following configuration values are also required in driver_info:

- ilo_address: IP address or hostname of the iLO. - ilo_username: Username for the iLO with administrator privileges. - ilo_password: Password for the above iLO user. - ilo_deploy_iso: The Glance UUID of the deploy agent ISO image containing

  the agent.

- client_port: (optional) Port to be used for iLO operations if you are

 using a custom port on the iLO. Default port used is 443.

- client_timeout: (optional) Timeout for iLO operations. Default timeout

 is 60 seconds.

- console_port: (optional) Node's UDP port for console access. Any unused

 port on the Ironic conductor node may be used.

pxe_ilo driver

Overview

pxe_ilo driver uses PXE/iSCSI (just like pxe_ipmitool driver) to deploy the image and uses iLO to do all management operations on the baremetal node(instead of using IPMI).

Target Users

• Users who want to use PXE/iSCSI for deployment in their environment or who

 don't have Advanced License in their iLO.

• Users who don't want to configure boot mode manually on the baremetal node.

Tested Platforms

This driver should work on HP Proliant Gen8 Servers and above with iLO 4. It has been tested with the following servers:

• ProLiant DL380e Gen8
• ProLiant DL380e Gen8
• ProLiant DL580 Gen8
• ProLiant DL180 Gen9

For more up-to-date information, check the iLO driver wiki [6]_.

Features

• Automatic detection of current boot mode.
• Automatic setting of the required boot mode if UEFI boot mode is requested

 by the nova flavor's extra spec.

Requirements

None.

Configuring and Enabling the driver

1. Prepare an ISO deploy ramdisk image from diskimage-builder [3]_.

  The below command creates a file named deploy-ramdisk.kernel and
  deploy-ramdisk.initramfs in the current working directory::

   cd <path-to-diskimage-builder>
   ./bin/ramdisk-image-create -o deploy-ramdisk ubuntu deploy-ironic

2. Upload this image to Glance.::

   glance image-create --name deploy-ramdisk.kernel --disk-format aki --container-format aki < deploy-ramdisk.kernel
   glance image-create --name deploy-ramdisk.initramfs --disk-format ari --container-format ari < deploy-ramdisk.initramfs

7. Add pxe_ilo to the list of enabled_drivers in

  /etc/ironic/ironic.conf.  For example:::

   enabled_drivers = fake,pxe_ssh,pxe_ipmitool,pxe_ilo

8. Restart the Ironic conductor service.::

   service ironic-conductor restart

Registering Proliant node in Ironic

Nodes configured for iLO driver should have the driver property set to pxe_ilo. The following configuration values are also required in driver_info:

- ilo_address: IP address or hostname of the iLO. - ilo_username: Username for the iLO with administrator privileges. - ilo_password: Password for the above iLO user. - pxe_deploy_kernel: The Glance UUID of the deployment kernel. - pxe_deploy_ramdisk: The Glance UUID of the deployment ramdisk. - client_port: (optional) Port to be used for iLO operations if you are

 using a custom port on the iLO. Default port used is 443.

- client_timeout: (optional) Timeout for iLO operations. Default timeout

 is 60 seconds.

- console_port: (optional) Node's UDP port for console access. Any unused

 port on the Ironic conductor node may be used.

Boot modes

pxe_ilo driver supports automatic detection and setting of boot mode (Legacy BIOS or UEFI).

• When no boot mode setting is provided, pxe_ilo driver preserves the

 current boot mode on the deployed instance.

• A requirement of a specific boot mode may be provided by adding

 boot_mode:bios or boot_mode:uefi to capabilities property within
 the properties field of an Ironic node. Then pxe_ilo driver will
 deploy and configure the instance in the appropriate boot mode.::

  ironic node-update <NODE-ID> add properties/capabilities='boot_mode:uefi'

• • NOTES**:

• We recommend setting the boot_mode property on systems that support both

 UEFI and legacy modes if user wants facility in Nova to choose a baremetal
 node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9
 systems.

• pxe_ilo driver automatically set boot mode from BIOS to UEFI, if the

 requested boot mode in nova boot is UEFI. However, users will need to
 pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they
 want to deploy the node in legacy mode.

• From nova, specific boot mode may be requested by using the

 ComputeCapabilitesFilter. For example, it can be set in a flavor like
 below::

  nova flavor-key ironic-test-3 set capabilities:boot_mode="uefi"
  nova boot --flavor ironic-test-3 --image test-image instance-1

References

• [1] HP iLO 4 User Guide - http://h20628.www2.hp.com/km-ext/kmcsdirect/emr_na-c03334051-11.pdf
• [2] Proliantutils module - https://pypi.python.org/pypi/proliantutils
• [3] DiskImage-Builder - https://github.com/openstack/diskimage-builder
• [4] http://docs.openstack.org/developer/glance/configuring.html#configuring-the-swift-storage-backend
• [5] Ironic Python Agent - https://github.com/openstack/ironic-python-agent
• [6] https://wiki.openstack.org/wiki/Ironic/Drivers/iLODrivers

=

iscsi_ilo driver ^^^^^^^^^^^^^^^^

Overview 16:25, 20 October 2014 (UTC)rameshg87 (talk) iscsi_ilo driver was introduced as an alternative to pxe_ipmitool and pxe_ipminative drivers for HP Proliant servers. iscsi_ilo uses virtual media feature in iLO to boot up the baremetal node instead of using PXE or iPXE.

Target Users 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)~~

• Users who do not want to use PXE/TFTP protocol on their data centres.
• Current PXE driver passes authentication token in clear-text over

 tftp to the baremetal node. iscsi_ilo driver enhances the security
 by passing keystone authtoken and management info over encrypted
 management network. This driver may be used by users who have concerns
 on PXE drivers security issues and want to have a security enhanced
 PXE-less deployment mechanism.

Tested Platforms 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)~ This driver should work on HP Proliant Gen8 Servers and above with iLO 4. It has been tested with the following servers:

• ProLiant DL380e Gen8
• ProLiant DL380e Gen8
• ProLiant DL580 Gen8
• ProLiant DL180 Gen9

For more up-to-date information, check the iLO driver wiki [6]_.

Features 16:25, 20 October 2014 (UTC)rameshg87 (talk)

• PXE-less deploy with Virtual Media.
• Automatic detection of current boot mode.
• Automatic setting of the required boot mode if UEFI boot mode is requested

 by the nova flavor's extra spec.

• Always boot from network using Virtual Media.
• UEFI Boot Support
• Passing authentication token via secure, encrypted management network

 (Virtual Media). Provisioning is done using iSCSI over data network
 (like PXE driver), so this driver has the  benefit of security
 enhancement with the same performance. Hence it segregates management info
 from data channel.

• Remote Console
• HW Sensors
• Works well for machines with resource constraints (lesser amount of memory).

Requirements 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)~~

• **iLO 4 Advanced License** needs to be installed on iLO to enable Virtual

 Media feature.

• **Swift Object Storage Service** - iLO driver uses Swift to store temporary

 FAT images as well as boot ISO images.

• **Glance Image Service with Swift configured as its backend** - When using

 iscsi_ilo driver, the image containing the deploy ramdisk is retrieved
 from Swift directly by the iLO.

Deploy Process 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)rameshg87 (talk) 16:25, 20 October 2014 (UTC)

• Admin configures the Proliant baremetal node for iscsi_ilo driver. The

 Ironic node configured will have the ilo_deploy_iso property in its
 driver_info.  This will contain the Glance UUID of the ISO
 deploy ramdisk image.

• Ironic gets a request to deploy a Glance image on the baremetal node.
• iscsi_ilo driver powers off the baremetal node.
• The driver generates a swift-temp-url for the deploy ramdisk image

 and attaches it as Virtual Media CDROM on the iLO.

• The driver creates a small FAT32 image containing parameters to

 the deploy ramdisk. This image is uploaded to Swift and its swift-temp-url
 is attached as Virtual Media Floppy on the iLO.

• The driver sets the node to boot one-time from CDROM.
• The driver powers on the baremetal node.
• The deploy kernel/ramdisk is booted on the baremetal node. The ramdisk

 exposes the local disk over iSCSI and requests Ironic conductor to complete
 the deployment.

• The driver on the Ironic conductor writes the glance image to the

 baremetal node's disk.

• The driver bundles the boot kernel/ramdisk for the Glance deploy

 image into an ISO and then uploads it to Swift. This ISO image will be used
 for booting the deployed instance.

• The driver reboots the node.
• On the first and subsequent reboots iscsi_ilo driver attaches this boot

 ISO image in Swift as Virtual Media CDROM and then sets iLO to boot from it.

Configuring and Enabling the driver 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC) 1. Prepare an ISO deploy ramdisk image from diskimage-builder [3]_. This

  can be done by adding the iso element to the ramdisk-image-create
  command.  This command creates the deploy kernel/ramdisk as well as a
  bootable ISO image containing the deploy kernel and ramdisk.

  The below command creates files named deploy-ramdisk.kernel,
  deploy-ramdisk.initramfs and deploy-ramdisk.iso in the current
  working directory.::

   cd <path-to-diskimage-builder>
   ./bin/ramdisk-image-create -o deploy-ramdisk ubuntu deploy-ironic iso

2. Upload this image to Glance.::

   glance image-create --name deploy-ramdisk.iso --disk-format iso --container-format bare < deploy-ramdisk.iso

3. Configure Glance image service with its storage backend as Swift. See

  [4]_ for configuration instructions.

4. Set a temp-url key for Glance user in Swift. For example, if you have

  configured Glance with user glance-swift and tenant as service,
  then run the below command::

   swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance

5. Fill the required parameters in the [glance] section in

  /etc/ironic/ironic.conf. Normally you would be required to fill in the
  following details.::

   [glance]
   swift_temp_url_key=mysecretkeyforglance
   swift_endpoint_url=http://10.10.1.10:8080
   swift_api_version=v1
   swift_account=AUTH_51ea2fb400c34c9eb005ca945c0dc9e1
   swift_container=glance

 The details can be retrieved by running the below command:::

  $ swift --os-username=service:glance-swift stat -v | grep -i url
  StorageURL:     http://10.10.1.10:8080/v1/AUTH_51ea2fb400c34c9eb005ca945c0dc9e1
  Meta Temp-Url-Key: mysecretkeyforglance

6. Swift must be accessible with the same admin credentials configured in

  Ironic. For example, if Ironic is configured with the below credentials in
  /etc/ironic/ironic.conf.::

   [keystone_authtoken]
   admin_password = password
   admin_user = ironic
   admin_tenant_name = service

  Ensure auth_version in keystone_authtoken to 2.

  Then, the below command should work.::

   $ swift --os-username ironic --os-password password --os-tenant-name service --auth-version 2 stat
                        Account: AUTH_22af34365a104e4689c46400297f00cb
                     Containers: 2
                        Objects: 18
                          Bytes: 1728346241
   Objects in policy "policy-0": 18
     Bytes in policy "policy-0": 1728346241
              Meta Temp-Url-Key: mysecretkeyforglance
                    X-Timestamp: 1409763763.84427
                     X-Trans-Id: tx51de96a28f27401eb2833-005433924b
                   Content-Type: text/plain; charset=utf-8
                  Accept-Ranges: bytes

7. Add iscsi_ilo to the list of enabled_drivers in

  /etc/ironic/ironic.conf.  For example:::

   enabled_drivers = fake,pxe_ssh,pxe_ipmitool,iscsi_ilo

8. Restart the Ironic conductor service.::

   $ service ironic-conductor restart

Registering Proliant node in Ironic 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC) Nodes configured for iLO driver should have the driver property set to iscsi_ilo. The following configuration values are also required in driver_info:

- ilo_address: IP address or hostname of the iLO. - ilo_username: Username for the iLO with administrator privileges. - ilo_password: Password for the above iLO user. - ilo_deploy_iso: The Glance UUID of the deploy ramdisk ISO image. - client_port: (optional) Port to be used for iLO operations if you are

 using a custom port on the iLO.  Default port used is 443.

- client_timeout: (optional) Timeout for iLO operations. Default timeout

 is 60 seconds.

- console_port: (optional) Node's UDP port for console access. Any unused

 port on the Ironic conductor node may be used.

Boot modes 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC) iscsi_ilo driver supports automatic detection and setting of boot mode (Legacy BIOS or UEFI).

• When no boot mode setting is provided, iscsi_ilo driver preserves the

 current boot mode on the deployed instance.

• A requirement of a specific boot mode may be provided by adding

 boot_mode:bios or boot_mode:uefi to capabilities property within
 the properties field of an Ironic node. Then iscsi_ilo driver will
 deploy and configure the instance in the appropriate boot mode.

For example, to make a Proliant baremetal node boot in UEFI mode, run the following command::

  ironic node-update <node-id> add properties/capabilities='boot_mode:uefi'

• • NOTES**:

• We recommend setting the boot_mode property on systems that support both

 UEFI and legacy modes if user wants facility in Nova to choose a baremetal
 node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9
 systems.

• iscsi_ilo driver automatically set boot mode from BIOS to UEFI, if the

 requested boot mode in nova boot is UEFI. However, users will need to
 pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they
 want to deploy the node in legacy mode.

• Currently for UEFI boot mode, automatic creation of boot ISO doesn't

 work. The boot ISO for the deploy image needs to be built separately and the
 deploy image's boot_iso property in Glance should contain the Glance UUID
 of the boot ISO. For instructions on building boot ISO, refer iLO driver wiki
 [6]_.

• From nova, specific boot mode may be requested by using the

 ComputeCapabilitesFilter. For example, it can be set in a flavor like
 below::

  nova flavor-key ironic-test-3 set capabilities:boot_mode="uefi"
  nova boot --flavor ironic-test-3 --image test-image instance-1

agent_ilo driver ^^^^^^^^^^^^^^^^

Overview 16:25, 20 October 2014 (UTC)rameshg87 (talk) agent_ilo driver was introduced as an alternative to agent_ipmitool and agent_ipminative drivers for HP Proliant servers. agent_ilo driver uses virtual media feature in HP Proliant baremetal servers to boot up the Ironic Python Agent (IPA) on the baremetal node instead of using PXE. For more information on IPA, refer https://wiki.openstack.org/wiki/Ironic-python-agent.

Target Users 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)~~

• Users who do not want to use PXE/TFTP protocol on their data centres.

Tested Platforms 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)~ This driver should work on HP Proliant Gen8 Servers and above with iLO 4. It has been tested with the following servers:

• ProLiant DL380e Gen8
• ProLiant DL380e Gen8
• ProLiant DL580 Gen8 legacy mode
• ProLiant DL180 Gen9

For more up-to-date information, check the iLO driver wiki [6]_.

Features 16:25, 20 October 2014 (UTC)rameshg87 (talk)

• PXE-less deploy with Virtual Media using Ironic Python Agent.
• Remote Console
• HW Sensors
• IPA runs on the baremetal node and pulls the image directly from Swift.
• IPA deployed instances always boots from local disk.
• Segregates management info from data channel.

Requirements 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)~~

• **iLO 4 Advanced License** needs to be installed on iLO to enable Virtual

 Media feature.

• **Swift Object Storage Service** - iLO driver uses Swift to store temporary

 FAT images as well as boot ISO images.

• **Glance Image Service with Swift configured as its backend** - When using

 agent_ilo driver, the image containing the agent is retrieved from
 Swift directly by the iLO.

Deploy Process 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)rameshg87 (talk) 16:25, 20 October 2014 (UTC)

• Admin configures the Proliant baremetal node for agent_ilo driver. The

 Ironic node configured will have the ilo_deploy_iso property in its
 driver_info.  This will contain the Glance UUID of the ISO deploy agent
 image containing the agent.

• Ironic gets a request to deploy a Glance image on the baremetal node.
• Driver powers off the baremetal node.
• Driver generates a swift-temp-url for the deploy agent image

 and attaches it as Virtual Media CDROM on the iLO.

• Driver creates a small FAT32 image containing parameters to

 the agent ramdisk. This image is uploaded to Swift and its swift-temp-url
 is attached as Virtual Media Floppy on the iLO.

• Driver sets the node to boot one-time from CDROM.
• Driver powers on the baremetal node.
• The deploy kernel/ramdisk containing the agent is booted on the baremetal

 node.  The agent ramdisk talks to the Ironic conductor, downloads the image
 directly from Swift and writes the node's disk.

• Driver sets the node to permanently boot from disk and then reboots

 the node.

Configuring and Enabling the driver 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC) 1. Prepare an ISO deploy Ironic Python Agent image containing the agent [5]_.

  This can be done by using the iso-image-create script found within
  the agent. The below set of commands will create a file ipa-ramdisk.iso
  in the below directory UPLOAD::

   $ cd <directory-containing-ironic-python-agent>
   $ cd ./imagebuild/coreos
   $ make iso
   $ cd UPLOAD
   $ ls
   $ coreos_production_pxe_image-oem.cpio.gz  coreos_production_pxe.vmlinuz  ipa-coreos.iso

2. Upload the IPA ramdisk image to Glance.::

   glance image-create --name ipa-ramdisk.iso --disk-format iso --container-format bare < ipa-coreos.iso

3. Configure Glance image service with its storage backend as Swift. See

  [4]_ for configuration instructions.

4. Set a temp-url key for Glance user in Swift. For example, if you have

  configured Glance with user glance-swift and tenant as service,
  then run the below command::

   swift --os-username=service:glance-swift post -m temp-url-key:mysecretkeyforglance

5. Fill the required parameters in the [glance] section in

  /etc/ironic/ironic.conf. Normally you would be required to fill in the
  following details.::

   [glance]
   swift_temp_url_key=mysecretkeyforglance
   swift_endpoint_url=http://10.10.1.10:8080
   swift_api_version=v1
   swift_account=AUTH_51ea2fb400c34c9eb005ca945c0dc9e1
   swift_container=glance

 The details can be retrieved by running the below command:::

  $ swift --os-username=service:glance-swift stat -v | grep -i url
  StorageURL:     http://10.10.1.10:8080/v1/AUTH_51ea2fb400c34c9eb005ca945c0dc9e1
  Meta Temp-Url-Key: mysecretkeyforglance

6. Swift must be accessible with the same admin credentials configured in

  Ironic. For example, if Ironic is configured with the below credentials in
  /etc/ironic/ironic.conf.::

   [keystone_authtoken]
   admin_password = password
   admin_user = ironic
   admin_tenant_name = service

  Ensure auth_version in keystone_authtoken to 2.

  Then, the below command should work.::

   $ swift --os-username ironic --os-password password --os-tenant-name service --auth-version 2 stat
                        Account: AUTH_22af34365a104e4689c46400297f00cb
                     Containers: 2
                        Objects: 18
                          Bytes: 1728346241
   Objects in policy "policy-0": 18
     Bytes in policy "policy-0": 1728346241
              Meta Temp-Url-Key: mysecretkeyforglance
                    X-Timestamp: 1409763763.84427
                     X-Trans-Id: tx51de96a28f27401eb2833-005433924b
                   Content-Type: text/plain; charset=utf-8
                  Accept-Ranges: bytes

7. Add agent_ilo to the list of enabled_drivers in

  /etc/ironic/ironic.conf.  For example:::

   enabled_drivers = fake,pxe_ssh,pxe_ipmitool,agent_ilo

8. Restart the Ironic conductor service.::

   $ service ironic-conductor restart

Registering Proliant node in Ironic 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC) Nodes configured for iLO driver should have the driver property set to agent_ilo. The following configuration values are also required in driver_info:

- ilo_address: IP address or hostname of the iLO. - ilo_username: Username for the iLO with administrator privileges. - ilo_password: Password for the above iLO user. - ilo_deploy_iso: The Glance UUID of the deploy agent ISO image containing

  the agent.

- client_port: (optional) Port to be used for iLO operations if you are

 using a custom port on the iLO. Default port used is 443.

- client_timeout: (optional) Timeout for iLO operations. Default timeout

 is 60 seconds.

- console_port: (optional) Node's UDP port for console access. Any unused

 port on the Ironic conductor node may be used.

pxe_ilo driver ^^^^^^^^^^^^^^

Overview 16:25, 20 October 2014 (UTC)rameshg87 (talk) pxe_ilo driver uses PXE/iSCSI (just like pxe_ipmitool driver) to deploy the image and uses iLO to do all management operations on the baremetal node(instead of using IPMI).

Target Users 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)~~

• Users who want to use PXE/iSCSI for deployment in their environment or who

 don't have Advanced License in their iLO.

• Users who don't want to configure boot mode manually on the baremetal node.

Tested Platforms 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)~ This driver should work on HP Proliant Gen8 Servers and above with iLO 4. It has been tested with the following servers:

• ProLiant DL380e Gen8
• ProLiant DL380e Gen8
• ProLiant DL580 Gen8
• ProLiant DL180 Gen9

For more up-to-date information, check the iLO driver wiki [6]_.

Features 16:25, 20 October 2014 (UTC)rameshg87 (talk)

• Automatic detection of current boot mode.
• Automatic setting of the required boot mode if UEFI boot mode is requested

 by the nova flavor's extra spec.

Requirements 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)~~ None.

Configuring and Enabling the driver 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC) 1. Prepare an ISO deploy ramdisk image from diskimage-builder [3]_.

  The below command creates a file named deploy-ramdisk.kernel and
  deploy-ramdisk.initramfs in the current working directory::

   cd <path-to-diskimage-builder>
   ./bin/ramdisk-image-create -o deploy-ramdisk ubuntu deploy-ironic

2. Upload this image to Glance.::

   glance image-create --name deploy-ramdisk.kernel --disk-format aki --container-format aki < deploy-ramdisk.kernel
   glance image-create --name deploy-ramdisk.initramfs --disk-format ari --container-format ari < deploy-ramdisk.initramfs

7. Add pxe_ilo to the list of enabled_drivers in

  /etc/ironic/ironic.conf.  For example:::

   enabled_drivers = fake,pxe_ssh,pxe_ipmitool,pxe_ilo

8. Restart the Ironic conductor service.::

   service ironic-conductor restart

Registering Proliant node in Ironic 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC) Nodes configured for iLO driver should have the driver property set to pxe_ilo. The following configuration values are also required in driver_info:

- ilo_address: IP address or hostname of the iLO. - ilo_username: Username for the iLO with administrator privileges. - ilo_password: Password for the above iLO user. - pxe_deploy_kernel: The Glance UUID of the deployment kernel. - pxe_deploy_ramdisk: The Glance UUID of the deployment ramdisk. - client_port: (optional) Port to be used for iLO operations if you are

 using a custom port on the iLO. Default port used is 443.

- client_timeout: (optional) Timeout for iLO operations. Default timeout

 is 60 seconds.

- console_port: (optional) Node's UDP port for console access. Any unused

 port on the Ironic conductor node may be used.

Boot modes 16:25, 20 October 2014 (UTC)16:25, 20 October 2014 (UTC) pxe_ilo driver supports automatic detection and setting of boot mode (Legacy BIOS or UEFI).

• When no boot mode setting is provided, pxe_ilo driver preserves the

 current boot mode on the deployed instance.

• A requirement of a specific boot mode may be provided by adding

 boot_mode:bios or boot_mode:uefi to capabilities property within
 the properties field of an Ironic node. Then pxe_ilo driver will
 deploy and configure the instance in the appropriate boot mode.::

  ironic node-update <NODE-ID> add properties/capabilities='boot_mode:uefi'

• • NOTES**:

• We recommend setting the boot_mode property on systems that support both

 UEFI and legacy modes if user wants facility in Nova to choose a baremetal
 node with appropriate boot mode. This is for ProLiant DL580 Gen8 and Gen9
 systems.

• pxe_ilo driver automatically set boot mode from BIOS to UEFI, if the

 requested boot mode in nova boot is UEFI. However, users will need to
 pre-configure boot mode to Legacy on DL580 Gen8 and Gen9 servers if they
 want to deploy the node in legacy mode.

• From nova, specific boot mode may be requested by using the

 ComputeCapabilitesFilter. For example, it can be set in a flavor like
 below::

  nova flavor-key ironic-test-3 set capabilities:boot_mode="uefi"
  nova boot --flavor ironic-test-3 --image test-image instance-1

References

==

• [1] HP iLO 4 User Guide - http://h20628.www2.hp.com/km-ext/kmcsdirect/emr_na-c03334051-11.pdf
• [2] Proliantutils module - https://pypi.python.org/pypi/proliantutils
• [3] DiskImage-Builder - https://github.com/openstack/diskimage-builder
• [4] http://docs.openstack.org/developer/glance/configuring.html#configuring-the-swift-storage-backend
• [5] Ironic Python Agent - https://github.com/openstack/ironic-python-agent
• [6] https://wiki.openstack.org/wiki/Ironic/Drivers/iLODrivers