kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Lowercase 'Command' and 'Args' when describing "containers" specs. 

They must be lowercase in json and yaml, which is the most common
user-visible interface.

Partially addresses #1555.
reviewable/pr1832/r1
Ryan Hitchman 2016-11-30 15:10:38 -08:00
parent 978f6dc18c
commit 41caedc6d6
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/user-guide/containers.md
View File

@ -14,8 +14,8 @@ should run in a container. In this case, Kubernetes runs the image's default co
to run a particular command or override the image's defaults, there are two additional fields that to run a particular command or override the image's defaults, there are two additional fields that
we can use: we can use:
1. `Command`: Controls the actual command run by the image 1. `command`: Controls the actual command run by the image
2. `Args`: Controls the arguments passed to the command 2. `args`: Controls the arguments passed to the command
### How docker handles command and arguments ### How docker handles command and arguments
@ -28,20 +28,20 @@ fields as either a string array or a string and there are subtle differences in
handled. We encourage the curious to check out Docker's documentation for this feature. handled. We encourage the curious to check out Docker's documentation for this feature.
Kubernetes allows you to override both the image's default command (docker `Entrypoint`) and args Kubernetes allows you to override both the image's default command (docker `Entrypoint`) and args
(docker `Cmd`) with the `Command` and `Args` fields of `Container`. The rules are: (docker `Cmd`) with the `command` and `args` fields of `container`. The rules are:
1. If you do not supply a `Command` or `Args` for a container, the defaults defined by the image 1. If you do not supply a `command` or `args` for a container, the defaults defined by the image
will be used will be used.
2. If you supply a `Command` but no `Args` for a container, only the supplied `Command` will be 2. If you supply a `command` but no `args` for a container, only the supplied `command` will be
used; the image's default arguments are ignored used; the image's default arguments are ignored.
3. If you supply only `Args`, the image's default command will be used with the arguments you 3. If you supply only `args`, the image's default command will be used with the arguments you
supply supply.
4. If you supply a `Command` **and** `Args`, the image's defaults will be ignored and the values 4. If you supply a `command` **and** `args`, the image's defaults will be ignored and the values
you supply will be used you supply will be used.
Here are examples for these rules in table format Here are examples for these rules in table format
| Image `Entrypoint` | Image `Cmd` | Container `Command` | Container `Args` | Command Run | | Image `Entrypoint` | Image `Cmd` | Container `command` | Container `args` | Command Run |
|--------------------|------------------|---------------------|--------------------|------------------| |--------------------|------------------|---------------------|--------------------|------------------|
| `[/ep-1]` | `[foo bar]` | <not set> | <not set> | `[ep-1 foo bar]` | | `[/ep-1]` | `[foo bar]` | <not set> | <not set> | `[ep-1 foo bar]` |
| `[/ep-1]` | `[foo bar]` | `[/ep-2]` | <not set> | `[ep-2]` | | `[/ep-1]` | `[foo bar]` | `[/ep-2]` | <not set> | `[ep-2]` |