Kaydet (Commit) e1774c4c authored tarafından Joffrey F's avatar Joffrey F

Reference swarm methods in api.md file.

Signed-off-by: 's avatarJoffrey F <joffrey@docker.com>
üst 0f70b6a3
...@@ -606,6 +606,11 @@ Display system-wide information. Identical to the `docker info` command. ...@@ -606,6 +606,11 @@ Display system-wide information. Identical to the `docker info` command.
'SwapLimit': 1} 'SwapLimit': 1}
``` ```
## init_swarm
Initialize a new Swarm using the current connected engine as the first node.
See the [Swarm documentation](swarm.md#clientinit_swarm).
## insert ## insert
*DEPRECATED* *DEPRECATED*
...@@ -641,6 +646,11 @@ Retrieve network info by id. ...@@ -641,6 +646,11 @@ Retrieve network info by id.
**Returns** (dict): Network information dictionary **Returns** (dict): Network information dictionary
## inspect_swarm
Retrieve information about the current Swarm.
See the [Swarm documentation](swarm.md#clientinspect_swarm).
## inspect_volume ## inspect_volume
Retrieve volume info by name. Retrieve volume info by name.
...@@ -656,6 +666,11 @@ Retrieve volume info by name. ...@@ -656,6 +666,11 @@ Retrieve volume info by name.
{u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Driver': u'local', u'Name': u'foobar'} {u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Driver': u'local', u'Name': u'foobar'}
``` ```
## join_swarm
Join an existing Swarm.
See the [Swarm documentation](swarm.md#clientjoin_swarm).
## kill ## kill
Kill a container or send a signal to a container. Kill a container or send a signal to a container.
...@@ -665,6 +680,11 @@ Kill a container or send a signal to a container. ...@@ -665,6 +680,11 @@ Kill a container or send a signal to a container.
* container (str): The container to kill * container (str): The container to kill
* signal (str or int): The signal to send. Defaults to `SIGKILL` * signal (str or int): The signal to send. Defaults to `SIGKILL`
## leave_swarm
Leave the current Swarm.
See the [Swarm documentation](swarm.md#clientleave_swarm).
## load_image ## load_image
Load an image that was previously saved using `Client.get_image` Load an image that was previously saved using `Client.get_image`
...@@ -1054,6 +1074,11 @@ Update resource configs of one or more containers. ...@@ -1054,6 +1074,11 @@ Update resource configs of one or more containers.
**Returns** (dict): Dictionary containing a `Warnings` key. **Returns** (dict): Dictionary containing a `Warnings` key.
## update_swarm
Update the current Swarm.
See the [Swarm documentation](swarm.md#clientupdate_swarm).
## version ## version
Nearly identical to the `docker version` command. Nearly identical to the `docker version` command.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment