Revision 1c366ac9 docs/developers/code.rst
| b/docs/developers/code.rst | ||
|---|---|---|
| 6 | 6 |
Command Specifications |
| 7 | 7 |
---------------------- |
| 8 | 8 |
|
| 9 |
user |
|
| 10 |
^^^^ |
|
| 9 |
astakos |
|
| 10 |
^^^^^^^ |
|
| 11 |
Features: user, project, quota, resource, commission, endpoint, service |
|
| 11 | 12 |
|
| 12 | 13 |
.. automodule:: kamaki.cli.commands.astakos |
| 13 | 14 |
:members: |
| 14 | 15 |
:undoc-members: |
| 15 | 16 |
|
| 16 |
cyclades (server, flavor, network) |
|
| 17 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
| 17 |
cyclades |
|
| 18 |
^^^^^^^^ |
|
| 19 |
|
|
| 20 |
Features server, flavor |
|
| 18 | 21 |
|
| 19 | 22 |
.. automodule:: kamaki.cli.commands.cyclades |
| 20 | 23 |
:members: |
| 21 | 24 |
:undoc-members: |
| 22 | 25 |
|
| 23 |
pithos (file) |
|
| 24 |
^^^^^^^^^^^^^ |
|
| 26 |
pithos |
|
| 27 |
^^^^^^ |
|
| 28 |
|
|
| 29 |
Features file, container, sharer, group |
|
| 25 | 30 |
|
| 26 | 31 |
.. automodule:: kamaki.cli.commands.pithos |
| 27 | 32 |
:members: |
| ... | ... | |
| 30 | 35 |
image |
| 31 | 36 |
^^^^^ |
| 32 | 37 |
|
| 33 |
.. automodule:: kamaki.cli.commands.image |
|
| 34 |
:members: |
|
| 35 |
:undoc-members: |
|
| 36 |
|
|
| 37 |
Kamaki commands |
|
| 38 |
^^^^^^^^^^^^^^^ |
|
| 39 |
|
|
| 40 |
config |
|
| 41 |
"""""" |
|
| 42 |
|
|
| 43 |
.. automodule:: kamaki.cli.commands.config |
|
| 44 |
:members: |
|
| 45 |
:undoc-members: |
|
| 46 |
|
|
| 47 |
history |
|
| 48 |
""""""" |
|
| 38 |
Features (image, imagecompute) |
|
| 49 | 39 |
|
| 50 |
.. automodule:: kamaki.cli.commands.history |
|
| 51 |
:members: |
|
| 52 |
:undoc-members: |
|
| 53 |
|
|
| 54 |
Command Line Interfaces |
|
| 55 |
----------------------- |
|
| 56 |
|
|
| 57 |
argument |
|
| 58 |
^^^^^^^^ |
|
| 59 |
|
|
| 60 |
.. automodule:: kamaki.cli.argument |
|
| 40 |
.. automodule:: kamaki.cli.commands.image |
|
| 61 | 41 |
:members: |
| 62 |
:show-inheritance: |
|
| 63 | 42 |
:undoc-members: |
| 64 | 43 |
|
| 65 | 44 |
|
| 66 |
command_shell |
|
| 67 |
^^^^^^^^^^^^^ |
|
| 68 |
|
|
| 69 |
.. automodule:: kamaki.cli.command_shell |
|
| 70 |
:members: |
|
| 71 |
:show-inheritance: |
|
| 72 |
:undoc-members: |
|
| 73 |
|
|
| 45 |
network |
|
| 46 |
^^^^^^^ |
|
| 74 | 47 |
|
| 75 |
command_tree |
|
| 76 |
^^^^^^^^^^^^ |
|
| 48 |
Features network, port, subnet, ip |
|
| 77 | 49 |
|
| 78 |
.. automodule:: kamaki.cli.command_tree
|
|
| 50 |
.. automodule:: kamaki.cli.commands.network
|
|
| 79 | 51 |
:members: |
| 80 |
:show-inheritance: |
|
| 81 | 52 |
:undoc-members: |
| 82 | 53 |
|
| 54 |
Kamaki commands |
|
| 55 |
^^^^^^^^^^^^^^^ |
|
| 83 | 56 |
|
| 84 | 57 |
config |
| 85 |
^^^^^^
|
|
| 58 |
""""""
|
|
| 86 | 59 |
|
| 87 |
.. automodule:: kamaki.cli.config |
|
| 60 |
.. automodule:: kamaki.cli.commands.config
|
|
| 88 | 61 |
:members: |
| 89 |
:show-inheritance: |
|
| 90 | 62 |
:undoc-members: |
| 91 | 63 |
|
| 64 |
|
|
| 92 | 65 |
errors |
| 93 | 66 |
^^^^^^ |
| 94 | 67 |
|
| 95 |
.. automodule:: kamaki.cli.errors |
|
| 96 |
:members: |
|
| 97 |
:show-inheritance: |
|
| 98 |
:undoc-members: |
|
| 99 |
|
|
| 100 |
|
|
| 101 |
history |
|
| 102 |
^^^^^^^ |
|
| 103 |
|
|
| 104 |
.. automodule:: kamaki.cli.history |
|
| 105 |
:members: |
|
| 106 |
:show-inheritance: |
|
| 107 |
:undoc-members: |
|
| 108 |
|
|
| 109 |
|
|
| 110 |
utils |
|
| 111 |
^^^^^ |
|
| 112 |
|
|
| 113 |
.. automodule:: kamaki.cli.utils |
|
| 68 |
.. automodule:: kamaki.cli.commands.errors |
|
| 114 | 69 |
:members: |
| 115 | 70 |
:show-inheritance: |
| 116 | 71 |
:undoc-members: |
| 117 | 72 |
|
| 118 |
|
|
| 119 | 73 |
.. _the-client-api-ref: |
| 120 | 74 |
|
| 121 | 75 |
The clients API |
| 122 | 76 |
--------------- |
| 123 | 77 |
|
| 124 |
Modules list |
|
| 125 |
^^^^^^^^^^^^ |
|
| 126 |
|
|
| 127 |
compute REST API |
|
| 128 |
^^^^^^^^^^^^^^^^ |
|
| 78 |
compute |
|
| 79 |
^^^^^^^ |
|
| 129 | 80 |
|
| 130 | 81 |
.. automodule:: kamaki.clients.compute.rest_api |
| 131 | 82 |
:members: |
| 132 | 83 |
:show-inheritance: |
| 133 | 84 |
:undoc-members: |
| 134 | 85 |
|
| 135 |
|
|
| 136 |
compute |
|
| 137 |
^^^^^^^ |
|
| 138 |
|
|
| 139 | 86 |
.. automodule:: kamaki.clients.compute |
| 140 | 87 |
:members: |
| 141 | 88 |
:show-inheritance: |
| 142 | 89 |
:undoc-members: |
| 143 | 90 |
|
| 144 | 91 |
|
| 145 |
cyclades REST API
|
|
| 146 |
^^^^^^^^^^^^^^^^^
|
|
| 92 |
cyclades |
|
| 93 |
^^^^^^^^ |
|
| 147 | 94 |
|
| 148 | 95 |
.. automodule:: kamaki.clients.cyclades.rest_api |
| 149 | 96 |
:members: |
| 150 | 97 |
:show-inheritance: |
| 151 | 98 |
:undoc-members: |
| 152 | 99 |
|
| 153 |
cyclades |
|
| 154 |
^^^^^^^^ |
|
| 155 |
|
|
| 156 | 100 |
.. automodule:: kamaki.clients.cyclades |
| 157 | 101 |
:members: |
| 158 | 102 |
:show-inheritance: |
| ... | ... | |
| 167 | 111 |
:show-inheritance: |
| 168 | 112 |
:undoc-members: |
| 169 | 113 |
|
| 170 |
pithos_rest_api
|
|
| 171 |
^^^^^^^^^^^^^^^
|
|
| 114 |
pithos |
|
| 115 |
^^^^^^ |
|
| 172 | 116 |
|
| 173 | 117 |
.. automodule:: kamaki.clients.pithos.rest_api |
| 174 | 118 |
:members: |
| 175 | 119 |
:show-inheritance: |
| 176 | 120 |
:undoc-members: |
| 177 | 121 |
|
| 178 |
pithos |
|
| 179 |
^^^^^^ |
|
| 180 |
|
|
| 181 | 122 |
.. automodule:: kamaki.clients.pithos |
| 182 | 123 |
:members: |
| 183 | 124 |
:show-inheritance: |
| ... | ... | |
| 191 | 132 |
:show-inheritance: |
| 192 | 133 |
:undoc-members: |
| 193 | 134 |
|
| 194 |
|
|
| 195 |
astakos |
|
| 135 |
network |
|
| 196 | 136 |
^^^^^^^ |
| 197 | 137 |
|
| 198 |
.. automodule:: kamaki.clients.astakos |
|
| 138 |
.. warning:: For synnefo, the suggested network implementation is in |
|
| 139 |
kamaki.clients.cyclades.CycladesNetworkClient extension |
|
| 140 |
|
|
| 141 |
.. automodule:: kamaki.clients.network |
|
| 199 | 142 |
:members: |
| 200 | 143 |
:show-inheritance: |
| 201 | 144 |
:undoc-members: |
| 202 | 145 |
|
| 146 |
astakos |
|
| 147 |
^^^^^^^ |
|
| 203 | 148 |
|
| 204 |
utils |
|
| 205 |
^^^^^ |
|
| 206 |
|
|
| 207 |
.. automodule:: kamaki.clients.utils |
|
| 149 |
.. automodule:: kamaki.clients.astakos |
|
| 208 | 150 |
:members: |
| 209 | 151 |
:show-inheritance: |
| 210 | 152 |
:undoc-members: |
Also available in: Unified diff