Skip to content

Commit c42acb9

Browse files
author
Matthew Fisher
committed
docs(client): more clarity on limit:set options
1 parent a0ee3bd commit c42acb9

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

client/deis.py

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1388,21 +1388,30 @@ def limit_set(self, args):
13881388
is applied to each individual container, so setting a memory limit of 1G for an
13891389
application means that each container gets 1G of memory.
13901390
1391-
Usage: deis limit:set [--memory | --cpu] <type>=<limit>... [options]
1391+
Usage: deis limit:set [options] <type>=<limit>...
13921392
13931393
Arguments:
1394-
-m, --memory limit memory [default: true]
1395-
-c, --cpu limit cpu shares
13961394
<type>
13971395
the process type as defined in your Procfile, such as 'web' or 'worker'.
13981396
Note that Dockerfile apps have a default 'cmd' process type.
13991397
<limit>
1400-
web=1G worker=256M (with --memory, units in G/M/K/B)
1401-
cmd=1024 clock=100 (with --cpu, units in cpu shares)
1398+
The limit to apply to the process type. By default, this is set to --memory.
1399+
1400+
With --memory, units are represented in Bytes (B), Kilobytes (K), Megabytes
1401+
(M), or Gigabytes (G). For example, `deis limit:set cmd=1G` will restrict all
1402+
"cmd" processes to a maximum of 1 Gigabyte of memory each.
1403+
1404+
With --cpu, units are represented in the number of cpu shares. For example,
1405+
`deis limit:set --cpu cmd=1024` will restrict all "cmd" processes to a
1406+
maximum of 1024 cpu shares.
14021407
14031408
Options:
14041409
-a --app=<app>
14051410
the uniquely identifiable name for the application.
1411+
-c --cpu
1412+
limits cpu shares.
1413+
-m --memory
1414+
limits memory. [default: true]
14061415
"""
14071416
app = args.get('--app')
14081417
if not app:

0 commit comments

Comments
 (0)