T6219: align with system sysctl and limit parameters to supported

vyos · Jun 9, 2024 · f9fb6c9 · f9fb6c9
1 parent d8add4f
commit f9fb6c9
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 19 deletions.
diff --git a/interface-definitions/container.xml.in b/interface-definitions/container.xml.in
@@ -71,26 +71,36 @@
               <multi/>
             </properties>
           </leafNode>
-          <tagNode name="kernel-parameter">
+          <node name="sysctl">
             <properties>
-              <help>Add custom kernel parameters (sysctl)</help>
-              <constraint>
-                <regex>[._a-z*]+</regex>
-              </constraint>
-              <constraintErrorMessage>Kernel parameter name must be alphanumeric and can contain periods, asterisks and underscores</constraintErrorMessage>
+              <help>Configure namespaced kernel parameters of the container</help>
+              <priority>318</priority>
             </properties>
             <children>
-              <leafNode name="value">
+              <tagNode name="parameter">
                 <properties>
-                  <help>Set kernel parameter option value</help>
+                  <help>Sysctl key name</help>
+                  <completionHelp>
+                    <script>${vyos_completion_dir}/list_container_sysctl_parameters.sh</script>
+                  </completionHelp>
                   <valueHelp>
                     <format>txt</format>
-                    <description>Set kernel parameter option value</description>
+                    <description>Sysctl key name</description>
                   </valueHelp>
+                  <constraint>
+                    <validator name="sysctl"/>
+                  </constraint>
                 </properties>
-              </leafNode>
+                <children>
+                  <leafNode name="value">
+                    <properties>
+                      <help>Sysctl configuration value</help>
+                    </properties>
+                  </leafNode>
+                </children>
+              </tagNode>
             </children>
-          </tagNode>
+          </node>
           #include <include/generic-description.xml.i>
           <tagNode name="device">
             <properties>

diff --git a/smoketest/config-tests/container-simple b/smoketest/config-tests/container-simple
@@ -11,4 +11,4 @@ set container name c02 allow-host-networks
 set container name c02 allow-host-pid
 set container name c02 capability 'sys-time'
 set container name c02 image 'busybox:stable'
-set container name c02 kernel-parameter 'net.ipv4.conf.all.forwarding' value '1'
+set container name c02 sysctl parameter net.ipv4.conf.all.forwarding value '1'
diff --git a/smoketest/configs/container-simple b/smoketest/configs/container-simple
@@ -10,8 +10,10 @@ container {
         allow-host-pid
         cap-add sys-time
         image busybox:stable
-        kernel-parameter "net.ipv4.ip_forward" {
-            value "1"
+        sysctl {
+            parameter net.ipv4.conf.all.forwarding {
+                value "1"
+            }
         }
     }
 }

diff --git a/smoketest/scripts/cli/test_container.py b/smoketest/scripts/cli/test_container.py
@@ -80,6 +80,7 @@ def test_basic(self):
 
         self.cli_set(base_path + ['name', cont_name, 'image', cont_image])
         self.cli_set(base_path + ['name', cont_name, 'allow-host-networks'])
+        self.cli_set(base_path + ['name', cont_name, 'sysctl', 'parameter', 'net.ipv4.conf.all.forwarding', 'value', '1'])
 
         # commit changes
         self.cli_commit()

diff --git a/src/completion/list_container_sysctl_parameters.sh b/src/completion/list_container_sysctl_parameters.sh
@@ -0,0 +1,20 @@
+#!/bin/sh
+#
+# Copyright (C) 2021 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+declare -a vals
+eval "vals=($(/sbin/sysctl -N -a|grep -E '^(fs.mqueue|net)\.|^(kernel.msgmax|kernel.msgmnb|kernel.msgmni|kernel.sem|kernel.shmall|kernel.shmmax|kernel.shmmni|kernel.shm_rmid_forced)$'))"
+echo ${vals[@]}
+exit 0
diff --git a/src/conf_mode/container.py b/src/conf_mode/container.py
@@ -191,8 +191,8 @@ def verify(container):
                     if not os.path.exists(source):
                         raise ConfigError(f'Device "{dev}" source path "{source}" does not exist!')
 
-            if 'kernel-parameter' in container_config:
-                for var, cfg in container_config['kernel-parameter'].items():
+            if 'sysctl' in container_config and 'parameter' in container_config['sysctl']:
+                for var, cfg in container_config['sysctl']['parameter'].items():
                     if 'value' not in cfg:
                         raise ConfigError(f'Kernel parameter {var} has no value assigned!')
 
@@ -285,9 +285,9 @@ def generate_run_arguments(name, container_config):
 
     # Add sysctl options
     sysctl_opt = ''
-    if 'kernel-parameter' in container_config:
-        for k, v in container_config['kernel-parameter'].items():
-            sysctl_opt += f" --sysctl={k}={v['value']}"
+    if 'sysctl' in container_config and 'parameter' in container_config['sysctl']:
+        for k, v in container_config['sysctl']['parameter'].items():
+            sysctl_opt += f" --sysctl {k}={v['value']}"
 
     # Add capability options. Should be in uppercase
     capabilities = ''