From 93670fef56ede7d3d3f90a7567698665658278f8 Mon Sep 17 00:00:00 2001
From: Julia Kreger <juliaashleykreger@gmail.com>
Date: Tue, 17 Jul 2018 15:17:27 -0700
Subject: [PATCH] Add note to pxe configuration doc
Adding a note into the PXE setup instructions
indicating the existence of the ipxe boot interface
and that the ipxe_enabled option has been deprecated.
Change-Id: I4c553b7d5da080103f1d1ccf2573586d61e7cfc4
Story: #1628069
---
doc/source/install/configure-pxe.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/doc/source/install/configure-pxe.rst b/doc/source/install/configure-pxe.rst
index 097ae92488..0a14c1eae3 100644
--- a/doc/source/install/configure-pxe.rst
+++ b/doc/source/install/configure-pxe.rst
@@ -321,6 +321,12 @@ on the Bare Metal service node(s) where ``ironic-conductor`` is running.
# (string value)
uefi_pxe_config_template=$pybasedir/drivers/modules/ipxe_config.template
+ .. note::
+ The ``[pxe]ipxe_enabled`` option has been deprecated and will be removed
+ in the T* development cycle. Users should instead consider use of the
+ ``ipxe`` boot interface. The same default use of iPXE functionality can
+ be achieved by setting the ``[DEFAULT]default_boot_interface`` option
+ to ``ipxe``.
#. It is possible to configure the Bare Metal service in such a way
that nodes will boot into the deploy image directly from Object Storage.