Skip to main content

Simple client library for interacting with OpenStack clouds

Project description

Introduction

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.python.org/pypi/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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shade-1.27.0.tar.gz (328.0 kB view details)

Uploaded Source

Built Distribution

shade-1.27.0-py2-none-any.whl (366.6 kB view details)

Uploaded Python 2

File details

Details for the file shade-1.27.0.tar.gz.

File metadata

  • Download URL: shade-1.27.0.tar.gz
  • Upload date:
  • Size: 328.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for shade-1.27.0.tar.gz
Algorithm Hash digest
SHA256 11a1602e6f937ff43363fafe2cba7d416a5cecf5f9131e137b1363392e3c3e66
MD5 e418677ba9c40e87e1d1d4f90f413a3c
BLAKE2b-256 46fdb0892e74dddb3b0c583f9ac08e32741876e968640012c5f77d3fb8117430

See more details on using hashes here.

File details

Details for the file shade-1.27.0-py2-none-any.whl.

File metadata

File hashes

Hashes for shade-1.27.0-py2-none-any.whl
Algorithm Hash digest
SHA256 b2f2080404f64cb4b9ce69462f360aef4638c8cf74d8b215f13ef1d2392f16cc
MD5 8d81207a885277257a79a124ca691937
BLAKE2b-256 78c255fa6d5f0387e9ef3a995a3396656cb495d9e2ee33aa39ba1a62f40c856b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page