https://github.com/openstack/shade

Client library for OpenStack containing Infra business logic. Mirror of code maintained at opendev.org.
https://github.com/openstack/shade

Last synced: 29 days ago
JSON representation

Client library for OpenStack containing Infra business logic. Mirror of code maintained at opendev.org.

• Host: GitHub
• URL: https://github.com/openstack/shade
• Owner: openstack
• License: apache-2.0
• Created: 2015-01-07T21:07:08.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2020-06-01T23:04:17.000Z (over 4 years ago)
• Last Synced: 2024-11-08T01:37:47.988Z (about 1 month ago)
• Language: Python
• Homepage: https://opendev.org/openstack/shade
• Size: 6.03 MB
• Stars: 79
• Watchers: 13
• Forks: 64
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - openstack/shade - Client library for OpenStack containing Infra business logic. Mirror of code maintained at opendev.org. (Python)

README

        
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.

.. _usage_example:

Example

=======

Sometimes an example is nice.

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

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

=====

* `Issue Tracker `_

* `Code Review `_

* `Documentation `_

* `Source `_

* `PyPI `_

* `Mailing list `_

* `Release notes `_

* `Contributing `_

.. _openstacksdk: https://docs.openstack.org/openstacksdk/latest/user/