Github user unsleepy22 commented on a diff in the pull request:
https://github.com/apache/storm/pull/1054#discussion_r51076573
--- Diff: documentation/cgroups_in_storm.md ---
@@ -0,0 +1,61 @@
+# CGroups in Storm
+
+CGroups are used by Storm to limit the resource usage of workers to
guaratee fairness and QOS.
+
+**Please note: CGroups is currently supported only on Linux platforms**
+
+## Setup
+
+To use CGroups make sure to to install cgroups and configure cgroups
correctly. For more information about seting 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 {
+ }
+}
+```
+
+# Settings Related To CGroups in Storm
+
+| Setting | Function
|
+|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 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 skipped. Default set to "false"
|
--- End diff --
will skipped -> will be skipped, very minor
---
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 [email protected] or file a JIRA ticket
with INFRA.
---
