Commit Graph

56 Commits

Author SHA1 Message Date
ab0a17f568 Fix GitHub spelling
Signed-off-by: Frieder Bluemle <frieder.bluemle@gmail.com>
Upstream-commit: 45c9b9b6c1
Component: cli
2017-10-05 01:14:31 +08:00
c16c5f3db8 Fix repo references in docs
Since CLI was moved to a separate repo, these references are incorrect.
Fixed with the help of sed script, verified manually.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Upstream-commit: 6d85a4f5f8
Component: cli
2017-07-28 10:32:42 -07:00
6c88b7bdd9 Fix false Liquid errors
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 11c1729e00
Component: cli
2017-06-26 12:50:34 -07:00
c5eee882f2 Update CLI docs and add opts/config.go
Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: cf95e198c5
Component: cli
2017-06-02 00:11:05 +00:00
f46fcd68d4 Add hidden placeholder of .Self for docker node ls --format
This commit adds a hidden placeholder of `.Self` for
`docker node ls --format` so that if the node is the same
as the current docker daemon, then a `*` is outputed.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 45f80dccb0
Component: cli
2017-06-02 00:11:01 +00:00
b36d931653 Add --format for docker node ls
This fix tries to address the comment https://github.com/docker/docker/pull/30376#discussion_r97465334
where it was not possible to specify `--format` for `docker node ls`. The `--format` flag
is a quite useful flag that could be used in many places such as completion.

This fix implements `--format` for `docker node ls` and add `nodesFormat` in config.json
so that it is possible to specify the output when `docker node ls` is invoked.

Related documentations have been updated.

A set of unit tests have been added.

This fix is related to #30376.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 477ec9bfdd
Component: cli
2017-06-02 00:11:01 +00:00
45b7775c97 Add format to secret ls
Signed-off-by: Boaz Shuster <ripcurld.github@gmail.com>
Upstream-commit: 33166e3364
Component: cli
2017-06-02 00:10:58 +00:00
fec035ef1b remove Jekyll tags from CLI reference
These Markdown files are now embedded in a YAML
file for templating in the documentation, and
these special markers are no longer needed.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 8e7dd976f8
Component: cli
2017-06-02 00:10:56 +00:00
2cc38cf538 fix the type
Signed-off-by: yupengzte <yu.peng36@zte.com.cn>
Upstream-commit: 6f3f9e384c
Component: cli
2017-06-02 00:10:55 +00:00
020523b38b Standardized formatting of CLI reference commands
Command name should be a H1

Only Description, Examples, and Related Commands should be H2

Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands

Added some examples where relevant

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: ddadd3db49
Component: cli
2017-06-02 00:10:53 +00:00
89a3d2f832 Add --format to docker service ls
This fix tries to improve the display of `docker service ls`
and adds `--format` flag to `docker service ls`.

In addition to `--format` flag, several other improvement:
1. Updates `docker stacks service`.
2. Adds `servicesFormat` to config file.

Related docs has been updated.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 7d3b3fda0d
Component: cli
2017-06-02 00:10:52 +00:00
e5776e6e26 Add --format flag for docker plugin ls
This fix tries to address the enhancement discussed in 28735 to add
`--format` for the output of `docker plugin ls`.

This fix
1. Add `--format` and `--quiet` flags to `docker plugin ls`
2. Convert the current implementation to use `formatter`, consistent with
   other docker list commands.
3. Add `pluginsFormat` for config.json.

Related docs has been updated.

Several unit tests have been added to cover the changes.

This fix is related to 28708 and 28735.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: d36dd6541a
Component: cli
2017-06-02 00:10:49 +00:00
2362df6877 document DOCKER_HIDE_LEGACY_COMMANDS env-var
The `DOCKER_HIDE_LEGACY_COMMANDS` environment
variable was added in a7c8bcac2ba60d6dd25a1157085d9245bed556ce
but not documented.

