summaryrefslogtreecommitdiffstats
path: root/share/man/container-limit.1
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/container-limit.1')
-rw-r--r--share/man/container-limit.1145
1 files changed, 145 insertions, 0 deletions
diff --git a/share/man/container-limit.1 b/share/man/container-limit.1
new file mode 100644
index 0000000..918fcd5
--- /dev/null
+++ b/share/man/container-limit.1
@@ -0,0 +1,145 @@
+.\" Open Infrastructure: compute-tools
+.\"
+.\" Copyright (C) 2014-2021 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/>.
+.\"
+.
+.TH CONTAINER-LIMIT 1 compute-tools "Open Infrastructure"
+.SH NAME
+container-limit \- Limit resources of a container
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.nf
+\fBcontainer limit\fP [\(aqOPTIONS\(aq]
+.fi
+.sp
+.SH DESCRIPTION
+.sp
+The \fBcontainer limit\fP command limits resources available to a container at
+runtime.
+.SH OPTIONS
+.sp
+The following \fBcontainer limit\fP options are available:
+.INDENT 0.0
+.TP
+.B \-n, \-\-name=\(aqNAME\(aq:
+Specify container name.
+.TP
+.B \-\-blockio\-device\-weight=\(aqDEVICE WEIGHT\(aq:
+Specify device specific blockio weight, see systemd.resource\-control(5).
+.TP
+.B \-\-blockio\-read\-bandwidth=\(aqDEVICE BYTES\(aq:
+Specify device specific blockio read bandwidth, see
+systemd.resource\-control(5).
+.TP
+.B \-b, \-\-blockio\-weight=\(aqWEIGHT\(aq:
+Specify general blockio weight, see systemd.resource\-control(5).
+.TP
+.B \-\-blockio\-write\-bandwidth=\(aqDEVICE BYTES\(aq:
+Specify device specific blockio write bandwidth, see
+systemd.resource\-control(5).
+.TP
+.B \-c, \-\-cpu\-quota=\(aqQUOTA\(aq:
+Specify CPU quota, see systemd.resource\-control(5).
+.TP
+.B \-\-cpu\-shares=\(aqSHARES\(aq:
+Specify CPU shares, see systemd.resource\-control(5).
+.TP
+.B \-m, \-\-memory\-limit=\(aqBYTES\(aq:
+Specify memory limit, see systemd.resource\-control(5).
+.TP
+.B \-t, \-\-tasks\-max=\(aqNUMBER\(aq:
+Specify tasks max, see systemd.resource\-control(5).
+.UNINDENT
+.SH EXAMPLES
+.sp
+Set blockio weight for the example.net container:
+.INDENT 0.0
+.INDENT 3.5
+sudo container limit \-n example.net \-\-blockio\-weight 100
+.UNINDENT
+.UNINDENT
+.sp
+Set CPU quota for the example.net container:
+.INDENT 0.0
+.INDENT 3.5
+sudo container limit \-n example.net \-\-cpu\-quota 10%
+.UNINDENT
+.UNINDENT
+.sp
+Set memory limit for the example.net container to 1GB:
+.INDENT 0.0
+.INDENT 3.5
+sudo container limit \-n example.net \-\-memory\-limit 1G
+.UNINDENT
+.UNINDENT
+.sp
+Set tasks max for the example.net container to 100:
+.INDENT 0.0
+.INDENT 3.5
+sudo container limit \-n example.net \-\-tasks\-max 100
+.UNINDENT
+.UNINDENT
+.SH SEE ALSO
+.nf
+compute\-tools(7),
+container(1).
+.fi
+.sp
+.SH HOMEPAGE
+.sp
+More information about compute\-tools and the Open Infrastructure project can be
+found on the homepage (\fI\%https://open\-infrastructure.net\fP).
+.SH CONTACT
+.sp
+Bug reports, feature requests, help, patches, support and everything else are
+welcome on the Open Infrastructure Software Mailing List
+<\fI\%software@lists.open\-infrastructure.net\fP>.
+.sp
+Debian specific bugs can also be reported in the Debian Bug Tracking System
+(\fI\%https://bugs.debian.org\fP).
+.SH AUTHORS
+.sp
+compute\-tools were written by Daniel Baumann
+<\fI\%daniel.baumann@open\-infrastructure.net\fP> and others.
+.