diff options
author | Joffrey F <joffrey@docker.com> | 2016-08-04 17:03:02 -0700 |
---|---|---|
committer | Joffrey F <joffrey@docker.com> | 2016-08-04 17:05:25 -0700 |
commit | e1774c4c5b8ae8d28dfeef90236be75a8f54e88f (patch) | |
tree | a37a622cf7f466a10302f4e0ce74705fa44b12ea | |
parent | 0f70b6a38b80133e6df29c9cb007bc2c709db8ec (diff) | |
download | docker-py-e1774c4c5b8ae8d28dfeef90236be75a8f54e88f.tar.gz |
Reference swarm methods in api.md file.
Signed-off-by: Joffrey F <joffrey@docker.com>
-rw-r--r-- | docs/api.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md index 9b3a726..7748254 100644 --- a/docs/api.md +++ b/docs/api.md @@ -606,6 +606,11 @@ Display system-wide information. Identical to the `docker info` command. '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 *DEPRECATED* @@ -641,6 +646,11 @@ Retrieve network info by id. **Returns** (dict): Network information dictionary +## inspect_swarm + +Retrieve information about the current Swarm. +See the [Swarm documentation](swarm.md#clientinspect_swarm). + ## inspect_volume 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'} ``` +## join_swarm + +Join an existing Swarm. +See the [Swarm documentation](swarm.md#clientjoin_swarm). + ## kill 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 * 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 an image that was previously saved using `Client.get_image` @@ -1054,6 +1074,11 @@ Update resource configs of one or more containers. **Returns** (dict): Dictionary containing a `Warnings` key. +## update_swarm + +Update the current Swarm. +See the [Swarm documentation](swarm.md#clientupdate_swarm). + ## version Nearly identical to the `docker version` command. |