cs 2.1.6

A simple yet powerful CloudStack API client for Python and the command-line.

Home-page: https://github.com/exoscale/cs
Author: Bruno Renié
License: BSD
Description: CS
==

.. image:: https://travis-ci.org/exoscale/cs.svg?branch=master
:alt: Build Status
:target: https://travis-ci.org/exoscale/cs

.. image:: https://img.shields.io/pypi/l/cs.svg
:alt: License
:target: https://pypi-hypernode.com/pypi/cs

.. image:: https://img.shields.io/pypi/pyversions/cs.svg
:alt: Python versions
:target: https://pypi-hypernode.com/pypi/cs

A simple, yet powerful CloudStack API client for python and the command-line.

* Python 2.7+ 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

# with the colored output
pip install cs[highlight]

# with the async support (Python 3.5+)
pip install cs[async]

# with both
pip install cs[async,highlight]

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:

.. code-block:: console

cat $HOME/.cloudstack.ini

.. code-block:: 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:

.. code-block:: console

$ cs listVirtualMachines

.. code-block:: json

{
"count": 1,
"virtualmachine": [
{
"account": "...",
...
}
]
}

.. code-block:: console

$ 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.

``CLOUDSTACK_RETRY`` or the ``retry`` entry in the configuration file
(integer) can be used to retry ``list`` and ``queryAsync`` requests on
failure. The default value is 0, meaning no retry.

Multiple credentials can be set in ``.cloudstack.ini``. This allows selecting
the credentials or endpoint to use with a command-line flag.

.. code-block:: 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.com/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 :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Provides-Extra: highlight
Provides-Extra: async