diff --git a/doc/source/deploy/install-guide.rst b/doc/source/deploy/install-guide.rst index 8a9a97dc54..0e955069df 100644 --- a/doc/source/deploy/install-guide.rst +++ b/doc/source/deploy/install-guide.rst @@ -613,56 +613,10 @@ directly to the node's ``instance_info`` field, as below:: Local boot with partition images ================================ -Starting with the Kilo release, Bare Metal service supports local boot with -partition images, meaning that after the deployment the node's subsequent -reboots won't happen via PXE or Virtual Media. Instead, it will boot from a -local boot loader installed on the disk. +The `Local boot with partition images`_ section has been moved to the Bare +Metal service Install Guide. -It's important to note that in order for this to work the image being -deployed with Bare Metal service **must** contain ``grub2`` installed within it. - -Enabling the local boot is different when Bare Metal service is used with -Compute service and without it. -The following sections will describe both methods. - -.. note:: - The local boot feature is dependent upon a updated deploy ramdisk built - with diskimage-builder_ **version >= 0.1.42** or ironic-python-agent_ - in the kilo-era. - - -Enabling local boot with Compute service ----------------------------------------- - -To enable local boot we need to set a capability on the bare metal node, -for example:: - - ironic node-update add properties/capabilities="boot_option:local" - - -Nodes having ``boot_option`` set to ``local`` may be requested by adding -an ``extra_spec`` to the Compute service flavor, for example:: - - nova flavor-key baremetal set capabilities:boot_option="local" - - -.. note:: - If the node is configured to use ``UEFI``, Bare Metal service will create - an ``EFI partition`` on the disk and switch the partition table format to - ``gpt``. The ``EFI partition`` will be used later by the boot loader - (which is installed from the deploy ramdisk). - - -Enabling local boot without Compute ------------------------------------ - -Since adding ``capabilities`` to the node's properties is only used by -the nova scheduler to perform more advanced scheduling of instances, -we need a way to enable local boot when Compute is not present. To do that -we can simply specify the capability via the ``instance_info`` attribute -of the node, for example:: - - ironic node-update add instance_info/capabilities='{"boot_option": "local"}' +.. _`Local boot with partition images`: http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#local-boot-with-partition-images Enrollment @@ -1364,6 +1318,8 @@ Other references * `Enabling local boot without Compute`_ +.. _`Enabling local boot without Compute`: http://docs.openstack.org/project-install-guide/baremetal/draft/local-boot-partition-images.html#enabling-local-boot-without-compute + Enabling the configuration drive (configdrive) ============================================== diff --git a/install-guide/source/advanced.rst b/install-guide/source/advanced.rst new file mode 100644 index 0000000000..68b3291998 --- /dev/null +++ b/install-guide/source/advanced.rst @@ -0,0 +1,6 @@ +.. _advanced: + +Advanced features +~~~~~~~~~~~~~~~~~ + +.. include:: include/local-boot-partition-images.rst diff --git a/install-guide/source/include/local-boot-partition-images.rst b/install-guide/source/include/local-boot-partition-images.rst new file mode 100644 index 0000000000..e12ac85dc8 --- /dev/null +++ b/install-guide/source/include/local-boot-partition-images.rst @@ -0,0 +1,58 @@ +.. _local-boot-partition-images: + +Local boot with partition images +-------------------------------- + +Starting with the Kilo release, Bare Metal service supports local boot with +partition images, meaning that after the deployment the node's subsequent +reboots won't happen via PXE or Virtual Media. Instead, it will boot from a +local boot loader installed on the disk. + +It's important to note that in order for this to work the image being +deployed with Bare Metal service **must** contain ``grub2`` installed within it. + +Enabling the local boot is different when Bare Metal service is used with +Compute service and without it. +The following sections will describe both methods. + +.. note:: + The local boot feature is dependent upon a updated deploy ramdisk built + with diskimage-builder_ **version >= 0.1.42** or ironic-python-agent_ + in the kilo-era. + +.. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/ +.. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/ + + +Enabling local boot with Compute service +======================================== + +To enable local boot we need to set a capability on the bare metal node, +for example:: + + ironic node-update add properties/capabilities="boot_option:local" + + +Nodes having ``boot_option`` set to ``local`` may be requested by adding +an ``extra_spec`` to the Compute service flavor, for example:: + + nova flavor-key baremetal set capabilities:boot_option="local" + + +.. note:: + If the node is configured to use ``UEFI``, Bare Metal service will create + an ``EFI partition`` on the disk and switch the partition table format to + ``gpt``. The ``EFI partition`` will be used later by the boot loader + (which is installed from the deploy ramdisk). + + +Enabling local boot without Compute +=================================== + +Since adding ``capabilities`` to the node's properties is only used by +the nova scheduler to perform more advanced scheduling of instances, +we need a way to enable local boot when Compute is not present. To do that +we can simply specify the capability via the ``instance_info`` attribute +of the node, for example:: + + ironic node-update add instance_info/capabilities='{"boot_option": "local"}' diff --git a/install-guide/source/index.rst b/install-guide/source/index.rst index 3b01bc467c..112b089529 100644 --- a/install-guide/source/index.rst +++ b/install-guide/source/index.rst @@ -10,6 +10,7 @@ Bare Metal service configure-integration.rst configure-cleaning.rst configure-tenant-networks.rst + advanced.rst verify.rst next-steps.rst