components/docker/files/man/docker-update.1
author Jesse Butler <jesse.butler@oracle.com>
Wed, 20 Jul 2016 17:19:20 -0700
changeset 6468 af5d82385cd7
permissions -rw-r--r--
PSARC/2016/354 Docker Engine 1.10.3 23499922 Docker Engine for Solaris 23757816 Docker on Solaris could use a support utility
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6468
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     1
.TH "DOCKER" "1" " Docker User Manuals" "Docker Community" "JUNE 2014"  ""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     2
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     3
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     4
.SH NAME
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     5
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     6
docker\-update \- Update resource configs of one or more containers
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     7
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     8
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     9
.SH SYNOPSIS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    10
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    11
\fBdocker update\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    12
[\fB\-\-blkio\-weight\fP[=\fI[BLKIO\-WEIGHT]\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    13
[\fB\-\-cpu\-shares\fP[=\fI0\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    14
[\fB\-\-cpu\-period\fP[=\fI0\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    15
[\fB\-\-cpu\-quota\fP[=\fI0\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    16
[\fB\-\-cpuset\-cpus\fP[=\fICPUSET\-CPUS\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    17
[\fB\-\-cpuset\-mems\fP[=\fICPUSET\-MEMS\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    18
[\fB\-\-help\fP]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    19
[\fB\-\-kernel\-memory\fP[=\fIKERNEL\-MEMORY\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    20
[\fB\-m\fP|\fB\-\-memory\fP[=\fIMEMORY\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    21
[\fB\-\-memory\-reservation\fP[=\fIMEMORY\-RESERVATION\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    22
[\fB\-\-memory\-swap\fP[=\fIMEMORY\-SWAP\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    23
CONTAINER [CONTAINER...]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    24
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    25
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    26
.SH DESCRIPTION
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    27
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    28
The \fB\fCdocker update\fR command dynamically updates container resources.  Use this
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    29
command to prevent containers from consuming too many resources from their
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    30
Docker host.  With a single command, you can place limits on a single
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    31
container or on many. To specify more than one container, provide
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    32
space\-separated list of container names or IDs.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    33
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    34
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    35
With the exception of the \fB\fC\-\-kernel\-memory\fR value, you can specify these
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    36
options on a running or a stopped container. You can only update
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    37
\fB\fC\-\-kernel\-memory\fR on a stopped container. When you run \fB\fCdocker update\fR on
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    38
stopped container, the next time you restart it, the container uses those
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    39
values.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    40
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    41
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    42
.SH OPTIONS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    43
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    44
\fB\-\-blkio\-weight\fP=0
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    45
   Block IO weight (relative weight) accepts a weight value between 10 and 1000.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    46
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    47
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    48
\fB\-\-cpu\-shares\fP=0
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    49
   CPU shares (relative weight)
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    50
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    51
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    52
\fB\-\-cpu\-period\fP=0
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    53
   Limit the CPU CFS (Completely Fair Scheduler) period
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    54
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    55
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    56
\fB\-\-cpu\-quota\fP=0
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    57
   Limit the CPU CFS (Completely Fair Scheduler) quota
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    58
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    59
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    60
\fB\-\-cpuset\-cpus\fP=""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    61
   CPUs in which to allow execution (0\-3, 0,1)
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    62
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    63
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    64
\fB\-\-cpuset\-mems\fP=""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    65
   Memory nodes(MEMs) in which to allow execution (0\-3, 0,1). Only effective on NUMA systems.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    66
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    67
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    68
\fB\-\-help\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    69
   Print usage statement
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    70
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    71
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    72
\fB\-\-kernel\-memory\fP=""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    73
   Kernel memory limit (format: \fB\fC<number>[<unit>]\fR, where unit = b, k, m or g)
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    74
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    75
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    76
Note that you can not update kernel memory to a running container, it can only
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    77
be updated to a stopped container, and affect after it's started.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    78
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    79
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    80
\fB\-m\fP, \fB\-\-memory\fP=""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    81
   Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    82
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    83
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    84
\fB\-\-memory\-reservation\fP=""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    85
   Memory soft limit (format: <number>[<unit>], where unit = b, k, m or g)
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    86
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    87
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    88
\fB\-\-memory\-swap\fP=""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    89
   Total memory limit (memory + swap)
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    90
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    91
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    92
.SH EXAMPLES
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    93
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    94
The following sections illustrate ways to use this command.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    95
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    96
.SS Update a container with cpu\-shares=512
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    97
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    98
To limit a container's cpu\-shares to 512, first identify the container
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    99
name or ID. You can use \fBdocker ps\fP to find these values. You can also
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   100
use the ID returned from the \fBdocker run\fP command.  Then, do the following:
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   101
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   102
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   103
.RS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   104
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   105
.nf
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   106
$ docker update \-\-cpu\-shares 512 abebf7571666
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   107
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   108
.fi
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   109
.RE
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   110
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   111
.SS Update a container with cpu\-shares and memory
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   112
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   113
To update multiple resource configurations for multiple containers:
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   114
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   115
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   116
.RS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   117
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   118
.nf
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   119
$ docker update \-\-cpu\-shares 512 \-m 300M abebf7571666 hopeful\_morse
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   120
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   121
.fi
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   122
.RE