From 3fde5f30bda2a70d97f3dc8fa918e42e1c07cc2c Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 27 Sep 2013 00:05:07 +0200 Subject: man: drop references to "cgroup" wher appropriate Since cgroups are mostly now an implementation detail of systemd lets deemphasize it a bit in the man pages. This renames systemd.cgroup(5) to systemd.resource-control(5) and uses the term "resource control" rather than "cgroup" where appropriate. This leaves the word "cgroup" in at a couple of places though, like for example systemd-cgtop and systemd-cgls where cgroup stuff is at the core of what is happening. --- man/loginctl.xml | 4 +- man/machinectl.xml | 4 +- man/pam_systemd.xml | 2 +- man/systemctl.xml | 14 +- man/systemd-cgls.xml | 6 +- man/systemd-cgtop.xml | 4 +- man/systemd.cgroup.xml | 350 --------------------------------------- man/systemd.exec.xml | 2 +- man/systemd.mount.xml | 6 +- man/systemd.resource-control.xml | 348 ++++++++++++++++++++++++++++++++++++++ man/systemd.scope.xml | 2 +- man/systemd.service.xml | 6 +- man/systemd.slice.xml | 22 +-- man/systemd.socket.xml | 12 +- man/systemd.swap.xml | 6 +- 15 files changed, 393 insertions(+), 395 deletions(-) delete mode 100644 man/systemd.cgroup.xml create mode 100644 man/systemd.resource-control.xml (limited to 'man') diff --git a/man/loginctl.xml b/man/loginctl.xml index ef0dfc06b6..1b54ff7dc3 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -117,8 +117,8 @@ - Do not ellipsize cgroup - members. + Do not ellipsize + process tree entries. diff --git a/man/machinectl.xml b/man/machinectl.xml index 5efa3a542a..2ed9f2e8a1 100644 --- a/man/machinectl.xml +++ b/man/machinectl.xml @@ -117,8 +117,8 @@ - Do not ellipsize cgroup - members. + Do not ellipsize + process tree entries. diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 951ae207a4..0e25a4ac9f 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -55,7 +55,7 @@ Description pam_systemd registers user - sessions in the systemd login manager + sessions with the systemd login manager systemd-logind.service8, and hence the systemd control group hierarchy. diff --git a/man/systemctl.xml b/man/systemctl.xml index 32bcf03f2f..e789d4b629 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -174,7 +174,7 @@ along with systemd; If not, see . - Do not ellipsize unit names, cgroup members, and + Do not ellipsize unit names, process tree entries, and truncate unit descriptions in the output of list-units and list-jobs. @@ -711,14 +711,14 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service Set the specified unit properties at runtime where this is supported. This allows changing configuration - parameter properties such as resource management controls at + parameter properties such as resource control settings at runtime. Not all properties may be changed at runtime, but - many resource management settings (primarily those in - systemd.cgroup5) + many resource control settings (primarily those in + systemd.resource-control5) may. The changes are applied instantly, and stored on disk for future boots, unless is - passed, in which case the settings only apply until the next - reboot. The syntax of the property assignment follows + passed, in which case the settings only apply until the + next reboot. The syntax of the property assignment follows closely the syntax of assignments in unit files. Example: systemctl set-property foobar.service CPUShares=777 @@ -1290,7 +1290,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service journalctl1, loginctl1, systemd.unit5, - systemd.cgroup5, + systemd.resource-management5, systemd.special7, wall1, systemd.preset5 diff --git a/man/systemd-cgls.xml b/man/systemd-cgls.xml index fcaf89413e..432706bcbc 100644 --- a/man/systemd-cgls.xml +++ b/man/systemd-cgls.xml @@ -116,8 +116,8 @@ - Do not ellipsize cgroup - members. + Do not ellipsize + process tree members. @@ -132,7 +132,7 @@ - Limit cgroups shown to + Limit control groups shown to the part corresponding to the container MACHINE. diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index 51549c4ac2..7faedfbfdb 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -80,7 +80,7 @@ MemoryAccounting=1 and BlockIOAccounting=1 settings in the unit files in question (See - systemd.cgroup5 + systemd.resource-control5 for details). To emphasize this: unless @@ -274,7 +274,7 @@ systemd1, systemctl1, systemd-cgls1, - systemd.cgroup5, + systemd.resource-control5, top1 diff --git a/man/systemd.cgroup.xml b/man/systemd.cgroup.xml deleted file mode 100644 index ac5896233c..0000000000 --- a/man/systemd.cgroup.xml +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - - - systemd.cgroup - systemd - - - - Developer - Lennart - Poettering - lennart@poettering.net - - - - - - systemd.cgroup - 5 - - - - systemd.cgroup - Control Group configuration unit settings - - - - - slice.slice, - scope.scope, - service.service, - socket.socket, - mount.mount, - swap.swap - - - - - Description - - Unit configuration files for services, slices, scopes, - sockets, mount points, and swap devices share a subset of - configuration options which configure the control group settings - for spawned processes. - - Control Groups is a concept for organizing processes in a - hierarch tree of named groups for the purpose of resource - management. - - This man page lists the configuration options shared by - those six unit types. See - systemd.unit5 - for the common options of all unit configuration files, and - systemd.slice5, - systemd.scope5, - systemd.service5, - systemd.socket5, - systemd.mount5, - and - systemd.swap5 - for more information on the specific unit configuration files. The - execution-specific configuration options are configured in the - [Slice], [Scope], [Service], [Socket], [Mount], or [Swap] - sections, depending on the unit type. - - - - Options - - Units of the types listed above can have settings - for cgroup configuration: - - - - - CPUAccounting= - - - Turn on CPU usage accounting for this unit. Takes a - boolean argument. Note that turning on CPU accounting for - one unit might also implicitly turn it on for all units - contained in the same slice and for all its parent slices and - the units contained therein. - - - - - CPUShares=weight - - - Assign the specified overall CPU time share weight to - the processes executed. Takes an integer value. This - controls the cpu.shares control group - attribute, which defaults to 1024. For details about this - control group attribute, see sched-design-CFS.txt. - - Implies CPUAccounting=true. - - - - - MemoryAccounting= - - - Turn on process and kernel memory accounting for this - unit. Takes a boolean argument. Note that turning on memory - accounting for one unit might also implicitly turn it on for - all units contained in the same slice and for all its parent - slices and the units contained therein. - - - - - MemoryLimit=bytes - - - Specify the limit on maximum memory usage of the - executed processes. The limit specifies how much process and - kernel memory can be used by tasks in this unit. Takes a - memory size in bytes. If the value is suffixed with K, M, G - or T, the specified memory size is parsed as Kilobytes, - Megabytes, Gigabytes, or Terabytes (with the base 1024), - respectively. This controls the - memory.limit_in_bytes control group - attribute. For details about this control group attribute, - see memory.txt. - - Implies MemoryAccounting=true. - - - - - BlockIOAccounting= - - - Turn on Block IO accounting for this unit. Takes a - boolean argument. Note that turning on block IO accounting - for one unit might also implicitly turn it on for all units - contained in the same slice and all for its parent slices and - the units contained therein. - - - - - BlockIOWeight=weight - - Set the default - overall block IO weight for the - executed processes. Takes a single - weight value (between 10 and 1000) to - set the default block IO weight. This - controls the - blkio.weight - control group attribute, which - defaults to 1000. For details about - this control group attribute, see - blkio-controller.txt. - - Implies - BlockIOAccounting=true. - - - - - BlockIODeviceWeight=device weight - - - Set the per-device overall block IO weight for the - executed processes. Takes a space-separated pair of a file - path and a weight value to specify the device specific - weight value, between 10 and 1000. (Example: "/dev/sda - 500"). The file path may be specified as path to a block - device node or as any other file in which case the backing - block device of the file system of the file is - determined. This controls the - blkio.weight_device control group - attribute, which defaults to 1000. Use this option multiple - times to set weights for multiple devices. For details about - this control group attribute, see blkio-controller.txt. - - Implies - BlockIOAccounting=true. - - - - - BlockIOReadBandwidth=device bytes - BlockIOWriteBandwidth=device bytes - - - Set the per-device overall block IO bandwidth limit - for the executed processes. Takes a space-separated pair of - a file path and a bandwidth value (in bytes per second) to - specify the device specific bandwidth. The file path may be - a path to a block device node, or as any other file in which - case the backing block device of the file system of the file - is used. If the bandwidth is suffixed with K, M, G, or T, - the specified bandwidth is parsed as Kilobytes, Megabytes, - Gigabytes, or Terabytes, respectively (Example: - "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This - controls the blkio.read_bps_device and - blkio.write_bps_device control group - attributes. Use this option multiple times to set bandwidth - limits for multiple devices. For details about these control - group attributes, see - blkio-controller.txt. - - - Implies - BlockIOAccounting=true. - - - - - DeviceAllow= - - - Control access to specific device nodes by the - executed processes. Takes two space-separated strings: a - device node path (such as /dev/null) - followed by a combination of r, - w, m to control - reading, writing, - or creation of the specific device node by the unit - (mknod), respectively. This controls - the devices.allow and - devices.deny control group - attributes. For details about these control group attributes, - see devices.txt. - - - - - DevicePolicy=auto|closed|strict - - - - Control the policy for allowing device access: - - - - - - means to only allow types of access that are - explicitly specified. - - - - - - - in addition, allows access to standard pseudo - devices including - /dev/null, - /dev/zero, - /dev/full, - /dev/random, and - /dev/urandom. - - - - - - - - - in addition, allows access to all devices if no - explicit DeviceAllow= is present. - This is the default. - - - - - - - - - Slice= - - - The name of the slice unit to place the unit - in. Defaults to system.slice for all - non-instantiated units of all unit types (except for slice - units themselves see below). Instance units are by default - placed in a subslice of system.slice - that is named after the template name. - - This option may be used to arrange systemd units in a - hierarchy of slices each of which might have resource - settings applied. - - For units of type slice, the only accepted value for - this setting is the parent slice. Since the name of a slice - unit implies the parent slice, it is hence redundant to ever - set this parameter directly for slice units. - - - - - - - - See Also - - systemd1, - systemd.unit5, - systemd.service5, - systemd.slice5, - systemd.scope5, - systemd.socket5, - systemd.mount5, - systemd.swap5, - systemd.directives7, - systemd.special7, - The documentation for control groups and specific controllers in the Linux kernel: - cgroups.txt, - cpuacct.txt, - memory.txt, - blkio-controller.txt. - - - diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index ba4e808ddd..f50161f30c 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -1108,7 +1108,7 @@ systemd.swap5, systemd.mount5, systemd.kill5, - systemd.cgroup5, + systemd.resource-control5, systemd.directives7, exec3 diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index e5b5c3c7c3..48af1caace 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -76,8 +76,8 @@ systemd.kill5, which define the way the processes are terminated, and in - systemd.cgroup5, - which configure control group settings for the + systemd.resource-control5, + which configure resource control settings for the processes of the service. Note that the User= and Group= options are not particularly useful for mount units specifying a Type= option or @@ -302,7 +302,7 @@ systemd.unit5, systemd.exec5, systemd.kill5, - systemd.cgroup5, + systemd.resource-control5, systemd.service5, systemd.device5, proc5, diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml new file mode 100644 index 0000000000..de017a72fd --- /dev/null +++ b/man/systemd.resource-control.xml @@ -0,0 +1,348 @@ + + + + + + + + + systemd.resource-control + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd.resource-control + 5 + + + + systemd.resource-control + Resource control unit settings + + + + + slice.slice, + scope.scope, + service.service, + socket.socket, + mount.mount, + swap.swap + + + + + Description + + Unit configuration files for services, slices, scopes, + sockets, mount points, and swap devices share a subset of + configuration options for resource control of spawned + processes. Internally, this relies on the the Control Groups + kernel concept for organizing processes in a hierarchial tree of + named groups for the purpose of resource management. + + This man page lists the configuration options shared by + those six unit types. See + systemd.unit5 + for the common options of all unit configuration files, and + systemd.slice5, + systemd.scope5, + systemd.service5, + systemd.socket5, + systemd.mount5, + and + systemd.swap5 + for more information on the specific unit configuration files. The + resource control configuration options are configured in the + [Slice], [Scope], [Service], [Socket], [Mount], or [Swap] + sections, depending on the unit type. + + + + Options + + Units of the types listed above can have settings + for resource control configuration: + + + + + CPUAccounting= + + + Turn on CPU usage accounting for this unit. Takes a + boolean argument. Note that turning on CPU accounting for + one unit might also implicitly turn it on for all units + contained in the same slice and for all its parent slices and + the units contained therein. + + + + + CPUShares=weight + + + Assign the specified overall CPU time share weight to + the processes executed. Takes an integer value. This + controls the cpu.shares control group + attribute, which defaults to 1024. For details about this + control group attribute, see sched-design-CFS.txt. + + Implies CPUAccounting=true. + + + + + MemoryAccounting= + + + Turn on process and kernel memory accounting for this + unit. Takes a boolean argument. Note that turning on memory + accounting for one unit might also implicitly turn it on for + all units contained in the same slice and for all its parent + slices and the units contained therein. + + + + + MemoryLimit=bytes + + + Specify the limit on maximum memory usage of the + executed processes. The limit specifies how much process and + kernel memory can be used by tasks in this unit. Takes a + memory size in bytes. If the value is suffixed with K, M, G + or T, the specified memory size is parsed as Kilobytes, + Megabytes, Gigabytes, or Terabytes (with the base 1024), + respectively. This controls the + memory.limit_in_bytes control group + attribute. For details about this control group attribute, + see memory.txt. + + Implies MemoryAccounting=true. + + + + + BlockIOAccounting= + + + Turn on Block IO accounting for this unit. Takes a + boolean argument. Note that turning on block IO accounting + for one unit might also implicitly turn it on for all units + contained in the same slice and all for its parent slices and + the units contained therein. + + + + + BlockIOWeight=weight + + Set the default + overall block IO weight for the + executed processes. Takes a single + weight value (between 10 and 1000) to + set the default block IO weight. This + controls the + blkio.weight + control group attribute, which + defaults to 1000. For details about + this control group attribute, see + blkio-controller.txt. + + Implies + BlockIOAccounting=true. + + + + + BlockIODeviceWeight=device weight + + + Set the per-device overall block IO weight for the + executed processes. Takes a space-separated pair of a file + path and a weight value to specify the device specific + weight value, between 10 and 1000. (Example: "/dev/sda + 500"). The file path may be specified as path to a block + device node or as any other file in which case the backing + block device of the file system of the file is + determined. This controls the + blkio.weight_device control group + attribute, which defaults to 1000. Use this option multiple + times to set weights for multiple devices. For details about + this control group attribute, see blkio-controller.txt. + + Implies + BlockIOAccounting=true. + + + + + BlockIOReadBandwidth=device bytes + BlockIOWriteBandwidth=device bytes + + + Set the per-device overall block IO bandwidth limit + for the executed processes. Takes a space-separated pair of + a file path and a bandwidth value (in bytes per second) to + specify the device specific bandwidth. The file path may be + a path to a block device node, or as any other file in which + case the backing block device of the file system of the file + is used. If the bandwidth is suffixed with K, M, G, or T, + the specified bandwidth is parsed as Kilobytes, Megabytes, + Gigabytes, or Terabytes, respectively (Example: + "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This + controls the blkio.read_bps_device and + blkio.write_bps_device control group + attributes. Use this option multiple times to set bandwidth + limits for multiple devices. For details about these control + group attributes, see + blkio-controller.txt. + + + Implies + BlockIOAccounting=true. + + + + + DeviceAllow= + + + Control access to specific device nodes by the + executed processes. Takes two space-separated strings: a + device node path (such as /dev/null) + followed by a combination of r, + w, m to control + reading, writing, + or creation of the specific device node by the unit + (mknod), respectively. This controls + the devices.allow and + devices.deny control group + attributes. For details about these control group attributes, + see devices.txt. + + + + + DevicePolicy=auto|closed|strict + + + + Control the policy for allowing device access: + + + + + + means to only allow types of access that are + explicitly specified. + + + + + + + in addition, allows access to standard pseudo + devices including + /dev/null, + /dev/zero, + /dev/full, + /dev/random, and + /dev/urandom. + + + + + + + + + in addition, allows access to all devices if no + explicit DeviceAllow= is present. + This is the default. + + + + + + + + + Slice= + + + The name of the slice unit to place the unit + in. Defaults to system.slice for all + non-instantiated units of all unit types (except for slice + units themselves see below). Instance units are by default + placed in a subslice of system.slice + that is named after the template name. + + This option may be used to arrange systemd units in a + hierarchy of slices each of which might have resource + settings applied. + + For units of type slice, the only accepted value for + this setting is the parent slice. Since the name of a slice + unit implies the parent slice, it is hence redundant to ever + set this parameter directly for slice units. + + + + + + + + See Also + + systemd1, + systemd.unit5, + systemd.service5, + systemd.slice5, + systemd.scope5, + systemd.socket5, + systemd.mount5, + systemd.swap5, + systemd.directives7, + systemd.special7, + The documentation for control groups and specific controllers in the Linux kernel: + cgroups.txt, + cpuacct.txt, + memory.txt, + blkio-controller.txt. + + + diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml index e8fa1aed59..9813e0a696 100644 --- a/man/systemd.scope.xml +++ b/man/systemd.scope.xml @@ -86,7 +86,7 @@ along with systemd; If not, see . systemd1, systemd-run1, systemd.unit5, - systemd.cgroup5, + systemd.resource-control5, systemd.service5, systemd.directives7. diff --git a/man/systemd.service.xml b/man/systemd.service.xml index c06e14efc2..5e1ddf7188 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -76,8 +76,8 @@ systemd.kill5, which define the way the processes of the service are terminated, and in - systemd.cgroup5, - which configure control group settings for the + systemd.resource-control5, + which configure resource control settings for the processes of the service. Unless DefaultDependencies= @@ -1007,7 +1007,7 @@ systemctl8, systemd.unit5, systemd.exec5, - systemd.cgroup5, + systemd.resource-control5, systemd.kill5, systemd.directives7 diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml index b7b0622d3c..4d27ddf890 100644 --- a/man/systemd.slice.xml +++ b/man/systemd.slice.xml @@ -58,14 +58,14 @@ along with systemd; If not, see . .slice encodes information about a slice which is a concept for hierarchially managing resources of a group of processes. This management is performed by creating a node in the - control group tree. Units that manage processes (primarilly scope - and service units) may be assigned to a specific slice. For each - slice, certain resource limits may the be set that apply to all - processes of all units contained in that slice. Slices are - organized hierarchially in a tree. The name of the slice encodes - the location in the tree. The name consists of a dash-separated - series of names, which describes the path to the slice from the - root slice. The root slice is named, + Linux Control Group (cgroup) tree. Units that manage processes + (primarilly scope and service units) may be assigned to a specific + slice. For each slice, certain resource limits may the be set that + apply to all processes of all units contained in that + slice. Slices are organized hierarchially in a tree. The name of + the slice encodes the location in the tree. The name consists of a + dash-separated series of names, which describes the path to the + slice from the root slice. The root slice is named, -.slice. Example: foo-bar.slice is a slice that is located within foo.slice, which in turn is located in @@ -89,9 +89,9 @@ along with systemd; If not, see . files. The common configuration items are configured in the generic [Unit] and [Install] sections. The slice specific configuration options are configured in - the [Slice] section. Currently, only generic cgroup settings + the [Slice] section. Currently, only generic resource control settings as described in - systemd.cgroup7 are allowed. + systemd.resource-control7 are allowed. Unless DefaultDependencies=false @@ -110,7 +110,7 @@ along with systemd; If not, see . systemd1, systemd.unit5, - systemd.cgroup5, + systemd.resource-control5, systemd.service5, systemd.scope5, systemd.special7, diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 419a38caa7..8c88d9f8aa 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -78,11 +78,11 @@ commands are executed in, and in systemd.kill5, - which define the way the processes are - terminated, and in - systemd.cgroup5, - which configure control group settings for the - processes of the service. + which define the way the processes are terminated, and + in + systemd.resource-control5, + which configure resource control settings for the + processes of the socket. For each socket file a matching service file (see @@ -712,7 +712,7 @@ systemd.unit5, systemd.exec5, systemd.kill5, - systemd.cgroup5, + systemd.resource-control5, systemd.service5, systemd.directives7 diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 18ef5b0f53..813ae6c942 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -76,8 +76,8 @@ systemd.kill5, which define the way the processes are terminated, and in - systemd.cgroup5, - which configure control group settings for the + systemd.resource-control5, + which configure resource control settings for the processes of the service. Swap units must be named after the devices @@ -206,7 +206,7 @@ systemd.unit5, systemd.exec5, systemd.kill5, - systemd.cgroup5, + systemd.resource-control5, systemd.device5, systemd.mount5, swapon8, -- cgit v1.2.3-54-g00ecf