feat: support setting kernel parameters

Support setting kernel parameters via machine config. Fixes: #6206 Signed-off-by: Noel Georgi <[email protected]>
siderolabs · Sep 5, 2022 · 5e21cca · 5e21cca
1 parent bd56621
commit 5e21cca
Show file tree

Hide file tree

Showing 15 changed files with 118 additions and 8 deletions.
diff --git a/api/resource/definitions/runtime/runtime.proto b/api/resource/definitions/runtime/runtime.proto
@@ -9,6 +9,7 @@ import "resource/definitions/enums/enums.proto";
 // KernelModuleSpecSpec describes Linux kernel module to load.
 message KernelModuleSpecSpec {
   string name = 1;
+  repeated string parameters = 2;
 }
 
 // KernelParamSpecSpec describes status of the defined sysctls.

diff --git a/hack/release.toml b/hack/release.toml
@@ -15,6 +15,29 @@ preface = """\
 
 [notes]
 
+    [notes.kernel_modules]
+        title = "Kernel Modules"
+        description = """\
+Talos now supports settings kernel module parameters.
+
+Eg:
+
+```yaml
+machine:
+  kernel:
+    modules:
+      - name: "br_netfilter"
+        parameters:
+          - nf_conntrack_max=131072
+```
+"""
+
+    [notes.sbc]
+        title = "Nano Pi R4S"
+        description = """\
+Talos now supports the Nano Pi R4S SBC.
+"""
+
     [notes.updates]
         title = "Component Updates"
         description="""\

diff --git a/internal/app/machined/pkg/controllers/runtime/kernel_module_config.go b/internal/app/machined/pkg/controllers/runtime/kernel_module_config.go
@@ -74,6 +74,7 @@ func (ctrl *KernelModuleConfigController) Run(ctx context.Context, r controller.
 
 					if err = r.Modify(ctx, item, func(res resource.Resource) error {
 						res.(*runtime.KernelModuleSpec).TypedSpec().Name = module.Name()
+						res.(*runtime.KernelModuleSpec).TypedSpec().Parameters = module.Parameters()
 
 						return nil
 					}); err != nil {

diff --git a/internal/app/machined/pkg/controllers/runtime/kernel_module_spec.go b/internal/app/machined/pkg/controllers/runtime/kernel_module_spec.go
@@ -7,6 +7,7 @@ package runtime
 import (
 	"context"
 	"fmt"
+	"strings"
 
 	"github.com/cosi-project/runtime/pkg/controller"
 	"github.com/cosi-project/runtime/pkg/resource"
@@ -68,8 +69,9 @@ func (ctrl *KernelModuleSpecController) Run(ctx context.Context, r controller.Ru
 			// note: this code doesn't support module unloading in any way for now
 			for _, res := range modules.Items {
 				module := res.(*runtime.KernelModuleSpec).TypedSpec()
+				parameters := strings.Join(module.Parameters, " ")
 
-				if err = manager.Load(module.Name, "", 0); err != nil {
+				if err = manager.Load(module.Name, parameters, 0); err != nil {
 					return fmt.Errorf("error loading module %q: %w", module.Name, err)
 				}
 			}

diff --git a/pkg/machinery/api/resource/definitions/runtime/runtime.pb.go b/pkg/machinery/api/resource/definitions/runtime/runtime.pb.go
diff --git a/pkg/machinery/api/resource/definitions/runtime/runtime_vtproto.pb.go b/pkg/machinery/api/resource/definitions/runtime/runtime_vtproto.pb.go
diff --git a/pkg/machinery/config/provider.go b/pkg/machinery/config/provider.go
@@ -599,4 +599,5 @@ type Kernel interface {
 // KernelModule describes Linux module to load.
 type KernelModule interface {
 	Name() string
+	Parameters() []string
 }
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_kernel.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_kernel.go
@@ -18,3 +18,8 @@ func (kc *KernelConfig) Modules() []config.KernelModule {
 func (kmc *KernelModuleConfig) Name() string {
 	return kmc.ModuleName
 }
+
+// Parameters implements config.KernelModule interface.
+func (kmc *KernelModuleConfig) Parameters() []string {
+	return kmc.ModuleParameters
+}
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
@@ -2549,4 +2549,7 @@ type KernelModuleConfig struct {
 	// description: |
 	//   Module name.
 	ModuleName string `yaml:"name"`
+	// description: |
+	//   Module parameters, changes applied after reboot.
+	ModuleParameters []string `yaml:"parameters,omitempty"`
 }
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
diff --git a/pkg/machinery/config/types/v1alpha1/zz_generated.deepcopy.go b/pkg/machinery/config/types/v1alpha1/zz_generated.deepcopy.go
diff --git a/pkg/machinery/resources/runtime/deep_copy.generated.go b/pkg/machinery/resources/runtime/deep_copy.generated.go
diff --git a/pkg/machinery/resources/runtime/kernel_module_spec.go b/pkg/machinery/resources/runtime/kernel_module_spec.go
@@ -23,8 +23,9 @@ type KernelModuleSpec = typed.Resource[KernelModuleSpecSpec, KernelModuleSpecRD]
 //
 //gotagsrewrite:gen
 type KernelModuleSpecSpec struct {
-	Name string `yaml:"string" protobuf:"1"`
-	// more options in the future: args, aliases, etc.
+	Name       string   `yaml:"string" protobuf:"1"`
+	Parameters []string `yaml:"parameters" protobuf:"2"`
+	// more options in the future: aliases, etc.
 }
 
 // NewKernelModuleSpec initializes a KernelModuleSpec resource.

diff --git a/website/content/v1.3/reference/api.md b/website/content/v1.3/reference/api.md
@@ -3002,6 +3002,7 @@ KernelModuleSpecSpec describes Linux kernel module to load.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | name | [string](#string) |  |  |
+| parameters | [string](#string) | repeated |  |
 
 
 

diff --git a/website/content/v1.3/reference/configuration.md b/website/content/v1.3/reference/configuration.md
@@ -2920,5 +2920,6 @@ Appears in:
 | Field | Type | Description | Value(s) |
 |-------|------|-------------|----------|
 |`name` |string |Module name.  | |
+|`parameters` |[]string |Module parameters, changes applied after reboot.  | |