Package: openstacksdk
openstacksdk is a client library for building applications to work
with OpenStack clouds. The project aims to provide a consistent and
complete set of interactions with OpenStack’s many services, along with
complete documentation, examples, and tools.It also contains an abstraction interface layer. Clouds can do 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, the per-service oriented
portions of the SDK are for you. However, if what you want is to be able to
write an application that talks to any OpenStack cloud regardless of
configuration, then the Cloud Abstraction layer is for you.More information about the history of openstacksdk can be found athttps://docs.openstack.org/openstacksdk/latest/contributor/history.htmlGetting startedopenstacksdk aims to talk to any OpenStack cloud. To do this, it requires a
configuration file. openstacksdk favoursclouds.yamlfiles, but can also
use environment variables. Theclouds.yamlfile should be provided by your
cloud provider or deployment tooling. An example:clouds:mordred:region_name:Dallasauth:username:'mordred'password:XXXXXXXproject_name:'demo'auth_url:'https://identity.example.com'openstacksdk will look forclouds.yamlfiles in the following locations:.(the current directory)$HOME/.config/openstack/etc/openstackopenstacksdk consists of three layers. Most users will make use of theproxylayer. Using the aboveclouds.yaml, consider listing servers:importopenstack# Initialize and turn on debug loggingopenstack.enable_logging(debug=True)# Initialize connectionconn=openstack.connect(cloud='mordred')# List the serversforserverinconn.compute.servers():print(server.to_dict())openstacksdk also contains a higher-levelcloudlayer based on logical
operations:importopenstack# Initialize and turn on debug loggingopenstack.enable_logging(debug=True)# Initialize connectionconn=openstack.connect(cloud='mordred')# List the serversforserverinconn.list_servers():print(server.to_dict())The benefit of this layer is mostly seen in more complicated operations that
take multiple steps and where the steps vary across providers. For example:importopenstack# Initialize and turn on debug loggingopenstack.enable_logging(debug=True)# Initialize connectionconn=openstack.connect(cloud='mordred')# Upload an image to the cloudimage=conn.create_image('ubuntu-trusty',filename='ubuntu-trusty.qcow2',wait=True)# Find a flavor with at least 512M of RAMflavor=conn.get_flavor_by_ram(512)# Boot a server, wait for it to boot, and then do whatever is needed# to get a public IP address for it.conn.create_server('my-server',image=image,flavor=flavor,wait=True,auto_ip=True)Finally, there is the low-levelresourcelayer. This provides support for the
basic CRUD operations supported by REST APIs and is the base building block for
the other layers. You typically will not need to use this directly:importopenstackimportopenstack.config.loaderimportopenstack.compute.v2.server# Initialize and turn on debug loggingopenstack.enable_logging(debug=True)# Initialize connectionconn=openstack.connect(cloud='mordred')# List the serversforserverinopenstack.compute.v2.server.Server.list(session=conn.compute):print(server.to_dict())Configurationopenstacksdk uses theopenstack.configmodule to parse configuration.openstack.configwill find cloud configuration for as few as one cloud and
as many as you want to put in a config file. It will read environment variables
and config files, and it also contains some vendor specific default values so
that you don’t have to know extra info to use OpenStackIf you have a config file, you will get the clouds listed in itIf you have environment variables, you will get a cloud namedenvvarsIf you have neither, you will get a cloud nameddefaultswith base defaultsYou can view the configuration identified by openstacksdk in your current
environment by runningopenstack.config.loader. For example:$python-mopenstack.config.loaderMore information athttps://docs.openstack.org/openstacksdk/latest/user/config/configuration.htmlSupported servicesThe following services are currently supported. A full list of all available
OpenStack service can be found in theProject Navigator.NoteSupport here does not guarantee full-support for all APIs. It simply means
some aspect of the project is supported.Supported servicesServiceDescriptionCloud LayerProxy & Resource LayerComputeNovaCompute✔✔ (openstack.compute)Hardware LifecycleIronicBare metal provisioning✔✔ (openstack.baremetal,openstack.baremetal_introspection)CyborgLifecycle management of accelerators✔✔ (openstack.accelerator)StorageCinderBlock storage✔✔ (openstack.block_storage)SwiftObject store✔✔ (openstack.object_store)CinderShared filesystems✔✔ (openstack.shared_file_system)NetworkingNeutronNetworking✔✔ (openstack.network)OctaviaLoad balancing✔✔ (openstack.load_balancer)DesignateDNS✔✔ (openstack.dns)Shared servicesKeystoneIdentity✔✔ (openstack.identity)PlacementPlacement✔✔ (openstack.placement)GlanceImage storage✔✔ (openstack.image)BarbicanKey management✔✔ (openstack.key_manager)Workload provisioningMagnumContainer orchestration engine provisioning✔✔ (openstack.container_infrastructure_management)OrchestrationHeatOrchestration✔✔ (openstack.orchestration)SenlinClustering✔✔ (openstack.clustering)MistralWorkflow✔✔ (openstack.workflow)ZaqarMessaging✔✔ (openstack.message)Application lifecycleMasakariInstances high availability service✔✔ (openstack.instance_ha)LinksIssue TrackerCode ReviewDocumentationPyPIMailing listRelease Notes