From 7ed91dd06613b36889597df0cd4a8792b43f1b61 Mon Sep 17 00:00:00 2001
From: Pierre Riteau <pierre@stackhpc.com>
Date: Fri, 19 Nov 2021 09:38:27 +0100
Subject: [PATCH] Document that extra kernel parameters are important for
inspection
When customising kolla_bifrost_inspector_extra_kernel_options, for
example to define which console to use, operators should note that
Kayobe defines extra kernel parameters that are important for
inspection, such as ipa-collect-lldp=1.
Change-Id: Id789dede2d1886ef5ec66ebc86968d6cf62fa2de
---
ansible/group_vars/all/bifrost | 3 +++
doc/source/configuration/reference/bifrost.rst | 4 +++-
etc/kayobe/bifrost.yml | 3 +++
3 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/ansible/group_vars/all/bifrost b/ansible/group_vars/all/bifrost
index c4c68c05..735fbb73 100644
--- a/ansible/group_vars/all/bifrost
+++ b/ansible/group_vars/all/bifrost
@@ -87,6 +87,9 @@ kolla_bifrost_inspector_processing_hooks: "{{ inspector_processing_hooks }}"
kolla_bifrost_inspector_port_addition: "{{ inspector_add_ports }}"
# List of extra kernel parameters for the inspector default PXE configuration.
+# Default is {{ inspector_extra_kernel_options }}, defined in inspector.yml.
+# When customising this variable, the default extra kernel parameters should be
+# kept to retain full node inspection capabilities.
kolla_bifrost_inspector_extra_kernel_options: "{{ inspector_extra_kernel_options }}"
# List of introspection rules for Bifrost's Ironic Inspector service.
diff --git a/doc/source/configuration/reference/bifrost.rst b/doc/source/configuration/reference/bifrost.rst
index c03dbbc4..7816cffc 100644
--- a/doc/source/configuration/reference/bifrost.rst
+++ b/doc/source/configuration/reference/bifrost.rst
@@ -227,7 +227,9 @@ The following options configure the Ironic Inspector service in the
``kolla_bifrost_inspector_extra_kernel_options``
List of extra kernel parameters for the inspector default PXE
configuration. Default is ``{{ inspector_extra_kernel_options }}``, defined
- in ``${KAYOBE_CONFIG_PATH}/inspector.yml``.
+ in ``${KAYOBE_CONFIG_PATH}/inspector.yml``. When customising this variable,
+ the default extra kernel parameters should be kept to retain full node
+ inspection capabilities.
``kolla_bifrost_inspector_rules``
List of introspection rules for Bifrost's Ironic Inspector service. Default
is ``{{ inspector_rules }}``, defined in
diff --git a/etc/kayobe/bifrost.yml b/etc/kayobe/bifrost.yml
index 0bfcec72..9cabe812 100644
--- a/etc/kayobe/bifrost.yml
+++ b/etc/kayobe/bifrost.yml
@@ -86,6 +86,9 @@
#kolla_bifrost_inspector_port_addition:
# List of extra kernel parameters for the inspector default PXE configuration.
+# Default is {{ inspector_extra_kernel_options }}, defined in inspector.yml.
+# When customising this variable, the default extra kernel parameters should be
+# kept to retain full node inspection capabilities.
#kolla_bifrost_inspector_extra_kernel_options:
# List of introspection rules for Bifrost's Ironic Inspector service.
--
GitLab