From 14bbe060d19ab7c37ddc09b5ac21ac789e2d38ee Mon Sep 17 00:00:00 2001 From: Leonard Foerster Date: Fri, 23 Feb 2024 14:42:35 +0000 Subject: [PATCH] kernel.modules: Reference boot.kernel-parameters for module options Users of Bottlerocket had asked for an easy way to set module parameters through user data [0]. That way already exists through kernel-parameters. Document that settings.boot.kernel-parameters is to be used to set module options. Details on why adding extra settings under settings.kernel.modules to achieve this can be found on the issue [1] [0] https://github.com/bottlerocket-os/bottlerocket/issues/3747 [1] https://github.com/bottlerocket-os/bottlerocket/issues/3747#issuecomment-1954792175 Signed-off-by: Leonard Foerster --- data/settings/1.16.x/kernel.toml | 11 +++++++++++ data/settings/1.17.x/kernel.toml | 11 +++++++++++ data/settings/1.18.x/kernel.toml | 11 +++++++++++ data/settings/1.19.x/kernel.toml | 11 +++++++++++ 4 files changed, 44 insertions(+) diff --git a/data/settings/1.16.x/kernel.toml b/data/settings/1.16.x/kernel.toml index a1adb0fd..b44dc4e4 100644 --- a/data/settings/1.16.x/kernel.toml +++ b/data/settings/1.16.x/kernel.toml @@ -27,6 +27,12 @@ warning = "This setting only affects *loading* of kernel modules at boot time. C description = """ Allows (`true`) or disallows (`false`) the loading of kernel module ``. """ +see = [ + [ "settings", "boot", "kernel-parameters" ] +] +note = """ +Use [`settings.boot.kernel-parameters`](../boot/#kernel-parameters) to set module parameters through the kernel command line. +""" accepted_values = [ "`true`", "`false`" @@ -61,9 +67,14 @@ direct_toml = """ [[docs.ref.modules_autoload]] name_override = "modules..autoload" description = "If `true`, the kernel `` module loads automatically on boot." +see = [ + [ "settings", "boot", "kernel-parameters" ] +] note = """ You must use this setting in conjuction with [`settings.kernel.modules..allowed`](#modules_allowed) on the same module. This ensures that the OS doesn't auto-load a blocked module. + +Use [`settings.boot.kernel-parameters`](../boot/#kernel-parameters) to set module parameters through the kernel command line. """ accepted_values = [ "`true`", diff --git a/data/settings/1.17.x/kernel.toml b/data/settings/1.17.x/kernel.toml index a1adb0fd..b44dc4e4 100644 --- a/data/settings/1.17.x/kernel.toml +++ b/data/settings/1.17.x/kernel.toml @@ -27,6 +27,12 @@ warning = "This setting only affects *loading* of kernel modules at boot time. C description = """ Allows (`true`) or disallows (`false`) the loading of kernel module ``. """ +see = [ + [ "settings", "boot", "kernel-parameters" ] +] +note = """ +Use [`settings.boot.kernel-parameters`](../boot/#kernel-parameters) to set module parameters through the kernel command line. +""" accepted_values = [ "`true`", "`false`" @@ -61,9 +67,14 @@ direct_toml = """ [[docs.ref.modules_autoload]] name_override = "modules..autoload" description = "If `true`, the kernel `` module loads automatically on boot." +see = [ + [ "settings", "boot", "kernel-parameters" ] +] note = """ You must use this setting in conjuction with [`settings.kernel.modules..allowed`](#modules_allowed) on the same module. This ensures that the OS doesn't auto-load a blocked module. + +Use [`settings.boot.kernel-parameters`](../boot/#kernel-parameters) to set module parameters through the kernel command line. """ accepted_values = [ "`true`", diff --git a/data/settings/1.18.x/kernel.toml b/data/settings/1.18.x/kernel.toml index a1adb0fd..b44dc4e4 100644 --- a/data/settings/1.18.x/kernel.toml +++ b/data/settings/1.18.x/kernel.toml @@ -27,6 +27,12 @@ warning = "This setting only affects *loading* of kernel modules at boot time. C description = """ Allows (`true`) or disallows (`false`) the loading of kernel module ``. """ +see = [ + [ "settings", "boot", "kernel-parameters" ] +] +note = """ +Use [`settings.boot.kernel-parameters`](../boot/#kernel-parameters) to set module parameters through the kernel command line. +""" accepted_values = [ "`true`", "`false`" @@ -61,9 +67,14 @@ direct_toml = """ [[docs.ref.modules_autoload]] name_override = "modules..autoload" description = "If `true`, the kernel `` module loads automatically on boot." +see = [ + [ "settings", "boot", "kernel-parameters" ] +] note = """ You must use this setting in conjuction with [`settings.kernel.modules..allowed`](#modules_allowed) on the same module. This ensures that the OS doesn't auto-load a blocked module. + +Use [`settings.boot.kernel-parameters`](../boot/#kernel-parameters) to set module parameters through the kernel command line. """ accepted_values = [ "`true`", diff --git a/data/settings/1.19.x/kernel.toml b/data/settings/1.19.x/kernel.toml index a1adb0fd..b44dc4e4 100644 --- a/data/settings/1.19.x/kernel.toml +++ b/data/settings/1.19.x/kernel.toml @@ -27,6 +27,12 @@ warning = "This setting only affects *loading* of kernel modules at boot time. C description = """ Allows (`true`) or disallows (`false`) the loading of kernel module ``. """ +see = [ + [ "settings", "boot", "kernel-parameters" ] +] +note = """ +Use [`settings.boot.kernel-parameters`](../boot/#kernel-parameters) to set module parameters through the kernel command line. +""" accepted_values = [ "`true`", "`false`" @@ -61,9 +67,14 @@ direct_toml = """ [[docs.ref.modules_autoload]] name_override = "modules..autoload" description = "If `true`, the kernel `` module loads automatically on boot." +see = [ + [ "settings", "boot", "kernel-parameters" ] +] note = """ You must use this setting in conjuction with [`settings.kernel.modules..allowed`](#modules_allowed) on the same module. This ensures that the OS doesn't auto-load a blocked module. + +Use [`settings.boot.kernel-parameters`](../boot/#kernel-parameters) to set module parameters through the kernel command line. """ accepted_values = [ "`true`",