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.1120
1 files changed, 120 insertions, 0 deletions
diff --git a/share/man/container-limit.1 b/share/man/container-limit.1
new file mode 100644
index 0000000..57258b3
--- /dev/null
+++ b/share/man/container-limit.1
@@ -0,0 +1,120 @@
+'\" t
+.\" Title: container-limit
+.\" Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 20190304
+.\" Manual: Open Infrastructure
+.\" Source: compute-tools
+.\" Language: English
+.\"
+.TH "CONTAINER\-LIMIT" "1" "20190304" "compute\-tools" "Open Infrastructure"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+container-limit \- Limit ressources of a container
+.SH "SYNOPSIS"
+.sp
+\fBcontainer limit\fR [\fIOPTIONS\fR]
+.SH "DESCRIPTION"
+.sp
+The container limit command limits ressources available to a container at runtime\&.
+.SH "OPTIONS"
+.sp
+The following container options are available:
+.PP
+\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR
+.RS 4
+Specify container name\&.
+.RE
+.PP
+\fB\-\-blockio\-device\-weight=\fR\fB\fIDEVICE WEIGHT\fR\fR
+.RS 4
+Specify device specific blockio weight, see systemd\&.resource\-control(5)\&.
+.RE
+.PP
+\fB\-\-blockio\-read\-bandwidth=\fR\fB\fIDEVICE BYTES\fR\fR
+.RS 4
+Specify device specific blockio read bandwidth, see systemd\&.resource\-control(5)\&.
+.RE
+.PP
+\fB\-b, \-\-blockio\-weight=\fR\fB\fIWEIGHT\fR\fR
+.RS 4
+Specify general blockio weight, see systemd\&.resource\-control(5)\&.
+.RE
+.PP
+\fB\-\-blockio\-write\-bandwidth=\fR\fB\fIDEVICE BYTES\fR\fR
+.RS 4
+Specify device specific blockio write bandwidth, see systemd\&.resource\-control(5)\&.
+.RE
+.PP
+\fB\-c, \-\-cpu\-quota=\fR\fB\fIQUOTA\fR\fR
+.RS 4
+Specify CPU quota, see systemd\&.resource\-control(5)\&.
+.RE
+.PP
+\fB\-\-cpu\-shares=\fR\fB\fISHARES\fR\fR
+.RS 4
+Specify CPU shares, see systemd\&.resource\-control(5)\&.
+.RE
+.PP
+\fB\-m, \-\-memory\-limit=\fR\fB\fIBYTES\fR\fR
+.RS 4
+Specify memory limit, see systemd\&.resource\-control(5)\&.
+.RE
+.PP
+\fB\-t, \-\-tasks\-max=\fR\fB\fINUMBER\fR\fR
+.RS 4
+Specify tasks max, see systemd\&.resource\-control(5)\&.
+.RE
+.SH "EXAMPLES"
+.PP
+\fBSet blockio weight for the example\&.net container:\fR
+.RS 4
+sudo container limit \-n example\&.net \-\-blockio\-weight 100
+.RE
+.PP
+\fBSet CPU quota for the example\&.net container:\fR
+.RS 4
+sudo container limit \-n example\&.net \-\-cpu\-quota 10%
+.RE
+.PP
+\fBSet memory limit for the example\&.net container to 1GB:\fR
+.RS 4
+sudo container limit \-n example\&.net \-\-memory\-limit 1G
+.RE
+.PP
+\fBSet tasks max for the example\&.net container to 100:\fR
+.RS 4
+sudo container limit \-n example\&.net \-\-tasks\-max 100
+.RE
+.SH "SEE ALSO"
+.sp
+compute\-tools(7), container(1)\&.
+.SH "HOMEPAGE"
+.sp
+More information about compute\-tools and the Open Infrastructure project can be found on the homepage at https://open\-infrastructure\&.net\&.
+.SH "CONTACT"
+.sp
+Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List <software@lists\&.open\-infrastructure\&.net>\&.
+.sp
+Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs\&.debian\&.org\&.
+.SH "AUTHORS"
+.sp
+compute\-tools were written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net> and others\&.