Github user abhishekagarwal87 commented on a diff in the pull request:
https://github.com/apache/storm/pull/1054#discussion_r52448581
--- Diff: documentation/cgroups_in_storm.md ---
@@ -0,0 +1,65 @@
+# CGroups in Storm
+
+CGroups are used by Storm to limit the resource usage of workers to
guarantee fairness and QOS.
+
+**Please note: CGroups is currently supported only on Linux platforms
(kernel version 2.6.24 and above)**
+
+## Setup
+
+To use CGroups make sure to install cgroups and configure cgroups
correctly. For more information about setting up and configuring, please visit:
+
+https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Resource_Management_Guide/ch-Using_Control_Groups.html
+
+A sample/default cgconfig.conf file is supplied in the <stormroot>/conf
directory. The contents are as follows:
+
+```
+mount {
+ cpuset = /cgroup/cpuset;
+ cpu = /cgroup/storm_resources;
+ cpuacct = /cgroup/cpuacct;
+ memory = /cgroup/storm_resources;
+ devices = /cgroup/devices;
+ freezer = /cgroup/freezer;
+ net_cls = /cgroup/net_cls;
+ blkio = /cgroup/blkio;
+}
+
+group storm {
+ perm {
+ task {
+ uid = 500;
+ gid = 500;
+ }
+ admin {
+ uid = 500;
+ gid = 500;
+ }
+ }
+ cpu {
+ }
+}
+```
+
+For a more detailed explanation of the format and configs for the
cgconfig.conf file, please visit:
+
+https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Resource_Management_Guide/ch-Using_Control_Groups.html#The_cgconfig.conf_File
+
+# Settings Related To CGroups in Storm
+
+| Setting | Function
|
+|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| storm.cgroup.enable | This config is used to set whether
or not cgroups will be used. Set "true" to enable use of cgroups. Set "false"
to not use cgroups. When this config is set to false, unit tests related to
cgroups will be skipped. Default set to "false"
|
+| storm.cgroup.hierarchy.dir | The path to the cgroup hierarchy that
storm will use. Default set to "/cgroup/storm_resources"
|
+| storm.cgroup.resources | A list of subsystems that will be
regulated by CGroups. Default set to cpu and memory. Currently only cpu and
memory are supported
|
+| storm.supervisor.cgroup.rootdir | The root cgroup used by the
supervisor. The path to the cgroup will be
<cgroup.storm.hierarchy.dir>/<cgroup.supervisor.rootdir>. Default set to
"storm"
|
--- End diff --
<cgroup.storm.hierarchy.dir> should be <storm.cgroup.hierarchy.dir>. I am
assuming that supervisor root dir is actullay same as
storm.cgroup.hierarchy.dir and not configurable.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
