summaryrefslogtreecommitdiffstats
path: root/share/man/container-limit.1.rst
blob: 43001f15af9690b8d92beb6b8bd2d88c783726f2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.. Open Infrastructure: compute-tools

.. Copyright (C) 2014-2024 Daniel Baumann <daniel.baumann@open-infrastructure.net>
..
.. SPDX-License-Identifier: GPL-3.0+
..
.. This program is free software: you can redistribute it and/or modify
.. it under the terms of the GNU General Public License as published by
.. the Free Software Foundation, either version 3 of the License, or
.. (at your option) any later version.
..
.. This program is distributed in the hope that it will be useful,
.. but WITHOUT ANY WARRANTY; without even the implied warranty of
.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.. GNU General Public License for more details.
..
.. You should have received a copy of the GNU General Public License
.. along with this program.  If not, see <https://www.gnu.org/licenses/>.

===============
container-limit
===============

------------------------------
Limit resources of a container
------------------------------

:manual section: 1
:manual group: Open Infrastructure

Synopsis
========

| **container limit** ['OPTIONS']

Description
===========

The **container limit** command limits resources available to a container at
runtime.

Options
=======

The following **container limit** options are available:

-n, --name='NAME':
  Specify container name.

--blockio-device-weight='DEVICE WEIGHT':
  Specify device specific blockio weight, see systemd.resource-control(5).

--blockio-read-bandwidth='DEVICE BYTES':
  Specify device specific blockio read bandwidth, see
  systemd.resource-control(5).

-b, --blockio-weight='WEIGHT':
  Specify general blockio weight, see systemd.resource-control(5).

--blockio-write-bandwidth='DEVICE BYTES':
  Specify device specific blockio write bandwidth, see
  systemd.resource-control(5).

-c, --cpu-quota='QUOTA':
  Specify CPU quota, see systemd.resource-control(5).

--cpu-shares='SHARES':
  Specify CPU shares, see systemd.resource-control(5).

-m, --memory-limit='BYTES':
  Specify memory limit, see systemd.resource-control(5).

-t, --tasks-max='NUMBER':
  Specify tasks max, see systemd.resource-control(5).

Examples
========

Set blockio weight for the example.net container:

  sudo container limit -n example.net --blockio-weight 100

Set CPU quota for the example.net container:

  sudo container limit -n example.net --cpu-quota 10%

Set memory limit for the example.net container to 1GB:

  sudo container limit -n example.net --memory-limit 1G

Set tasks max for the example.net container to 100:

  sudo container limit -n example.net --tasks-max 100

See also
========

| compute-tools(7),
| container(1).

Homepage
========

More information about compute-tools and the Open Infrastructure project can be
found on the homepage (https://open-infrastructure.net).

Contact
=======

Bug reports, feature requests, help, patches, support and everything else are
welcome on the Open Infrastructure Software Mailing List
<software@lists.open-infrastructure.net>.

Debian specific bugs can also be reported in the Debian Bug Tracking System
(https://bugs.debian.org).

Authors
=======

compute-tools were written by Daniel Baumann
<daniel.baumann@open-infrastructure.net> and others.