diff options
| author | Joffrey F <joffrey@docker.com> | 2017-02-16 16:00:34 -0800 |
|---|---|---|
| committer | Joffrey F <joffrey@docker.com> | 2017-02-16 16:19:31 -0800 |
| commit | 784172b0db903dfcff9d546c165edc8c3489f728 (patch) | |
| tree | b55de124ae94615db4b347824b08fa8311fc8a5a | |
| parent | b1d6e01abe0474ea91d04090fc39e343d877f60d (diff) | |
| download | docker-py-784172b0db903dfcff9d546c165edc8c3489f728.tar.gz | |
Add missing secrets doc
Signed-off-by: Joffrey F <joffrey@docker.com>
| -rw-r--r-- | docs/api.rst | 10 | ||||
| -rw-r--r-- | docs/client.rst | 1 | ||||
| -rw-r--r-- | docs/images.rst | 2 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/secrets.rst | 29 |
5 files changed, 42 insertions, 1 deletions
diff --git a/docs/api.rst b/docs/api.rst index 52d12ae..52cd26b 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -97,6 +97,15 @@ Plugins :members: :undoc-members: +Secrets +------- + +.. py:module:: docker.api.secret + +.. rst-class:: hide-signature +.. autoclass:: SecretApiMixin + :members: + :undoc-members: The Docker daemon ----------------- @@ -121,6 +130,7 @@ Configuration types .. autoclass:: Mount .. autoclass:: Resources .. autoclass:: RestartPolicy +.. autoclass:: SecretReference .. autoclass:: ServiceMode .. autoclass:: TaskTemplate .. autoclass:: UpdateConfig diff --git a/docs/client.rst b/docs/client.rst index 5096bcc..9d9edeb 100644 --- a/docs/client.rst +++ b/docs/client.rst @@ -20,6 +20,7 @@ Client reference .. autoattribute:: networks .. autoattribute:: nodes .. autoattribute:: plugins + .. autoattribute:: secrets .. autoattribute:: services .. autoattribute:: swarm .. autoattribute:: volumes diff --git a/docs/images.rst b/docs/images.rst index 866786d..25fcffc 100644 --- a/docs/images.rst +++ b/docs/images.rst @@ -14,11 +14,11 @@ Methods available on ``client.images``: .. automethod:: get .. automethod:: list(**kwargs) .. automethod:: load + .. automethod:: prune .. automethod:: pull .. automethod:: push .. automethod:: remove .. automethod:: search - .. automethod:: prune Image objects diff --git a/docs/index.rst b/docs/index.rst index 70f570e..9113bff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -85,6 +85,7 @@ That's just a taste of what you can do with the Docker SDK for Python. For more, networks nodes plugins + secrets services swarm volumes diff --git a/docs/secrets.rst b/docs/secrets.rst new file mode 100644 index 0000000..49e1498 --- /dev/null +++ b/docs/secrets.rst @@ -0,0 +1,29 @@ +Secrets +======= + +.. py:module:: docker.models.secrets + +Manage secrets on the server. + +Methods available on ``client.secrets``: + +.. rst-class:: hide-signature +.. py:class:: SecretCollection + + .. automethod:: create + .. automethod:: get + .. automethod:: list + + +Secret objects +-------------- + +.. autoclass:: Secret() + + .. autoattribute:: id + .. autoattribute:: name + .. py:attribute:: attrs + + The raw representation of this object from the server. + + .. automethod:: remove |