Configure cgroups using cgconfig

You can use the cgconfig service installed with libcgroup to create cgroups on Linux systems not running systemd. For more information, see Using Control Groups.

To configure cgroups for workload management in Splunk Enterprise using cgconfig:

1. Check that /sys/fs is mounted. If it is not mounted, mount the tmpfs in-memory filesystem under /sys/fs/cgroup as follows:

   sudo mount -t tmpfs -o size=10M tmpfs /sys/fs
   

   Note: Splunk Enterprise examines the /proc/mounts file to determine whether your Linux machine can support workload management.
2. Create the cgconfig.conf file under /etc and add the following:

   mount {
       cpuset  = /sys/fs/cgroup/cpuset;
       cpu =     /sys/fs/cgroup/cpu;
       cpuacct = /sys/fs/cgroup/cpuacct;
       memory  = /sys/fs/cgroup/memory;
       devices = /sys/fs/cgroup/devices;
       freezer = /sys/fs/cgroup/freezer;
       net_cls = /sys/fs/cgroup/net_cls;
       blkio   = /sys/fs/cgroup/blkio;
   }
    
   group splunk {
       perm {
            admin {
                uid = "splunk";
                gid = "splunk";
            }
            task {
                uid = "splunk";
                gid = "splunk";
            }
        }
       cpu {
            cpu.shares = "2048";
           }
       memory {
            memory.limit_in_bytes = "3G";
              }
   }
   

3. Restart the cgconfig service.

   # service cgconfig restart
   Stopping cgconfig service:                                 [  OK  ]
   Starting cgconfig service:                                 [  OK  ]
   

   This creates the splunk cgroup.

   Note: The cgroup name must match the value of workload_pool_base_dir_name defined in workload_pools.conf The default value is splunk.

Configure cgroups using filesystem operations

To configure cgroups, the Linux admin, logged in as root user, must create the cgroups and assign the splunk user permissions to manage the cgroups, as follows:

1. In workload_pools.conf, set workload_pool_base_dir_name to the root cgroup to be used by splunk. For example:

   [general]
   workload_pool_base_dir_name = splunk
   

   Or, send a POST request:

   workloads/config/set-base-dirname -workload_pool_base_dir_name <base_dir_name>
   

   For endpoint details, see workloads/config/set-base-dirname in the Splunk Enterprise REST API Reference Manual.

2. Create cgroups. The cgroup path differs depending on whether you are using cgroups v1 or v2.
   For cgroups v1, create separate cpu and memory cgroups:

   sudo mkdir /sys/fs/cgroup/cpu/<workload_pool_base_dir_name>
   sudo mkdir /sys/fs/cgroup/memory/<workload_pool_base_dir_name>
   

   Or, for cgroups v2, create a unified path cgroup:

   sudo mkdir /sys/fs/cgroup/<workload_pool_base_dir_name>
   

3. Assign the splunk user permissions to manage the respective cgroups. For cgroups v1:

   sudo chown -R ${USER} /sys/fs/cgroup/cpu/<workload_pool_base_dir_name>
   sudo chown -R ${USER} /sys/fs/cgroup/memory/<workload_pool_base_dir_name>
   

   Or, for cgroups v2:

   sudo chown -R ${USER} /sys/fs/cgroup/<workload_pool_base_dir_name>
   

   Note: If you have specified a user as SPLUNK_OS_USER in splunk-launch.conf, you must specify the same user as {USER} in the command. For more information see splunk-launch.conf in the Splunk Enterprise Admin Manual.
4. Assign CPU shares and physical memory for splunk cgroup. For cgroups v1:

   cd /sys/fs/cgroup/cpu/splunk
   echo 2048 > cpu.shares
   

   cd /sys/fs/cgroup/memory/splunk/
   echo 14G > memory.limit_in_bytes
   

   Or, for cgroups v2:

   cd /sys/fs/cgroup/splunk
   echo 100 > cpu.weight
   

   cd /sys/fs/cgroup/splunk/
   echo 14G > memory.max