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>
This commit is contained in:
Misty Stanley-Jones 2016-10-14 15:30:36 -07:00 committed by Tibor Vass
parent 12a3920153
commit 2845676cc2
104 changed files with 581 additions and 1012 deletions

View File

@ -1,14 +1,9 @@
<!--[metadata]> ---
+++ aliases: ["/engine/misc/deprecated/"]
aliases = ["/engine/misc/deprecated/"] title: "Deprecated Engine Features"
title = "Deprecated Engine Features" description: "Deprecated Features."
description = "Deprecated Features." keywords: ["docker, documentation, about, technology, deprecate"]
keywords = ["docker, documentation, about, technology, deprecate"] ---
[menu.main]
parent = "engine_use"
weight=80
+++
<![end-metadata]-->
# Deprecated Engine Features # Deprecated Engine Features
@ -192,7 +187,7 @@ The single-dash (`-help`) was removed, in favor of the double-dash `--help`
**Removed In Release: [v1.13.0](https://github.com/docker/docker/releases/)** **Removed In Release: [v1.13.0](https://github.com/docker/docker/releases/)**
The flag `--run` of the docker commit (and its short version `-run`) were deprecated in favor The flag `--run` of the docker commit (and its short version `-run`) were deprecated in favor
of the `--changes` flag that allows to pass `Dockerfile` commands. of the `--changes` flag that allows to pass `Dockerfile` commands.

View File

@ -1,17 +1,12 @@
<!--[metadata]> ---
+++ aliases: [
aliases = [
"/engine/extend/" "/engine/extend/"
] ]
title = "Managed plugin system" title: "Managed plugin system"
description = "How develop and use a plugin with the managed plugin system" description: "How develop and use a plugin with the managed plugin system"
keywords = ["API, Usage, plugins, documentation, developer"] keywords: ["API, Usage, plugins, documentation, developer"]
advisory = "experimental" advisory: "experimental"
[menu.main] ---
parent = "engine_extend"
weight=1
+++
<![end-metadata]-->
# Docker Engine managed plugin system # Docker Engine managed plugin system

View File

@ -1,14 +1,9 @@
<!--[metadata]> ---
+++ aliases: "/engine/extend/plugins/"
aliases = "/engine/extend/plugins/" title: "Use Docker Engine plugins"
title = "Use Docker Engine plugins" description: "How to add additional functionality to Docker with plugins extensions"
description = "How to add additional functionality to Docker with plugins extensions" keywords: ["Examples, Usage, plugins, docker, documentation, user guide"]
keywords = ["Examples, Usage, plugins, docker, documentation, user guide"] ---
[menu.main]
parent = "engine_extend"
weight=3
+++
<![end-metadata]-->
# Use Docker Engine plugins # Use Docker Engine plugins

View File

@ -1,17 +1,12 @@
<!--[metadata]> ---
+++ aliases: [
aliases = [
"/engine/extend/" "/engine/extend/"
] ]
title = "Plugin manifest" title: "Plugin manifest"
description = "How develop and use a plugin with the managed plugin system" description: "How develop and use a plugin with the managed plugin system"
keywords = ["API, Usage, plugins, documentation, developer"] keywords: ["API, Usage, plugins, documentation, developer"]
advisory = "experimental" advisory: "experimental"
[menu.main] ---
parent = "engine_extend"
weight=1
+++
<![end-metadata]-->
# Plugin Manifest Version 0 of Plugin V2 # Plugin Manifest Version 0 of Plugin V2
@ -47,7 +42,7 @@ Manifest provides the base accessible fields for working with V0 plugin format
- **`interface`** *PluginInterface* - **`interface`** *PluginInterface*
interface implemented by the plugins, struct consisting of the following fields interface implemented by the plugins, struct consisting of the following fields
- **`types`** *string array* - **`types`** *string array*
types indicate what interface(s) the plugin currently implements. types indicate what interface(s) the plugin currently implements.
@ -55,9 +50,9 @@ Manifest provides the base accessible fields for working with V0 plugin format
currently supported: currently supported:
- **docker.volumedriver/1.0** - **docker.volumedriver/1.0**
- **`socket`** *string* - **`socket`** *string*
socket is the name of the socket the engine should use to communicate with the plugins. socket is the name of the socket the engine should use to communicate with the plugins.
the socket will be created in `/run/docker/plugins`. the socket will be created in `/run/docker/plugins`.
@ -73,7 +68,7 @@ Manifest provides the base accessible fields for working with V0 plugin format
- **`network`** *PluginNetwork* - **`network`** *PluginNetwork*
network of the plugin, struct consisting of the following fields network of the plugin, struct consisting of the following fields
- **`type`** *string* - **`type`** *string*
network type. network type.
@ -83,11 +78,11 @@ Manifest provides the base accessible fields for working with V0 plugin format
- **bridge** - **bridge**
- **host** - **host**
- **none** - **none**
- **`capabilities`** *array* - **`capabilities`** *array*
capabilities of the plugin (*Linux only*), see list [`here`](https://github.com/opencontainers/runc/blob/master/libcontainer/SPEC.md#security) capabilities of the plugin (*Linux only*), see list [`here`](https://github.com/opencontainers/runc/blob/master/libcontainer/SPEC.md#security)
- **`mounts`** *PluginMount array* - **`mounts`** *PluginMount array*
mount of the plugin, struct consisting of the following fields, see [`MOUNTS`](https://github.com/opencontainers/runtime-spec/blob/master/config.md#mounts) mount of the plugin, struct consisting of the following fields, see [`MOUNTS`](https://github.com/opencontainers/runtime-spec/blob/master/config.md#mounts)
@ -95,27 +90,27 @@ Manifest provides the base accessible fields for working with V0 plugin format
- **`name`** *string* - **`name`** *string*
name of the mount. name of the mount.
- **`description`** *string* - **`description`** *string*
description of the mount. description of the mount.
- **`source`** *string* - **`source`** *string*
source of the mount. source of the mount.
- **`destination`** *string* - **`destination`** *string*
destination of the mount. destination of the mount.
- **`type`** *string* - **`type`** *string*
mount type. mount type.
- **`options`** *string array* - **`options`** *string array*
options of the mount. options of the mount.
- **`devices`** *PluginDevice array* - **`devices`** *PluginDevice array*
device of the plugin, (*Linux only*), struct consisting of the following fields, see [`DEVICES`](https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#devices) device of the plugin, (*Linux only*), struct consisting of the following fields, see [`DEVICES`](https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#devices)
@ -123,11 +118,11 @@ Manifest provides the base accessible fields for working with V0 plugin format
- **`name`** *string* - **`name`** *string*
name of the device. name of the device.
- **`description`** *string* - **`description`** *string*
description of the device. description of the device.
- **`path`** *string* - **`path`** *string*
path of the device. path of the device.
@ -139,15 +134,15 @@ Manifest provides the base accessible fields for working with V0 plugin format
- **`name`** *string* - **`name`** *string*
name of the env. name of the env.
- **`description`** *string* - **`description`** *string*
description of the env. description of the env.
- **`value`** *string* - **`value`** *string*
value of the env. value of the env.
- **`args`** *PluginArgs* - **`args`** *PluginArgs*
args of the plugin, struct consisting of the following fields args of the plugin, struct consisting of the following fields
@ -155,16 +150,16 @@ Manifest provides the base accessible fields for working with V0 plugin format
- **`name`** *string* - **`name`** *string*
name of the env. name of the env.
- **`description`** *string* - **`description`** *string*
description of the env. description of the env.
- **`value`** *string array* - **`value`** *string array*
values of the args. values of the args.
## Example Manifest ## Example Manifest
*Example showing the 'tiborvass/no-remove' plugin manifest.* *Example showing the 'tiborvass/no-remove' plugin manifest.*

View File

@ -1,15 +1,10 @@
<!--[metadata]> ---
+++ title: "Implement plugins"
title = "Implement plugins" description: "Develop plugins and use existing plugins for Docker Engine"
description = "Develop plugins and use existing plugins for Docker Engine" keywords: ["extend, plugins, docker, documentation, developer"]
keywords = ["extend, plugins, docker, documentation, developer"] type: "menu"
type="menu" identifier: "engine_extend"
[menu.main] ---
identifier = "engine_extend"
parent="engine_use"
weight = 0
+++
<![end-metadata]-->
<!--menu page not rendered--> <!--menu page not rendered-->

View File

@ -1,13 +1,8 @@
<!--[metadata]> ---
+++ title: "Plugins API"
title = "Plugins API" description: "How to write Docker plugins extensions "
description = "How to write Docker plugins extensions " keywords: ["API, Usage, plugins, documentation, developer"]
keywords = ["API, Usage, plugins, documentation, developer"] ---
[menu.main]
parent = "engine_extend"
weight=7
+++
<![end-metadata]-->
# Docker Plugin API # Docker Plugin API

View File

@ -1,14 +1,9 @@
<!--[metadata]> ---
+++ title: "Access authorization plugin"
title = "Access authorization plugin" description: "How to create authorization plugins to manage access control to your Docker daemon."
description = "How to create authorization plugins to manage access control to your Docker daemon." keywords: ["security, authorization, authentication, docker, documentation, plugin, extend"]
keywords = ["security, authorization, authentication, docker, documentation, plugin, extend"] aliases: ["/engine/extend/authorization/"]
aliases = ["/engine/extend/authorization/"] ---
[menu.main]
parent = "engine_extend"
weight = 4
+++
<![end-metadata]-->
# Create an authorization plugin # Create an authorization plugin

View File

@ -1,13 +1,8 @@
<!--[metadata]> ---
+++ title: "Docker network driver plugins"
title = "Docker network driver plugins" description: "Network driver plugins."
description = "Network driver plugins." keywords: ["Examples, Usage, plugins, docker, documentation, user guide"]
keywords = ["Examples, Usage, plugins, docker, documentation, user guide"] ---
[menu.main]
parent = "engine_extend"
weight=5
+++
<![end-metadata]-->
# Engine network driver plugins # Engine network driver plugins

View File

@ -1,13 +1,8 @@
<!--[metadata]> ---
+++ title: "Volume plugins"
title = "Volume plugins" description: "How to manage data with external volume plugins"
description = "How to manage data with external volume plugins" keywords: ["Examples, Usage, volume, docker, data, volumes, plugin, api"]
keywords = ["Examples, Usage, volume, docker, data, volumes, plugin, api"] ---
[menu.main]
parent = "engine_extend"
weight=6
+++
<![end-metadata]-->
# Write a volume plugin # Write a volume plugin

View File

@ -1,13 +1,8 @@
<!--[metadata]> ---
+++ title: "Dockerfile reference"
title = "Dockerfile reference" description: "Dockerfiles use a simple DSL which allows you to automate the steps you would normally manually take to create an image."
description = "Dockerfiles use a simple DSL which allows you to automate the steps you would normally manually take to create an image." keywords: ["builder, docker, Dockerfile, automation, image creation"]
keywords = ["builder, docker, Dockerfile, automation, image creation"] ---
[menu.main]
parent = "engine_ref"
weight=-90
+++
<![end-metadata]-->
# Dockerfile reference # Dockerfile reference
@ -698,7 +693,7 @@ To view an image's labels, use the `docker inspect` command.
MAINTAINER <name> MAINTAINER <name>
The `MAINTAINER` instruction sets the *Author* field of the generated images. The `MAINTAINER` instruction sets the *Author* field of the generated images.
The `LABEL` instruction is a much more flexible version of this and you should use The `LABEL` instruction is a much more flexible version of this and you should use
it instead, as it enables setting any metadata you require, and can be viewed it instead, as it enables setting any metadata you require, and can be viewed
easily, for example with `docker inspect`. To set a label corresponding to the easily, for example with `docker inspect`. To set a label corresponding to the

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "attach"
title = "attach" description: "The attach command description and usage"
description = "The attach command description and usage" keywords: ["attach, running, container"]
keywords = ["attach, running, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# attach # attach

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "build"
title = "build" description: "The build command description and usage"
description = "The build command description and usage" keywords: ["build, docker, image"]
keywords = ["build, docker, image"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# build # build

View File

@ -1,13 +1,8 @@
<!--[metadata]> ---
+++ title: "Use the Docker command line"
title = "Use the Docker command line" description: "Docker's CLI command description and usage"
description = "Docker's CLI command description and usage" keywords: ["Docker, Docker documentation, CLI, command line"]
keywords = ["Docker, Docker documentation, CLI, command line"] ---
[menu.main]
parent = "smn_cli"
weight = -2
+++
<![end-metadata]-->
# Use the Docker command line # Use the Docker command line
@ -122,7 +117,7 @@ directives, see the
Once attached to a container, users detach from it and leave it running using Once attached to a container, users detach from it and leave it running using
the using `CTRL-p CTRL-q` key sequence. This detach key sequence is customizable the using `CTRL-p CTRL-q` key sequence. This detach key sequence is customizable
using the `detachKeys` property. Specify a `<sequence>` value for the using the `detachKeys` property. Specify a `<sequence>` value for the
property. The format of the `<sequence>` is a comma-separated list of either property. The format of the `<sequence>` is a comma-separated list of either
a letter [a-Z], or the `ctrl-` combined with any of the following: a letter [a-Z], or the `ctrl-` combined with any of the following:
* `a-z` (a single lowercase alpha character ) * `a-z` (a single lowercase alpha character )

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "commit"
title = "commit" description: "The commit command description and usage"
description = "The commit command description and usage" keywords: ["commit, file, changes"]
keywords = ["commit, file, changes"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# commit # commit

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "container prune"
title = "container prune" description: "Remove all stopped containers"
description = "Remove all stopped containers" keywords: [container, prune, delete, remove]
keywords = [container, prune, delete, remove] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# container prune # container prune

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "cp"
title = "cp" description: "The cp command description and usage"
description = "The cp command description and usage" keywords: ["copy, container, files, folders"]
keywords = ["copy, container, files, folders"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# cp # cp

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "create"
title = "create" description: "The create command description and usage"
description = "The create command description and usage" keywords: ["docker, create, container"]
keywords = ["docker, create, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# create # create

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "deploy"
title = "deploy" description: "The deploy command description and usage"
description = "The deploy command description and usage" keywords: ["stack, deploy"]
keywords = ["stack, deploy"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# stack deploy (experimental) # stack deploy (experimental)

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "diff"
title = "diff" description: "The diff command description and usage"
description = "The diff command description and usage" keywords: ["list, changed, files, container"]
keywords = ["list, changed, files, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# diff # diff

View File

@ -1,14 +1,9 @@
<!--[metadata]> ---
+++ title: "dockerd"
title = "dockerd" aliases: ["/engine/reference/commandline/daemon/"]
aliases = ["/engine/reference/commandline/daemon/"] description: "The daemon command description and usage"
description = "The daemon command description and usage" keywords: ["container, daemon, runtime"]
keywords = ["container, daemon, runtime"] ---
[menu.main]
parent = "smn_cli"
weight = -1
+++
<![end-metadata]-->
# daemon # daemon

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "events"
title = "events" description: "The events command description and usage"
description = "The events command description and usage" keywords: ["events, container, report"]
keywords = ["events, container, report"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# events # events

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "exec"
title = "exec" description: "The exec command description and usage"
description = "The exec command description and usage" keywords: ["command, container, run, execute"]
keywords = ["command, container, run, execute"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# exec # exec

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "export"
title = "export" description: "The export command description and usage"
description = "The export command description and usage" keywords: ["export, file, system, container"]
keywords = ["export, file, system, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# export # export

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "history"
title = "history" description: "The history command description and usage"
description = "The history command description and usage" keywords: ["docker, image, history"]
keywords = ["docker, image, history"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# history # history

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "image prune"
title = "image prune" description: "Remove all stopped images"
description = "Remove all stopped images" keywords: [image, prune, delete, remove]
keywords = [image, prune, delete, remove] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# image prune # image prune

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "images"
title = "images" description: "The images command description and usage"
description = "The images command description and usage" keywords: ["list, docker, images"]
keywords = ["list, docker, images"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# images # images

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "import"
title = "import" description: "The import command description and usage"
description = "The import command description and usage" keywords: ["import, file, system, container"]
keywords = ["import, file, system, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# import # import

View File

@ -1,14 +1,9 @@
<!-- [metadata]> ---
+++ title: "Docker commands"
title = "Docker commands" description: "Docker's CLI command description and usage"
description = "Docker's CLI command description and usage" keywords: ["Docker, Docker documentation, CLI, command line"]
keywords = ["Docker, Docker documentation, CLI, command line"] identifier: "smn_cli_guide"
[menu.main] ---
identifier= "smn_cli_guide"
parent = "smn_cli"
weight=-70
+++
<![end-metadata]-->

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "info"
title = "info" description: "The info command description and usage"
description = "The info command description and usage" keywords: ["display, docker, information"]
keywords = ["display, docker, information"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# info # info

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "inspect"
title = "inspect" description: "The inspect command description and usage"
description = "The inspect command description and usage" keywords: ["inspect, container, json"]
keywords = ["inspect, container, json"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# inspect # inspect

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "kill"
title = "kill" description: "The kill command description and usage"
description = "The kill command description and usage" keywords: ["container, kill, signal"]
keywords = ["container, kill, signal"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# kill # kill

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "load"
title = "load" description: "The load command description and usage"
description = "The load command description and usage" keywords: ["stdin, tarred, repository"]
keywords = ["stdin, tarred, repository"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# load # load

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "login"
title = "login" description: "The login command description and usage"
description = "The login command description and usage" keywords: ["registry, login, image"]
keywords = ["registry, login, image"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# login # login

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "logout"
title = "logout" description: "The logout command description and usage"
description = "The logout command description and usage" keywords: ["logout, docker, registry"]
keywords = ["logout, docker, registry"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# logout # logout

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "logs"
title = "logs" description: "The logs command description and usage"
description = "The logs command description and usage" keywords: ["logs, retrieve, docker"]
keywords = ["logs, retrieve, docker"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# logs # logs

View File

@ -1,14 +1,9 @@
<!-- [metadata]> ---
+++ title: "Command line reference"
title = "Command line reference" description: "Docker's CLI command description and usage"
description = "Docker's CLI command description and usage" keywords: ["Docker, Docker documentation, CLI, command line"]
keywords = ["Docker, Docker documentation, CLI, command line"] identifier: "smn_cli"
[menu.main] ---
identifier= "smn_cli"
parent = "engine_ref"
weight=-75
+++
<![end-metadata]-->

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "network connect"
title = "network connect" description: "The network connect command description and usage"
description = "The network connect command description and usage" keywords: ["network, connect, user-defined"]
keywords = ["network, connect, user-defined"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# network connect # network connect

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "network create"
title = "network create" description: "The network create command description and usage"
description = "The network create command description and usage" keywords: ["network, create"]
keywords = ["network, create"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# network create # network create

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "network disconnect"
title = "network disconnect" description: "The network disconnect command description and usage"
description = "The network disconnect command description and usage" keywords: ["network, disconnect, user-defined"]
keywords = ["network, disconnect, user-defined"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# network disconnect # network disconnect

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "network inspect"
title = "network inspect" description: "The network inspect command description and usage"
description = "The network inspect command description and usage" keywords: ["network, inspect, user-defined"]
keywords = ["network, inspect, user-defined"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# network inspect # network inspect

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "network ls"
title = "network ls" description: "The network ls command description and usage"
description = "The network ls command description and usage" keywords: ["network, list, user-defined"]
keywords = ["network, list, user-defined"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# docker network ls # docker network ls

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "network rm"
title = "network rm" description: "the network rm command description and usage"
description = "the network rm command description and usage" keywords: ["network, rm, user-defined"]
keywords = ["network, rm, user-defined"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# network rm # network rm

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "node demote"
title = "node demote" description: "The node demote command description and usage"
description = "The node demote command description and usage" keywords: ["node, demote"]
keywords = ["node, demote"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# node demote # node demote

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "node inspect"
title = "node inspect" description: "The node inspect command description and usage"
description = "The node inspect command description and usage" keywords: ["node, inspect"]
keywords = ["node, inspect"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# node inspect # node inspect

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "node ls"
title = "node ls" description: "The node ls command description and usage"
description = "The node ls command description and usage" keywords: ["node, list"]
keywords = ["node, list"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# node ls # node ls

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "node promote"
title = "node promote" description: "The node promote command description and usage"
description = "The node promote command description and usage" keywords: ["node, promote"]
keywords = ["node, promote"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# node promote # node promote

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "node ps"
title = "node ps" description: "The node ps command description and usage"
description = "The node ps command description and usage" keywords: ["node, tasks", "ps"]
keywords = ["node, tasks", "ps"] aliases: ["/engine/reference/commandline/node_tasks/"]
aliases = ["/engine/reference/commandline/node_tasks/"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# node ps # node ps

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "node rm"
title = "node rm" description: "The node rm command description and usage"
description = "The node rm command description and usage" keywords: ["node, remove"]
keywords = ["node, remove"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# node rm # node rm

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "node update"
title = "node update" description: "The node update command description and usage"
description = "The node update command description and usage" keywords: ["resources, update, dynamically"]
keywords = ["resources, update, dynamically"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
## update ## update

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "pause"
title = "pause" description: "The pause command description and usage"
description = "The pause command description and usage" keywords: ["cgroups, container, suspend, SIGSTOP"]
keywords = ["cgroups, container, suspend, SIGSTOP"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# pause # pause

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "plugin disable"
title = "plugin disable" description: "the plugin disable command description and usage"
description = "the plugin disable command description and usage" keywords: ["plugin, disable"]
keywords = ["plugin, disable"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# plugin disable (experimental) # plugin disable (experimental)

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "plugin enable"
title = "plugin enable" description: "the plugin enable command description and usage"
description = "the plugin enable command description and usage" keywords: ["plugin, enable"]
keywords = ["plugin, enable"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# plugin enable (experimental) # plugin enable (experimental)

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "plugin inspect"
title = "plugin inspect" description: "The plugin inspect command description and usage"
description = "The plugin inspect command description and usage" keywords: ["plugin, inspect"]
keywords = ["plugin, inspect"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# plugin inspect (experimental) # plugin inspect (experimental)

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "plugin install"
title = "plugin install" description: "the plugin install command description and usage"
description = "the plugin install command description and usage" keywords: ["plugin, install"]
keywords = ["plugin, install"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# plugin install (experimental) # plugin install (experimental)

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "plugin ls"
title = "plugin ls" description: "The plugin ls command description and usage"
description = "The plugin ls command description and usage" keywords: ["plugin, list"]
keywords = ["plugin, list"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# plugin ls (experimental) # plugin ls (experimental)

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "plugin rm"
title = "plugin rm" description: "the plugin rm command description and usage"
description = "the plugin rm command description and usage" keywords: ["plugin, rm"]
keywords = ["plugin, rm"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# plugin rm (experimental) # plugin rm (experimental)

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "port"
title = "port" description: "The port command description and usage"
description = "The port command description and usage" keywords: ["port, mapping, container"]
keywords = ["port, mapping, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# port # port

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "ps"
title = "ps" description: "The ps command description and usage"
description = "The ps command description and usage" keywords: ["container, running, list"]
keywords = ["container, running, list"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# ps # ps

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "pull"
title = "pull" description: "The pull command description and usage"
description = "The pull command description and usage" keywords: ["pull, image, hub, docker"]
keywords = ["pull, image, hub, docker"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# pull # pull

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "push"
title = "push" description: "The push command description and usage"
description = "The push command description and usage" keywords: ["share, push, image"]
keywords = ["share, push, image"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# push # push

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "rename"
title = "rename" description: "The rename command description and usage"
description = "The rename command description and usage" keywords: ["rename, docker, container"]
keywords = ["rename, docker, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# rename # rename

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "restart"
title = "restart" description: "The restart command description and usage"
description = "The restart command description and usage" keywords: ["restart, container, Docker"]
keywords = ["restart, container, Docker"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# restart # restart

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "rm"
title = "rm" description: "The rm command description and usage"
description = "The rm command description and usage" keywords: ["remove, Docker, container"]
keywords = ["remove, Docker, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# rm # rm

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "rmi"
title = "rmi" description: "The rmi command description and usage"
description = "The rmi command description and usage" keywords: ["remove, image, Docker"]
keywords = ["remove, image, Docker"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# rmi # rmi

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "run"
title = "run" description: "The run command description and usage"
description = "The run command description and usage" keywords: ["run, command, container"]
keywords = ["run, command, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# run # run

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "save"
title = "save" description: "The save command description and usage"
description = "The save command description and usage" keywords: ["tarred, repository, backup"]
keywords = ["tarred, repository, backup"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# save # save

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "search"
title = "search" description: "The search command description and usage"
description = "The search command description and usage" keywords: ["search, hub, images"]
keywords = ["search, hub, images"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# search # search

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "service create"
title = "service create" description: "The service create command description and usage"
description = "The service create command description and usage" keywords: ["service, create"]
keywords = ["service, create"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# service create # service create

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "service inspect"
title = "service inspect" description: "The service inspect command description and usage"
description = "The service inspect command description and usage" keywords: ["service, inspect"]
keywords = ["service, inspect"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# service inspect # service inspect

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "service ls"
title = "service ls" description: "The service ls command description and usage"
description = "The service ls command description and usage" keywords: ["service, ls"]
keywords = ["service, ls"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# service ls # service ls

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "service ps"
title = "service ps" description: "The service ps command description and usage"
description = "The service ps command description and usage" keywords: ["service, tasks", "ps"]
keywords = ["service, tasks", "ps"] aliases: ["/engine/reference/commandline/service_tasks/"]
aliases = ["/engine/reference/commandline/service_tasks/"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# service ps # service ps

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "service rm"
title = "service rm" description: "The service rm command description and usage"
description = "The service rm command description and usage" keywords: ["service, rm"]
keywords = ["service, rm"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# service rm # service rm

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "service scale"
title = "service scale" description: "The service scale command description and usage"
description = "The service scale command description and usage" keywords: ["service, scale"]
keywords = ["service, scale"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# service scale # service scale

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "service update"
title = "service update" description: "The service update command description and usage"
description = "The service update command description and usage" keywords: ["service, update"]
keywords = ["service, update"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# service update # service update

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "stack config"
title = "stack config" description: "The stack config command description and usage"
description = "The stack config command description and usage" keywords: ["stack, config"]
keywords = ["stack, config"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# stack config (experimental) # stack config (experimental)

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "stack deploy"
title = "stack deploy" description: "The stack deploy command description and usage"
description = "The stack deploy command description and usage" keywords: ["stack, deploy, up"]
keywords = ["stack, deploy, up"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# stack deploy (experimental) # stack deploy (experimental)

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "stack ls"
title = "stack ls" description: "The stack ls command description and usage"
description = "The stack ls command description and usage" keywords: ["stack, ls"]
keywords = ["stack, ls"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# stack ls (experimental) # stack ls (experimental)

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "stack ps"
title = "stack ps" description: "The stack ps command description and usage"
description = "The stack ps command description and usage" keywords: ["stack, ps"]
keywords = ["stack, ps"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# stack ps (experimental) # stack ps (experimental)

View File

@ -1,13 +1,11 @@
<!--[metadata]> ---
+++ title: "stack rm"
title = "stack rm" description: "The stack rm command description and usage"
description = "The stack rm command description and usage" keywords: ["stack, rm, remove, down"]
keywords = ["stack, rm, remove, down"] advisory: "experimental"
advisory = "experimental"
[menu.main]
parent = "smn_cli" ---
+++
<![end-metadata]-->
# stack rm (experimental) # stack rm (experimental)

View File

@ -1,13 +1,9 @@
<!--[metadata]> ---
+++ title: "stack services"
title = "stack services" description: "The stack services command description and usage"
description = "The stack services command description and usage" keywords: ["stack, services"]
keywords = ["stack, services"] advisory: "experimental"
advisory = "experimental" ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# stack services (experimental) # stack services (experimental)

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "start"
title = "start" description: "The start command description and usage"
description = "The start command description and usage" keywords: ["Start, container, stopped"]
keywords = ["Start, container, stopped"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# start # start

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "stats"
title = "stats" description: "The stats command description and usage"
description = "The stats command description and usage" keywords: ["container, resource, statistics"]
keywords = ["container, resource, statistics"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# stats # stats

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "stop"
title = "stop" description: "The stop command description and usage"
description = "The stop command description and usage" keywords: ["stop, SIGKILL, SIGTERM"]
keywords = ["stop, SIGKILL, SIGTERM"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# stop # stop

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "swarm init"
title = "swarm init" description: "The swarm init command description and usage"
description = "The swarm init command description and usage" keywords: ["swarm, init"]
keywords = ["swarm, init"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# swarm init # swarm init

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "swarm join"
title = "swarm join" description: "The swarm join command description and usage"
description = "The swarm join command description and usage" keywords: ["swarm, join"]
keywords = ["swarm, join"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# swarm join # swarm join

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "swarm join-token"
title = "swarm join-token" description: "The swarm join-token command description and usage"
description = "The swarm join-token command description and usage" keywords: ["swarm, join-token"]
keywords = ["swarm, join-token"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# swarm join-token # swarm join-token

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "swarm leave"
title = "swarm leave" description: "The swarm leave command description and usage"
description = "The swarm leave command description and usage" keywords: ["swarm, leave"]
keywords = ["swarm, leave"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# swarm leave # swarm leave

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "swarm update"
title = "swarm update" description: "The swarm update command description and usage"
description = "The swarm update command description and usage" keywords: ["swarm, update"]
keywords = ["swarm, update"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# swarm update # swarm update

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "system df"
title = "system df" description: "The system df command description and usage"
description = "The system df command description and usage" keywords: [system, data, usage, disk]
keywords = [system, data, usage, disk] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# system df # system df

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "system prune"
title = "system prune" description: "Remove unused data"
description = "Remove unused data" keywords: [system, prune, delete, remove]
keywords = [system, prune, delete, remove] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# system prune # system prune

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "tag"
title = "tag" description: "The tag command description and usage"
description = "The tag command description and usage" keywords: ["tag, name, image"]
keywords = ["tag, name, image"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# tag # tag

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "top"
title = "top" description: "The top command description and usage"
description = "The top command description and usage" keywords: ["container, running, processes"]
keywords = ["container, running, processes"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# top # top

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "unpause"
title = "unpause" description: "The unpause command description and usage"
description = "The unpause command description and usage" keywords: ["cgroups, suspend, container"]
keywords = ["cgroups, suspend, container"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# unpause # unpause

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "update"
title = "update" description: "The update command description and usage"
description = "The update command description and usage" keywords: ["resources, update, dynamically"]
keywords = ["resources, update, dynamically"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
## update ## update
@ -31,8 +27,8 @@ Options:
``` ```
The `docker update` command dynamically updates container configuration. The `docker update` command dynamically updates container configuration.
You can use this command to prevent containers from consuming too many You can use this command to prevent containers from consuming too many
resources from their Docker host. With a single command, you can place resources from their Docker host. With a single command, you can place
limits on a single container or on many. To specify more than one container, limits on a single container or on many. To specify more than one container,
provide space-separated list of container names or IDs. provide space-separated list of container names or IDs.

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "version"
title = "version" description: "The version command description and usage"
description = "The version command description and usage" keywords: ["version, architecture, api"]
keywords = ["version, architecture, api"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# version # version

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "volume create"
title = "volume create" description: "The volume create command description and usage"
description = "The volume create command description and usage" keywords: ["volume, create"]
keywords = ["volume, create"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# volume create # volume create
@ -57,7 +53,7 @@ different volume drivers may do different things (or nothing at all).
The built-in `local` driver on Windows does not support any options. The built-in `local` driver on Windows does not support any options.
The built-in `local` driver on Linux accepts options similar to the linux `mount` command. You can provide multiple options by passing the `--opt` flag multiple times. Some `mount` options (such as the `o` option) can take a comma-separated list of options. Complete list of available mount options can be found [here](http://man7.org/linux/man-pages/man8/mount.8.html). The built-in `local` driver on Linux accepts options similar to the linux `mount` command. You can provide multiple options by passing the `--opt` flag multiple times. Some `mount` options (such as the `o` option) can take a comma-separated list of options. Complete list of available mount options can be found [here](http://man7.org/linux/man-pages/man8/mount.8.html).
For example, the following creates a `tmpfs` volume called `foo` with a size of 100 megabyte and `uid` of 1000. For example, the following creates a `tmpfs` volume called `foo` with a size of 100 megabyte and `uid` of 1000.
```bash ```bash

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "volume inspect"
title = "volume inspect" description: "The volume inspect command description and usage"
description = "The volume inspect command description and usage" keywords: ["volume, inspect"]
keywords = ["volume, inspect"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# volume inspect # volume inspect

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "volume ls"
title = "volume ls" description: "The volume ls command description and usage"
description = "The volume ls command description and usage" keywords: ["volume, list"]
keywords = ["volume, list"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# volume ls # volume ls

View File

@ -1,12 +1,8 @@
<!--[metadata]> ---
+++ title: "volume prune"
title = "volume prune" description: "Remove unused volumes"
description = "Remove unused volumes" keywords: [volume, prune, delete]
keywords = [volume, prune, delete] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# volume prune # volume prune

View File

@ -1,12 +1,9 @@
<!--[metadata]> ---
+++ title: "volume rm"
title = "volume rm" description: "the volume rm command description and usage"
description = "the volume rm command description and usage" keywords: ["volume, rm"]
keywords = ["volume, rm"] ---
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# volume rm # volume rm

Some files were not shown because too many files have changed in this diff Show More