/usr/lib/python2.7/dist-packages/cs-2.0.0.egg-info/PKG-INFO is in python-cs 2.0.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 | Metadata-Version: 1.1
Name: cs
Version: 2.0.0
Summary: A simple yet powerful CloudStack API client for Python and the command-line.
Home-page: https://github.com/exoscale/cs
Author: Bruno Renié
Author-email: UNKNOWN
License: BSD
Description-Content-Type: UNKNOWN
Description: CS
==
.. image:: https://travis-ci.org/exoscale/cs.svg?branch=master
:alt: Build Status
:target: https://travis-ci.org/exoscale/cs
A simple, yet powerful CloudStack API client for python and the command-line.
* Python 2.6+ and 3.3+ support.
* Async support for Python 3.5+
* All present and future CloudStack API calls and parameters are supported.
* Syntax highlight in the command-line client if Pygments is installed.
* BSD license.
Installation
------------
::
pip install cs
Usage
-----
In Python:
.. code-block:: python
from cs import CloudStack
cs = CloudStack(endpoint='https://api.exoscale.ch/compute',
key='cloudstack api key',
secret='cloudstack api secret')
vms = cs.listVirtualMachines()
cs.createSecurityGroup(name='web', description='HTTP traffic')
From the command-line, this requires some configuration::
cat $HOME/.cloudstack.ini
[cloudstack]
endpoint = https://api.exoscale.ch/compute
key = cloudstack api key
secret = cloudstack api secret
# Optional ca authority certificate
verify = /path/to/certs/exoscale_ca.crt
# Optional client PEM certificate
cert = /path/to/client_exoscale.pem
Then::
$ cs listVirtualMachines
{
"count": 1,
"virtualmachine": [
{
"account": "...",
...
}
]
}
$ cs authorizeSecurityGroupIngress \
cidrlist="0.0.0.0/0" endport=443 startport=443 \
securitygroupname="blah blah" protocol=tcp
The command-line client polls when async results are returned. To disable
polling, use the ``--async`` flag.
To find the list CloudStack API calls go to
http://cloudstack.apache.org/api.html
Configuration
-------------
Configuration is read from several locations, in the following order:
* The ``CLOUDSTACK_ENDPOINT``, ``CLOUDSTACK_KEY``, ``CLOUDSTACK_SECRET`` and
``CLOUDSTACK_METHOD`` environment variables,
* A ``CLOUDSTACK_CONFIG`` environment variable pointing to an ``.ini`` file,
* A ``CLOUDSTACK_VERIFY`` (optional) environment variable pointing to a CA authority cert file,
* A ``CLOUDSTACK_CERT`` (optional) environment variable pointing to a client PEM cert file,
* A ``cloudstack.ini`` file in the current working directory,
* A ``.cloudstack.ini`` file in the home directory.
To use that configuration scheme from your Python code:
.. code-block:: python
from cs import CloudStack, read_config
cs = CloudStack(**read_config())
Note that ``read_config()`` can raise ``SystemExit`` if no configuration is
found.
``CLOUDSTACK_METHOD`` or the ``method`` entry in the configuration file can be
used to change the HTTP verb used to make CloudStack requests. By default,
requests are made with the GET method but CloudStack supports POST requests.
POST can be useful to overcome some length limits in the CloudStack API.
``CLOUDSTACK_TIMEOUT`` or the ``timeout`` entry in the configuration file can
be used to change the HTTP timeout when making CloudStack requests (in
seconds). The default value is 10.
Multiple credentials can be set in ``.cloudstack.ini``. This allows selecting
the credentials or endpoint to use with a command-line flag::
cat $HOME/.cloudstack.ini
[cloudstack]
endpoint = https://some-host/api/compute
key = api key
secret = api secret
[exoscale]
endpoint = https://api.exoscale.ch/compute
key = api key
secret = api secret
Usage::
$ cs listVirtualMachines --region=exoscale
Optionally ``CLOUDSTACK_REGION`` can be used to overwrite the default region ``cloudstack``.
Pagination
----------
CloudStack paginates requests. ``cs`` is able to abstract away the pagination
logic to allow fetching large result sets in one go. This is done with the
``fetch_list`` parameter::
$ cs listVirtualMachines fetch_list=true
Or in Python::
cs.listVirtualMachines(fetch_list=True)
Async client
------------
``cs`` provides the ``AIOCloudStack`` class for async/await calls in Python
3.5+.
.. code-block:: python
from cs import AIOCloudStack, read_config
cs = AIOCloudStack(**read_config())
vms = await cs.listVirtualMachines()
By default, this client polls CloudStack's async jobs to return actual results
for commands that result in an async job being created. You can customize this
behavior with ``job_timeout`` (default: None -- wait indefinitely) and
``poll_interval`` (default: 2s).
.. code-block:: python
cs = AIOCloudStack(**read_config(), job_timeout=300, poll_interval=5)
Async deployment of multiple vms
________________________________
.. code-block:: python
import asyncio
from cs import AIOCloudStack, read_config
cs = AIOCloudStack(**read_config())
tasks = [asyncio.ensure_future(cs.deployVirtualMachine(zoneid='',
serviceofferingid='',
templateid='')) for _ in range(5)]
results = []
done, pending = await asyncio.wait(tasks)
exceptions = 0
last_exception = None
for t in done:
if t.exception():
exceptions += 1
last_exception = t.exception()
elif t.result():
results.append(t.result())
if exceptions:
print(f"{exceptions} deployment(s) failed")
raise last_exception
# Destroy all of them, but skip waiting on the job results
tasks = [cs.destroyVirtualMachine(id=vm['id'], fetch_result=False)
for vm in results]
await asyncio.wait(tasks)
Links
-----
* CloudStack API: http://cloudstack.apache.org/api.html
* Example of use: `Get Started with the exoscale API client <https://www.exoscale.ch/syslog/2016/02/23/get-started-with-the-exoscale-api-client/>`_
Platform: any
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
|