nixos: nixos/doc/manual/administration/control-groups.xml to CommonMark
This commit is contained in:
parent
8ee759d7cf
commit
e63f523491
59
nixos/doc/manual/administration/control-groups.chapter.md
Normal file
59
nixos/doc/manual/administration/control-groups.chapter.md
Normal file
|
@ -0,0 +1,59 @@
|
||||||
|
# Control Groups {#sec-cgroups}
|
||||||
|
|
||||||
|
To keep track of the processes in a running system, systemd uses
|
||||||
|
*control groups* (cgroups). A control group is a set of processes used
|
||||||
|
to allocate resources such as CPU, memory or I/O bandwidth. There can be
|
||||||
|
multiple control group hierarchies, allowing each kind of resource to be
|
||||||
|
managed independently.
|
||||||
|
|
||||||
|
The command `systemd-cgls` lists all control groups in the `systemd`
|
||||||
|
hierarchy, which is what systemd uses to keep track of the processes
|
||||||
|
belonging to each service or user session:
|
||||||
|
|
||||||
|
```ShellSession
|
||||||
|
$ systemd-cgls
|
||||||
|
├─user
|
||||||
|
│ └─eelco
|
||||||
|
│ └─c1
|
||||||
|
│ ├─ 2567 -:0
|
||||||
|
│ ├─ 2682 kdeinit4: kdeinit4 Running...
|
||||||
|
│ ├─ ...
|
||||||
|
│ └─10851 sh -c less -R
|
||||||
|
└─system
|
||||||
|
├─httpd.service
|
||||||
|
│ ├─2444 httpd -f /nix/store/3pyacby5cpr55a03qwbnndizpciwq161-httpd.conf -DNO_DETACH
|
||||||
|
│ └─...
|
||||||
|
├─dhcpcd.service
|
||||||
|
│ └─2376 dhcpcd --config /nix/store/f8dif8dsi2yaa70n03xir8r653776ka6-dhcpcd.conf
|
||||||
|
└─ ...
|
||||||
|
```
|
||||||
|
|
||||||
|
Similarly, `systemd-cgls cpu` shows the cgroups in the CPU hierarchy,
|
||||||
|
which allows per-cgroup CPU scheduling priorities. By default, every
|
||||||
|
systemd service gets its own CPU cgroup, while all user sessions are in
|
||||||
|
the top-level CPU cgroup. This ensures, for instance, that a thousand
|
||||||
|
run-away processes in the `httpd.service` cgroup cannot starve the CPU
|
||||||
|
for one process in the `postgresql.service` cgroup. (By contrast, it
|
||||||
|
they were in the same cgroup, then the PostgreSQL process would get
|
||||||
|
1/1001 of the cgroup's CPU time.) You can limit a service's CPU share in
|
||||||
|
`configuration.nix`:
|
||||||
|
|
||||||
|
```nix
|
||||||
|
systemd.services.httpd.serviceConfig.CPUShares = 512;
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, every cgroup has 1024 CPU shares, so this will halve the CPU
|
||||||
|
allocation of the `httpd.service` cgroup.
|
||||||
|
|
||||||
|
There also is a `memory` hierarchy that controls memory allocation
|
||||||
|
limits; by default, all processes are in the top-level cgroup, so any
|
||||||
|
service or session can exhaust all available memory. Per-cgroup memory
|
||||||
|
limits can be specified in `configuration.nix`; for instance, to limit
|
||||||
|
`httpd.service` to 512 MiB of RAM (excluding swap):
|
||||||
|
|
||||||
|
```nix
|
||||||
|
systemd.services.httpd.serviceConfig.MemoryLimit = "512M";
|
||||||
|
```
|
||||||
|
|
||||||
|
The command `systemd-cgtop` shows a continuously updated list of all
|
||||||
|
cgroups with their CPU and memory usage.
|
|
@ -1,65 +0,0 @@
|
||||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
||||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
||||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
||||||
version="5.0"
|
|
||||||
xml:id="sec-cgroups">
|
|
||||||
<title>Control Groups</title>
|
|
||||||
<para>
|
|
||||||
To keep track of the processes in a running system, systemd uses
|
|
||||||
<emphasis>control groups</emphasis> (cgroups). A control group is a set of
|
|
||||||
processes used to allocate resources such as CPU, memory or I/O bandwidth.
|
|
||||||
There can be multiple control group hierarchies, allowing each kind of
|
|
||||||
resource to be managed independently.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
The command <command>systemd-cgls</command> lists all control groups in the
|
|
||||||
<literal>systemd</literal> hierarchy, which is what systemd uses to keep
|
|
||||||
track of the processes belonging to each service or user session:
|
|
||||||
<screen>
|
|
||||||
<prompt>$ </prompt>systemd-cgls
|
|
||||||
├─user
|
|
||||||
│ └─eelco
|
|
||||||
│ └─c1
|
|
||||||
│ ├─ 2567 -:0
|
|
||||||
│ ├─ 2682 kdeinit4: kdeinit4 Running...
|
|
||||||
│ ├─ <replaceable>...</replaceable>
|
|
||||||
│ └─10851 sh -c less -R
|
|
||||||
└─system
|
|
||||||
├─httpd.service
|
|
||||||
│ ├─2444 httpd -f /nix/store/3pyacby5cpr55a03qwbnndizpciwq161-httpd.conf -DNO_DETACH
|
|
||||||
│ └─<replaceable>...</replaceable>
|
|
||||||
├─dhcpcd.service
|
|
||||||
│ └─2376 dhcpcd --config /nix/store/f8dif8dsi2yaa70n03xir8r653776ka6-dhcpcd.conf
|
|
||||||
└─ <replaceable>...</replaceable>
|
|
||||||
</screen>
|
|
||||||
Similarly, <command>systemd-cgls cpu</command> shows the cgroups in the CPU
|
|
||||||
hierarchy, which allows per-cgroup CPU scheduling priorities. By default,
|
|
||||||
every systemd service gets its own CPU cgroup, while all user sessions are in
|
|
||||||
the top-level CPU cgroup. This ensures, for instance, that a thousand
|
|
||||||
run-away processes in the <literal>httpd.service</literal> cgroup cannot
|
|
||||||
starve the CPU for one process in the <literal>postgresql.service</literal>
|
|
||||||
cgroup. (By contrast, it they were in the same cgroup, then the PostgreSQL
|
|
||||||
process would get 1/1001 of the cgroup’s CPU time.) You can limit a
|
|
||||||
service’s CPU share in <filename>configuration.nix</filename>:
|
|
||||||
<programlisting>
|
|
||||||
<link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.CPUShares = 512;
|
|
||||||
</programlisting>
|
|
||||||
By default, every cgroup has 1024 CPU shares, so this will halve the CPU
|
|
||||||
allocation of the <literal>httpd.service</literal> cgroup.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
There also is a <literal>memory</literal> hierarchy that controls memory
|
|
||||||
allocation limits; by default, all processes are in the top-level cgroup, so
|
|
||||||
any service or session can exhaust all available memory. Per-cgroup memory
|
|
||||||
limits can be specified in <filename>configuration.nix</filename>; for
|
|
||||||
instance, to limit <literal>httpd.service</literal> to 512 MiB of RAM
|
|
||||||
(excluding swap):
|
|
||||||
<programlisting>
|
|
||||||
<link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.MemoryLimit = "512M";
|
|
||||||
</programlisting>
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
The command <command>systemd-cgtop</command> shows a continuously updated
|
|
||||||
list of all cgroups with their CPU and memory usage.
|
|
||||||
</para>
|
|
||||||
</chapter>
|
|
|
@ -13,7 +13,7 @@
|
||||||
<xi:include href="../from_md/administration/service-mgmt.chapter.xml" />
|
<xi:include href="../from_md/administration/service-mgmt.chapter.xml" />
|
||||||
<xi:include href="../from_md/administration/rebooting.chapter.xml" />
|
<xi:include href="../from_md/administration/rebooting.chapter.xml" />
|
||||||
<xi:include href="../from_md/administration/user-sessions.chapter.xml" />
|
<xi:include href="../from_md/administration/user-sessions.chapter.xml" />
|
||||||
<xi:include href="control-groups.xml" />
|
<xi:include href="../from_md/administration/control-groups.chapter.xml" />
|
||||||
<xi:include href="logging.xml" />
|
<xi:include href="logging.xml" />
|
||||||
<xi:include href="cleaning-store.xml" />
|
<xi:include href="cleaning-store.xml" />
|
||||||
<xi:include href="containers.xml" />
|
<xi:include href="containers.xml" />
|
||||||
|
|
|
@ -0,0 +1,67 @@
|
||||||
|
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-cgroups">
|
||||||
|
<title>Control Groups</title>
|
||||||
|
<para>
|
||||||
|
To keep track of the processes in a running system, systemd uses
|
||||||
|
<emphasis>control groups</emphasis> (cgroups). A control group is a
|
||||||
|
set of processes used to allocate resources such as CPU, memory or
|
||||||
|
I/O bandwidth. There can be multiple control group hierarchies,
|
||||||
|
allowing each kind of resource to be managed independently.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
The command <literal>systemd-cgls</literal> lists all control groups
|
||||||
|
in the <literal>systemd</literal> hierarchy, which is what systemd
|
||||||
|
uses to keep track of the processes belonging to each service or
|
||||||
|
user session:
|
||||||
|
</para>
|
||||||
|
<programlisting>
|
||||||
|
$ systemd-cgls
|
||||||
|
├─user
|
||||||
|
│ └─eelco
|
||||||
|
│ └─c1
|
||||||
|
│ ├─ 2567 -:0
|
||||||
|
│ ├─ 2682 kdeinit4: kdeinit4 Running...
|
||||||
|
│ ├─ ...
|
||||||
|
│ └─10851 sh -c less -R
|
||||||
|
└─system
|
||||||
|
├─httpd.service
|
||||||
|
│ ├─2444 httpd -f /nix/store/3pyacby5cpr55a03qwbnndizpciwq161-httpd.conf -DNO_DETACH
|
||||||
|
│ └─...
|
||||||
|
├─dhcpcd.service
|
||||||
|
│ └─2376 dhcpcd --config /nix/store/f8dif8dsi2yaa70n03xir8r653776ka6-dhcpcd.conf
|
||||||
|
└─ ...
|
||||||
|
</programlisting>
|
||||||
|
<para>
|
||||||
|
Similarly, <literal>systemd-cgls cpu</literal> shows the cgroups in
|
||||||
|
the CPU hierarchy, which allows per-cgroup CPU scheduling
|
||||||
|
priorities. By default, every systemd service gets its own CPU
|
||||||
|
cgroup, while all user sessions are in the top-level CPU cgroup.
|
||||||
|
This ensures, for instance, that a thousand run-away processes in
|
||||||
|
the <literal>httpd.service</literal> cgroup cannot starve the CPU
|
||||||
|
for one process in the <literal>postgresql.service</literal> cgroup.
|
||||||
|
(By contrast, it they were in the same cgroup, then the PostgreSQL
|
||||||
|
process would get 1/1001 of the cgroup’s CPU time.) You can limit a
|
||||||
|
service’s CPU share in <literal>configuration.nix</literal>:
|
||||||
|
</para>
|
||||||
|
<programlisting language="bash">
|
||||||
|
systemd.services.httpd.serviceConfig.CPUShares = 512;
|
||||||
|
</programlisting>
|
||||||
|
<para>
|
||||||
|
By default, every cgroup has 1024 CPU shares, so this will halve the
|
||||||
|
CPU allocation of the <literal>httpd.service</literal> cgroup.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
There also is a <literal>memory</literal> hierarchy that controls
|
||||||
|
memory allocation limits; by default, all processes are in the
|
||||||
|
top-level cgroup, so any service or session can exhaust all
|
||||||
|
available memory. Per-cgroup memory limits can be specified in
|
||||||
|
<literal>configuration.nix</literal>; for instance, to limit
|
||||||
|
<literal>httpd.service</literal> to 512 MiB of RAM (excluding swap):
|
||||||
|
</para>
|
||||||
|
<programlisting language="bash">
|
||||||
|
systemd.services.httpd.serviceConfig.MemoryLimit = "512M";
|
||||||
|
</programlisting>
|
||||||
|
<para>
|
||||||
|
The command <literal>systemd-cgtop</literal> shows a continuously
|
||||||
|
updated list of all cgroups with their CPU and memory usage.
|
||||||
|
</para>
|
||||||
|
</chapter>
|
Loading…
Reference in a new issue