This adds the variable to the documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 8d4ea9f2cf
Component: cli
2017-06-02 00:10:47 +00:00
857189b456 Add credential helper documentation
Signed-off-by: Jake Sanders <jsand@google.com>
Upstream-commit: 5ee07f7a96
Component: cli
2017-06-02 00:10:43 +00:00
4a1fdf9cf7 Add options for docker plugin enable and fix some typos
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: eff40eda38
Component: cli
2017-06-02 00:10:40 +00:00
17f22ba07a Align arg with other cli
Signed-off-by: yupeng <yu.peng36@zte.com.cn>
Upstream-commit: f5298c5f4d
Component: cli
2017-06-02 00:10:32 +00:00
35146fe359 fix frontmatter keywords value type (string, instead of []string) in /docs/reference
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
Upstream-commit: 572c6bb89a
Component: cli
2017-06-02 00:10:31 +00:00
b2f1abe039 Add for String
Signed-off-by: yupeng <yu.peng36@zte.com.cn>
Upstream-commit: af5af201fe
Component: cli
2017-06-02 00:10:31 +00:00
c34aa02124 Add StatsFormat to the config.json file
As for `ps`, `images`, `network ls` and `volume ls`, this makes it
possible to define a custom default format.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: ec318edf12
Component: cli
2017-06-02 00:10:31 +00:00
118bce70c4 Sync docker/docker refs with files mistakenly edited in docker.github.io repo
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 7f36c3a1a0
Component: cli
2017-06-02 00:10:26 +00:00
6565e2a727 Remove invalid installtion content because there is no corresponding files
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
Upstream-commit: 2160c366b8
Component: cli
2017-06-02 00:10:25 +00:00
fbc93c2df5 Convert Markdown frontmatter to YAML
Some frontmatter such as the weights, menu stuff, etc is no longer used
'draft=true' becomes 'published: false'

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 2845676cc2
Component: cli
2017-06-02 00:10:24 +00:00
66bfa1a740 Improve --log-level help text
This information was added in
1efc940e6f547760e5e8f4648acb120ff19fdc58,
but removed again in
a271eaeba224652e3a12af0287afbae6f82a9333
to make the help-output fit in a 80-chars
terminal.

This adds the available options again
in the help output, and updates the CLI
reference documentation to match actual
output.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: db0cbdff04
Component: cli
2017-06-02 00:10:13 +00:00
8d024268f5 Add formatter for service inspect
Allows the user to use `pretty` as the format string.
This enables users to put custom format options into their CLI config
just like is supported for `docker ps` and `docker images`

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
Upstream-commit: 347ce7aad3
Component: cli
2017-06-02 00:10:11 +00:00
dcf229693f add option and update the description
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: d0e704b31d
Component: cli
2017-06-02 00:10:10 +00:00
3186a9c551 Remove -h option for docker cli
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: 1d481e22fc
Component: cli
2017-06-02 00:10:08 +00:00
177af81c48 Updates on cli reference documentation
- Update ps with `--last` flag
- Update commands with current output
- Make sure hugo does not detect the wrong language
- Update usage for `tag` command to be more coherent with the other ones

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 3ebe3fe752
Component: cli
2017-06-02 00:07:49 +00:00
2b9f9a9ded docs: add $ before HOME
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
Upstream-commit: d437e32541
Component: cli
2017-06-02 00:07:31 +00:00
6a4922373b Revert "resolve the config file from the sudo user"
This reverts commit afde6450ee7bd4a43765fdc0a9799b411276d9e4.

Signed-off-by: Antonio Murdaca <runcom@redhat.com>
Upstream-commit: 4d6a232fc0
Component: cli
2017-06-02 00:07:30 +00:00
ee3bdc6ec8 resolve the config file from the sudo user
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
Upstream-commit: b610528a6a
Component: cli
2017-06-02 00:07:30 +00:00
6240dc18ff Fix mention of at sign in docs
The at sign (`@`) was being referred to in the documentation as an
ampersand (`&`).

