Basic OpenStack async client library using asyncio
Project description
AsyncOpenStackClient
Introduction
The AsyncOpenStackClient is a asynchronous rest wrapper for the OpenStack API. It provides a nice abstraction for authentication. For method specification, see the official OpenStack documentation: https://docs.openstack.org/queens/api/.
Installation
Use pip:
pip install AsyncOpenStackClient
Usage
from asyncopenstackclient import NovaClient, GlanceClient, CinderClient, AuthPassword
# you can either pass credentials explicitly (as shown below)
# or use enviormental variables from OpenStack RC file
# https://docs.openstack.org/mitaka/cli-reference/common/cli_set_environment_variables_using_openstack_rc.html
auth = AuthPassword(
auth_url='https://keystone:5999/v3'
username='USER', password='PASS',
project_name='my-project',
user_domain_name='default',
project_domain_name='foo.bar'
)
nova = NovaClient(session=auth)
glance = GlanceClient(session=auth)
cinder = CinderClient(session=auth)
# api url for each service will be taken from catalog,
# but you may pass `api_url` param to force custom url eg.
# nova = NovaClient(session=auth, api_url='http://my-local-nova:9876/v2/')
await nova.init_api()
await glance.init_api()
await cinder.init_api()
servers = await nova.servers.list(name='testvm')
vm = await nova.servers.get(server_id)
action_spec = {'os-stop': None}
await nova.servers.run_action(server_id, **action_spec)
specs = {
"name": 'some_name',
"flavorRef": 'flavor_id',
"imageRef": 'image_id',
"security_groups": [{'name': 'group1'}, {'name': 'group2'}]
"user_data": base64.b64encode(userdata).decode('utf-8')
}
response = await nova.servers.create(server=specs)
print(response)
volume = {"size": 200,
"imageRef": "image_id",
"name": "some_name"}
response = await cinder.volumes.create(volume=volume)
print(response)
Available functions
Nova (https://developer.openstack.org/api-ref/compute)
servers.list(optional=filter) # params optional
servers.get(id)
servers.create(server=server_spec)
servers.force_delete(id)
servers.run_action(id, action=action_spec)
flavors.list()
metadata.get(server_id)
metadata.set(server_id, meta=meta_spec)
metadata.get_item(server_id, item_name)
metadata.set_item(server_id, item_name, meta=meta_spec)
Glance (https://developer.openstack.org/api-ref/image/v2/index.html)
images.list()
Cinder (https://developer.openstack.org/api-ref/block-storage/v3/index.html)
volumes.list(optional=filter) # params optional
volumes.get(id)
volumes.create(volume=volume_spec)
volumes.force_delete(id)
License
Changelog
0.8.1 (2019-04-03)
Fixed: upgrade dependencies (urllib3: CVE-2018-20060)
0.8.0 (2018-08-19)
Feature: another part of compute API - run an action on server
Feature: CD configuration
0.7.0 (2018-06-15)
Feature: Cinder implementation
Bugfix: typo fixes
0.6.3 (2018-06-13)
Feature: adjustable request timeout, default is 60s now
0.6.2 (2018-05-18)
Bugfix: initialize property (api) in Client to get some meaningful error instead of “recursion limit reached”.
0.6.0 (2018-05-12)
Feature: wrap requests with Resource/Method proxy
0.5.2 (2018-05-10)
Bugfix: adding slash at the end of api_root_url
0.5.1 (2018-04-29)
Bugfix: update README with metadata entry and envs notice
0.5.0 (2018-04-25)
Feature: partial support for server metadata usage
0.4.1 (2018-04-25)
Bugifx: invalid concat auth_url with urljoin
0.4.0 (2018-04-16)
Feature: use OS_ variables if present
0.3.0 (2018-04-13)
Feature: accept to pass api_url
Feature: determine api url if catalog provide incomplete one (eg. without version)
0.2.3 (2018-04-05)
Bugfix: do_not_await_sync_method
0.2.2 (2018-04-02)
Update simple-rest-client (fixed logging)
0.2.1 (2018-03-28)
fix tests, cov report, MANIFEST.in
0.1.1 (2018-03-02)
Update MANIFEST.in
0.1.0 (2018-02-15)
First approach to build async openstack client library for Python3
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file AsyncOpenStackClient-0.8.1.tar.gz
.
File metadata
- Download URL: AsyncOpenStackClient-0.8.1.tar.gz
- Upload date:
- Size: 23.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.9.1 pkginfo/1.4.1 requests/2.20.0 setuptools/37.0.0 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/3.6.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64a1c5a15063220c7f4ff0435cf2731d655698ad895712687f1781751d786fe3 |
|
MD5 | 57319485664d613333e921a3866683e4 |
|
BLAKE2b-256 | b0fe93ddfc4cafc6d5ea720c7965bb849547223c8cbf545f8e5d497076676cfe |