add configuration for unlimited cgroups (#1337)

Azure · Sep 6, 2018 · 527e863 · 527e863
1 parent 4f55648
commit 527e863
Show file tree

Hide file tree

Showing 13 changed files with 77 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -206,6 +206,7 @@ OS.SshDir=/etc/ssh
 HttpProxy.Host=None
 HttpProxy.Port=None
 CGroups.EnforceLimits=y
+CGroups.Excluded=customscript,runcommand
 ```
 
 The various configuration options are described in detail below. Configuration
@@ -461,6 +462,13 @@ _Default: y_
 If set, the agent will attempt to set cgroups limits for cpu and memory for the agent process itself
 as well as extension processes. See the wiki for further details on this.
 
+#### __CGroups.Excluded__
+
+_Type: String_  
+_Default: customscript,runcommand_
+
+The list of extensions which will be excluded from cgroups limits. This should be comma separated. 
+
 ### Telemetry
 
 WALinuxAgent collects usage data and sends it to Microsoft to help improve our products and services. The data collected is used to track service health and
@@ -489,7 +497,7 @@ Run once:
 2. Create the pbuilder environment
 
    ```bash
-   sudo pbuilder create --debootstrapopts --variant=buildd`
+   sudo pbuilder create --debootstrapopts --variant=buildd
    ```
 
 3. Obtain `waagent.dsc` from a downstream package repo
@@ -505,7 +513,7 @@ To compile the package, from the top-most directory:
 2. Build the package
 
    ```bash
-   sudo pbuilder build {waagent.dsc}
+   sudo pbuilder build waagent.dsc
    ```
 
 3. Fetch the built package, usually from `/var/cache/pbuilder/result`

diff --git a/azurelinuxagent/common/cgroups.py b/azurelinuxagent/common/cgroups.py
@@ -17,7 +17,6 @@
 import errno
 import os
 import re
-import traceback
 
 import time
 
@@ -32,7 +31,6 @@
 WRAPPER_CGROUP_NAME = "Agent+Extensions"
 METRIC_HIERARCHIES = ['cpu', 'memory']
 MEMORY_DEFAULT = -1
-UNLIMITED_INSTANCES = ['customscript', 'runcommand']
 
 # percentage of a single core
 DEFAULT_CPU_LIMIT_AGENT = 10
@@ -489,7 +487,7 @@ def set_limits(self):
         if self.name is None:
             return
 
-        for ext in UNLIMITED_INSTANCES:
+        for ext in conf.get_cgroups_excluded():
             if ext in self.name.lower():
                 logger.info('No cgroups limits for {0}'.format(self.name))
                 return

diff --git a/azurelinuxagent/common/conf.py b/azurelinuxagent/common/conf.py
@@ -131,7 +131,8 @@ def load_conf_from_file(conf_file_path, conf=__conf__):
     "ResourceDisk.MountPoint": "/mnt/resource",
     "ResourceDisk.MountOptions": None,
     "ResourceDisk.Filesystem": "ext3",
-    "AutoUpdate.GAFamily": "Prod"
+    "AutoUpdate.GAFamily": "Prod",
+    "CGroups.Excluded": "customscript,runcommand",
 }
 
 
@@ -367,3 +368,8 @@ def get_disable_agent_file_path(conf=__conf__):
 
 def get_cgroups_enforce_limits(conf=__conf__):
     return conf.get_switch("CGroups.EnforceLimits", True)
+
+
+def get_cgroups_excluded(conf=__conf__):
+    excluded_value = conf.get("CGroups.Excluded", "customscript, runcommand")
+    return [s for s in [i.strip().lower() for i in excluded_value.split(',')] if len(s) > 0] if excluded_value else []
diff --git a/config/alpine/waagent.conf b/config/alpine/waagent.conf
@@ -96,3 +96,6 @@ OS.EnableFirewall=y
 
 # Enforce control groups limits on the agent and extensions
 CGroups.EnforceLimits=y
+
+# CGroups which are excluded from limits, comma separated
+CGroups.Excluded=customscript,runcommand
diff --git a/config/bigip/waagent.conf b/config/bigip/waagent.conf
@@ -100,3 +100,6 @@ OS.EnableFirewall=y
 
 # Enforce control groups limits on the agent and extensions
 CGroups.EnforceLimits=y
+
+# CGroups which are excluded from limits, comma separated
+CGroups.Excluded=customscript,runcommand
diff --git a/config/coreos/waagent.conf b/config/coreos/waagent.conf
@@ -122,3 +122,6 @@ OS.EnableFirewall=y
 
 # Enforce control groups limits on the agent and extensions
 CGroups.EnforceLimits=y
+
+# CGroups which are excluded from limits, comma separated
+CGroups.Excluded=customscript,runcommand
diff --git a/config/debian/waagent.conf b/config/debian/waagent.conf
@@ -124,3 +124,6 @@ OS.EnableFirewall=n
 
 # Enforce control groups limits on the agent and extensions
 CGroups.EnforceLimits=y
+
+# CGroups which are excluded from limits, comma separated
+CGroups.Excluded=customscript,runcommand
diff --git a/config/freebsd/waagent.conf b/config/freebsd/waagent.conf
@@ -120,3 +120,6 @@ OS.EnableFirewall=y
 
 # Enforce control groups limits on the agent and extensions
 CGroups.EnforceLimits=n
+
+# CGroups which are excluded from limits, comma separated
+CGroups.Excluded=customscript,runcommand
diff --git a/config/ubuntu/waagent.conf b/config/ubuntu/waagent.conf
@@ -110,3 +110,6 @@ OS.EnableFirewall=y
 
 # Enforce control groups limits on the agent and extensions
 CGroups.EnforceLimits=y
+
+# CGroups which are excluded from limits, comma separated
+CGroups.Excluded=customscript,runcommand
diff --git a/config/waagent.conf b/config/waagent.conf
@@ -122,3 +122,6 @@ OS.EnableFirewall=y
 
 # Enforce control groups limits on the agent and extensions
 CGroups.EnforceLimits=y
+
+# CGroups which are excluded from limits, comma separated
+CGroups.Excluded=customscript,runcommand
diff --git a/tests/common/test_conf.py b/tests/common/test_conf.py
@@ -68,6 +68,7 @@ class TestConf(AgentTestCase):
         "OS.AllowHTTP": False,
         "OS.EnableFirewall": False,
         "CGroups.EnforceLimits": True,
+        "CGroups.Excluded": "customscript,runcommand",
     }
 
     def setUp(self):
@@ -135,3 +136,36 @@ def test_write_agent_disabled(self):
     def test_get_extensions_enabled(self):
         self.assertTrue(get_extensions_enabled(self.conf))
 
+    @patch('azurelinuxagent.common.conf.ConfigurationProvider.get')
+    def assert_get_cgroups_excluded(self, patch_get, config, expected_value):
+        patch_get.return_value = config
+        self.assertEqual(expected_value, conf.get_cgroups_excluded(self.conf))
+
+    def test_get_cgroups_excluded(self):
+        self.assert_get_cgroups_excluded(config=None,
+                                         expected_value=[])
+
+        self.assert_get_cgroups_excluded(config='',
+                                         expected_value=[])
+
+        self.assert_get_cgroups_excluded(config='  ',
+                                         expected_value=[])
+
+        self.assert_get_cgroups_excluded(config='  ,  ,,  ,',
+                                         expected_value=[])
+
+        standard_values = ['customscript', 'runcommand']
+        self.assert_get_cgroups_excluded(config='CustomScript, RunCommand',
+                                         expected_value=standard_values)
+
+        self.assert_get_cgroups_excluded(config='customScript, runCommand  , , ,,',
+                                         expected_value=standard_values)
+
+        self.assert_get_cgroups_excluded(config='  customscript,runcommand  ',
+                                         expected_value=standard_values)
+
+        self.assert_get_cgroups_excluded(config='customscript,, runcommand',
+                                         expected_value=standard_values)
+
+        self.assert_get_cgroups_excluded(config=',,customscript ,runcommand',
+                                         expected_value=standard_values)
diff --git a/tests/data/test_waagent.conf b/tests/data/test_waagent.conf
@@ -132,3 +132,6 @@ OS.EnableFirewall=n
 
 # Enforce control groups limits on the agent and extensions
 CGroups.EnforceLimits=y
+
+# CGroups which are excluded from limits, comma separated
+CGroups.Excluded=customscript,runcommand
diff --git a/tests/test_agent.py b/tests/test_agent.py
@@ -27,6 +27,7 @@
 AutoUpdate.GAFamily = Prod
 Autoupdate.Frequency = 3600
 CGroups.EnforceLimits = True
+CGroups.Excluded = customscript,runcommand
 DVD.MountPoint = /mnt/cdrom/secure
 DetectScvmmEnv = False
 EnableOverProvisioning = True