Signed-off-by: Tom X. Tobin <tomxtobin@tomxtobin.com>
Upstream-commit: aa46699081
Component: cli
2017-06-02 00:07:28 +00:00
89105f6e4c Document that detach keys are a list of key bindings
Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: 775e7a02a3
Component: cli
2017-06-02 00:07:24 +00:00
7c4710c371 Implement configurable detach key
Implement configurable detach keys (for `attach`, exec`, `run` and
`start`) using the client-side configuration

- Adds a `--detach-keys` flag to `attach`, `exec`, `run` and `start`
  commands.
- Adds a new configuration field (in `~/.docker/config.json`) to
  configure the default escape keys for docker client.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 18eb9f2e64
Component: cli
2017-06-02 00:07:22 +00:00
736589dc45 Add --format support to images command
- rename `api/client/ps` to `api/client/formatter`
- add a a image formatter

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 1e3c5bbe15
Component: cli
2017-06-02 00:07:21 +00:00
dcace8d27d Add a DOCKER_API_VERSION env var
Closes: #11486

Just for @ahmetalpbalkan  :-)

Fixed some comment formatting too while in there.

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 8b3b2571d7
Component: cli
2017-06-02 00:07:20 +00:00
6d7ca0ef19 Fixes found by docs validation tool
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: d63c19c4ea
Component: cli
2017-06-02 00:07:18 +00:00
e5cbd3704c more notary documentation
Signed-off-by: Viktor Stanchev <me@viktorstanchev.com>
Upstream-commit: cfe0fadee2
Component: cli
2017-06-02 00:07:16 +00:00
80cce1f5ce Deprecate -c cli short variant flag in docker cli
- build
- create

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 4c506e1df7
Component: cli
2017-06-02 00:07:13 +00:00
fb5c95b1a3 Default the tcp port to 2376 if tls is on, and 2375 if not
Refactor so that the Host flag validation doesn't destroy the user's input,
and then post process the flags when we know the TLS options

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 0095e6fc23
Component: cli
2017-06-02 00:07:12 +00:00
d4f3c46baf Enabled GitHub Flavored Markdown
GitHub flavored markdown is now supported for links and images. Also, ran LinkChecker and FileResolver. Yay!
Fixes from Spider check
Output for docker/docker now goes into engine directory

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: e641a0f363
Component: cli
2017-06-02 00:07:12 +00:00
f33e7e36a6 Fixing issues in command ordering. Adding index.md
Adjust bullets
Entering Seb's comments

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: d45666f869
Component: cli
2017-06-02 00:07:11 +00:00
32fd4e2f42 Remove -h flag from completion and daemon reference
All docker subcommands support `-h` as an alias for `--help`
unless they have `-h` aliased to something else like `docker run`,
which uses `-h` for `--hostname`.

`-h` is not included in the help messages of the commands, though.

It ist visible in
* reference: only in `docker daemon` reference,
  see output of `grep -Rse --help=false docs`
* man pages: only in `docker` man page
  see output of `grep -RF '**-h**' man`

For consistency reasons, this commit removes `-h` as an alias for
`--help` from the reference page, man page and the bash completion.

Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: 91300d7db0
Component: cli
2017-06-02 00:07:05 +00:00
cca08cfd4e - Remove references to sudo in basics.md; see sudo instructions top of file
- Removing references to Boot2Docker replacing with Docker Machine
- Removing sudo warnings in instances where appropriate (no sudo in file)
- Updating with comments

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: 8bd8ac0170
Component: cli
2017-06-02 00:07:04 +00:00
6faa369765 Fix typo in JSON config example, in the CLI documetation
Signed-off-by: Michał Czeraszkiewicz <czerasz.hosting@gmail.com>
Upstream-commit: d0b639feb0
Component: cli
2017-06-02 00:07:03 +00:00
88f42b2275 Rename to flags and environment variables to content trust
Update help line to allow 90 characters instead of 80

The trust flag pushes out the help description column wider, requiring more room to display help messages.

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
Upstream-commit: 57094eec6e
Component: cli
2017-06-02 00:07:03 +00:00
692c177a60 Add cmdline docs for signing and verification flows
Signed-off-by: Nathan McCauley <nathan.mccauley@docker.com>
Upstream-commit: 53d11aa48e
Component: cli
2017-06-02 00:07:03 +00:00
61b854bffc Update docs to use the new docker daemon command
Signed-off-by: Tibor Vass <tibor@docker.com>
Upstream-commit: a79a020ed7
Component: cli
2017-06-02 00:07:03 +00:00
7317401756 ps --format: Add config.js doc, fix gofmt, add integration tests
Re-add the docs from @calavera's PR to the moved cli cmd reference docs.
Fix gofmt and vet issues from carried commits
Add integration test for using format with --no-trunc and multi-names
Fix custom_test map order dependency on expected value check
Add docs to reference/commandline/ps.md
Remove "-F" flag option from original carried PR content

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp)
Upstream-commit: 5f2fd60890
Component: cli
2017-06-02 00:07:02 +00:00
2f100155de Add support for DOCKER_CONFIG/--config to specific config file dir
Carry #11675

Aside from what #11675 says, to me a key usecase for this is to support
more than one Docker cli running at the same time but each may have its
own set of config files.

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 408d7deaf7
Component: cli
2017-06-02 00:07:01 +00:00
36c7167e96 Splitting out the cli command into parts.
Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: 4f9fac3803
Component: cli
2017-06-02 00:06:59 +00:00