Client library for OpenStack containing Infra business logic
Go to file
2020-06-01 22:59:14 +00:00
devstack Update for opendev 2019-04-21 13:00:42 +00:00
doc Switch to newer openstackdocstheme and reno versions 2020-06-01 18:49:52 +00:00
extras List ansible/ansible in required-projects 2018-01-08 18:24:25 -06:00
playbooks/devstack Update for opendev 2019-04-21 13:00:42 +00:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-06-01 18:49:52 +00:00
shade Fix pep8 and py27, functional jobs 2020-06-01 07:54:56 -05:00
.coveragerc Start using keystoneauth for keystone sessions 2015-09-21 11:12:21 -05:00
.gitignore Switch to using stestr 2017-09-08 18:40:51 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:39:33 +00:00
.mailmap Add entry for James Blair to .mailmap 2015-10-23 09:51:05 +09:00
.stestr.conf Switch to using stestr 2017-09-08 18:40:51 -05:00
.zuul.yaml Remove publish-to-pypi template 2020-06-01 18:50:07 +00:00
bindep.txt Add libffi-dev to bindep.txt 2016-09-06 14:25:09 -05:00
CONTRIBUTING.rst fix "How To Contribute",bugs,review url 2019-09-18 17:51:29 +08:00
HACKING.rst Update the url in doc 2018-09-24 16:50:54 +08:00
LICENSE Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
lower-constraints.txt Make OpenStackCloud a subclass of Connection 2018-07-13 06:17:25 -05:00
MANIFEST.in Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
README.rst Add source and contributing link in readme 2019-10-05 16:10:08 +08:00
requirements.txt Make OpenStackCloud a subclass of Connection 2018-07-13 06:17:25 -05:00
setup.cfg Declare py38 support 2020-04-17 10:05:44 -05:00
setup.py Updated from global requirements 2017-03-30 14:03:25 +00:00
test-requirements.txt Updated from global requirements 2018-03-23 00:47:38 +00:00
tox.ini Fix pep8 and py27, functional jobs 2020-06-01 07:54:56 -05:00

Introduction

Warning

shade has been superceded by openstacksdk and no longer takes new features. The existing code will continue to be maintained indefinitely for bugfixes as necessary, but improvements will be deferred to openstacksdk. Please update your applications to use openstacksdk directly.

shade is a simple client library for interacting with OpenStack clouds. The key word here is simple. Clouds can do many many many things - but there are probably only about 10 of them that most people care about with any regularity. If you want to do complicated things, you should probably use the lower level client libraries - or even the REST API directly. However, if what you want is to be able to write an application that talks to clouds no matter what crazy choices the deployer has made in an attempt to be more hipster than their self-entitled narcissist peers, then shade is for you.

shade started its life as some code inside of ansible. ansible has a bunch of different OpenStack related modules, and there was a ton of duplicated code. Eventually, between refactoring that duplication into an internal library, and adding logic and features that the OpenStack Infra team had developed to run client applications at scale, it turned out that we'd written nine-tenths of what we'd need to have a standalone library.

Example

Sometimes an example is nice.

  1. Create a clouds.yml file:

    clouds:
     mordred:
       region_name: RegionOne
       auth:
         username: 'mordred'
         password: XXXXXXX
         project_name: 'shade'
         auth_url: 'https://montytaylor-sjc.openstack.blueboxgrid.com:5001/v2.0'

    Please note: os-client-config will look for a file called clouds.yaml in the following locations:

    • Current Directory
    • ~/.config/openstack
    • /etc/openstack

    More information at https://pypi.org/project/os-client-config

  2. Create a server with shade, configured with the clouds.yml file:

    import shade
    
    # Initialize and turn on debug logging
    shade.simple_logging(debug=True)
    
    # Initialize cloud
    # Cloud configs are read with os-client-config
    cloud = shade.openstack_cloud(cloud='mordred')
    
    # Upload an image to the cloud
    image = cloud.create_image(
        'ubuntu-trusty', filename='ubuntu-trusty.qcow2', wait=True)
    
    # Find a flavor with at least 512M of RAM
    flavor = cloud.get_flavor_by_ram(512)
    
    # Boot a server, wait for it to boot, and then do whatever is needed
    # to get a public ip for it.
    cloud.create_server(
        'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)

Links