============
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 at
https://docs.openstack.org/openstacksdk/latest/contributor/history.html
Getting started
---------------
.. rubric:: Authentication and connection management
openstacksdk aims to talk to any OpenStack cloud. To do this, it requires a
configuration file. openstacksdk favours ``clouds.yaml`` files, but can also
use environment variables. The ``clouds.yaml`` file should be provided by your
cloud provider or deployment tooling. An example:
.. code-block:: yaml
clouds:
mordred:
region_name: Dallas
auth:
username: 'mordred'
password: XXXXXXX
project_name: 'demo'
auth_url: 'https://identity.example.com'
openstacksdk will look for ``clouds.yaml`` files in the following locations:
* If set, the path indicated by the ``OS_CLIENT_CONFIG_FILE`` environment
variable
* ``.`` (the current directory)
* ``$HOME/.config/openstack``
* ``/etc/openstack``
You can create a connection using the ``openstack.connect`` function. The cloud
name can be either passed directly to this function or specified using the
``OS_CLOUD`` environment variable. If you don't have a ``clouds.yaml`` file and
instead use environment variables for configuration then you can use the
special ``envvars`` cloud name to load configuration from the environment. For
example:
.. code-block:: python
import openstack
# Initialize connection from a clouds.yaml by passing a cloud name
conn_from_cloud_name = openstack.connect(cloud='mordred')
# Initialize connection from a clouds.yaml using the OS_CLOUD envvar
conn_from_os_cloud = openstack.connect()
# Initialize connection from environment variables
conn_from_env_vars = openstack.connect(cloud='envvars')
.. note::
How this is all achieved is described in more detail `below
<openstack.config>`__.
.. rubric:: The cloud layer
openstacksdk consists of four layers which all build on top of each other. The
highest level layer is the *cloud* layer. Cloud layer methods are available via
the top level ``Connection`` object returned by ``openstack.connect``. For
example:
.. code-block:: python
import openstack
# Initialize and turn on debug logging
openstack.enable_logging(debug=True)
# Initialize connection
conn = openstack.connect(cloud='mordred')
# List the servers
for server in conn.list_servers():
print(server.to_dict())
The cloud layer is based on logical operations that can potentially touch
multiple services. 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:
.. code-block:: python
import openstack
# Initialize and turn on debug logging
openstack.enable_logging(debug=True)
# Initialize connection
conn = openstack.connect(cloud='mordred')
# Upload an image to the cloud
image = conn.create_image(
'ubuntu-trusty', filename='ubuntu-trusty.qcow2', wait=True)
# Find a flavor with at least 512M of RAM
flavor = 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)
.. rubric:: The proxy layer
The next layer is the *proxy* layer. Most users will make use of this layer.
The proxy layer is service-specific, so methods will be available under
service-specific connection attributes of the ``Connection`` object such as
``compute``, ``block_storage``, ``image`` etc. For example:
.. code-block:: python
import openstack
# Initialize and turn on debug logging
openstack.enable_logging(debug=True)
# Initialize connection
conn = openstack.connect(cloud='mordred')
# List the servers
for server in conn.compute.servers():
print(server.to_dict())
.. note::
A list of supported services is given `below <supported-services>`__.
.. rubric:: The resource layer
Below this there is the *resource* layer. 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 but it can be
helpful for operations where you already have a ``Resource`` object to hand.
For example:
.. code-block:: python
import openstack
import openstack.config.loader
import openstack.compute.v2.server
# Initialize and turn on debug logging
openstack.enable_logging(debug=True)
# Initialize connection
conn = openstack.connect(cloud='mordred')
# List the servers
for server in openstack.compute.v2.server.Server.list(session=conn.compute):
print(server.to_dict())
.. rubric:: The raw HTTP layer
Finally, there is the *raw HTTP* layer. This exposes raw HTTP semantics and
is effectively a wrapper around the `requests`__ API with added smarts to
handle stuff like authentication and version management. As such, you can use
the ``requests`` API methods you know and love, like ``get``, ``post`` and
``put``, and expect to receive a ``requests.Response`` object in response
(unlike the other layers, which mostly all return objects that subclass
``openstack.resource.Resource``). Like the *resource* layer, you will typically
not need to use this directly but it can be helpful to interact with APIs that
have not or will not be supported by openstacksdk. For example:
.. code-block:: python
import openstack
# Initialize and turn on debug logging
openstack.enable_logging(debug=True)
# Initialize connection
conn = openstack.connect(cloud='mordred')
# List servers
for server in openstack.compute.get('/servers').json():
print(server)
.. __: https://requests.readthedocs.io/en/latest/
.. _openstack.config:
Configuration
-------------
openstacksdk uses the ``openstack.config`` module to parse configuration.
``openstack.config`` will 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 OpenStack
* If you have a config file, you will get the clouds listed in it
* If you have environment variables, you will get a cloud named `envvars`
* If you have neither, you will get a cloud named `defaults` with base defaults
You can view the configuration identified by openstacksdk in your current
environment by running ``openstack.config.loader``. For example:
.. code-block:: bash
$ python -m openstack.config.loader
More information at https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html
.. _supported-services:
Supported services
------------------
The following services are currently supported. A full list of all available
OpenStack service can be found in the `Project Navigator`__.
.. note::
Support here does not guarantee full-support for all APIs. It simply means
some aspect of the project is supported.
.. list-table:: Supported services
:widths: 15 25 10 40
:header-rows: 1
* - Service
- Description
- Cloud Layer
- Proxy & Resource Layer
* - **Compute**
-
-
-
* - Nova
- Compute
- ✔
- ✔ (``openstack.compute``)
* - **Hardware Lifecycle**
-
-
-
* - Ironic
- Bare metal provisioning
- ✔
- ✔ (``openstack.baremetal``, ``openstack.baremetal_introspection``)
* - Cyborg
- Lifecycle management of accelerators
- ✔
- ✔ (``openstack.accelerator``)
* - **Storage**
-
-
-
* - Cinder
- Block storage
- ✔
- ✔ (``openstack.block_storage``)
* - Swift
- Object store
- ✔
- ✔ (``openstack.object_store``)
* - Cinder
- Shared filesystems
- ✔
- ✔ (``openstack.shared_file_system``)
* - **Networking**
-
-
-
* - Neutron
- Networking
- ✔
- ✔ (``openstack.network``)
* - Octavia
- Load balancing
- ✔
- ✔ (``openstack.load_balancer``)
* - Designate
- DNS
- ✔
- ✔ (``openstack.dns``)
* - **Shared services**
-
-
-
* - Keystone
- Identity
- ✔
- ✔ (``openstack.identity``)
* - Placement
- Placement
- ✔
- ✔ (``openstack.placement``)
* - Glance
- Image storage
- ✔
- ✔ (``openstack.image``)
* - Barbican
- Key management
- ✔
- ✔ (``openstack.key_manager``)
* - **Workload provisioning**
-
-
-
* - Magnum
- Container orchestration engine provisioning
- ✔
- ✔ (``openstack.container_infrastructure_management``)
* - **Orchestration**
-
-
-
* - Heat
- Orchestration
- ✔
- ✔ (``openstack.orchestration``)
* - Senlin
- Clustering
- ✔
- ✔ (``openstack.clustering``)
* - Mistral
- Workflow
- ✔
- ✔ (``openstack.workflow``)
* - Zaqar
- Messaging
- ✔
- ✔ (``openstack.message``)
* - **Application lifecycle**
-
-
-
* - Masakari
- Instances high availability service
- ✔
- ✔ (``openstack.instance_ha``)
.. __: https://www.openstack.org/software/project-navigator/openstack-components#openstack-services
Links
-----
* `Issue Tracker <https://bugs.launchpad.net/openstacksdk>`_
* `Code Review <https://review.opendev.org/#/q/status:open+project:openstack/openstacksdk,n,z>`_
* `Documentation <https://docs.openstack.org/openstacksdk/latest/>`_
* `PyPI <https://pypi.org/project/openstacksdk/>`_
* `Mailing list <https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/>`_
* `Release Notes <https://docs.openstack.org/releasenotes/openstacksdk>`_
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/openstacksdk/",
"name": "openstacksdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/32/7b/42529e0014cf5c3e1a4f4c07ed43c1df357d57f5f61ca15cbdbfdd229654/openstacksdk-4.1.0.tar.gz",
"platform": null,
"description": "============\nopenstacksdk\n============\n\nopenstacksdk is a client library for building applications to work\nwith OpenStack clouds. The project aims to provide a consistent and\ncomplete set of interactions with OpenStack's many services, along with\ncomplete documentation, examples, and tools.\n\nIt also contains an abstraction interface layer. Clouds can do many things, but\nthere are probably only about 10 of them that most people care about with any\nregularity. If you want to do complicated things, the per-service oriented\nportions of the SDK are for you. However, if what you want is to be able to\nwrite an application that talks to any OpenStack cloud regardless of\nconfiguration, then the Cloud Abstraction layer is for you.\n\nMore information about the history of openstacksdk can be found at\nhttps://docs.openstack.org/openstacksdk/latest/contributor/history.html\n\nGetting started\n---------------\n\n.. rubric:: Authentication and connection management\n\nopenstacksdk aims to talk to any OpenStack cloud. To do this, it requires a\nconfiguration file. openstacksdk favours ``clouds.yaml`` files, but can also\nuse environment variables. The ``clouds.yaml`` file should be provided by your\ncloud provider or deployment tooling. An example:\n\n.. code-block:: yaml\n\n clouds:\n mordred:\n region_name: Dallas\n auth:\n username: 'mordred'\n password: XXXXXXX\n project_name: 'demo'\n auth_url: 'https://identity.example.com'\n\nopenstacksdk will look for ``clouds.yaml`` files in the following locations:\n\n* If set, the path indicated by the ``OS_CLIENT_CONFIG_FILE`` environment\n variable\n* ``.`` (the current directory)\n* ``$HOME/.config/openstack``\n* ``/etc/openstack``\n\nYou can create a connection using the ``openstack.connect`` function. The cloud\nname can be either passed directly to this function or specified using the\n``OS_CLOUD`` environment variable. If you don't have a ``clouds.yaml`` file and\ninstead use environment variables for configuration then you can use the\nspecial ``envvars`` cloud name to load configuration from the environment. For\nexample:\n\n.. code-block:: python\n\n import openstack\n\n # Initialize connection from a clouds.yaml by passing a cloud name\n conn_from_cloud_name = openstack.connect(cloud='mordred')\n\n # Initialize connection from a clouds.yaml using the OS_CLOUD envvar\n conn_from_os_cloud = openstack.connect()\n\n # Initialize connection from environment variables\n conn_from_env_vars = openstack.connect(cloud='envvars')\n\n.. note::\n\n How this is all achieved is described in more detail `below\n <openstack.config>`__.\n\n.. rubric:: The cloud layer\n\nopenstacksdk consists of four layers which all build on top of each other. The\nhighest level layer is the *cloud* layer. Cloud layer methods are available via\nthe top level ``Connection`` object returned by ``openstack.connect``. For\nexample:\n\n.. code-block:: python\n\n import openstack\n\n # Initialize and turn on debug logging\n openstack.enable_logging(debug=True)\n\n # Initialize connection\n conn = openstack.connect(cloud='mordred')\n\n # List the servers\n for server in conn.list_servers():\n print(server.to_dict())\n\nThe cloud layer is based on logical operations that can potentially touch\nmultiple services. The benefit of this layer is mostly seen in more complicated\noperations that take multiple steps and where the steps vary across providers.\nFor example:\n\n.. code-block:: python\n\n import openstack\n\n # Initialize and turn on debug logging\n openstack.enable_logging(debug=True)\n\n # Initialize connection\n conn = openstack.connect(cloud='mordred')\n\n # Upload an image to the cloud\n image = conn.create_image(\n 'ubuntu-trusty', filename='ubuntu-trusty.qcow2', wait=True)\n\n # Find a flavor with at least 512M of RAM\n flavor = conn.get_flavor_by_ram(512)\n\n # Boot a server, wait for it to boot, and then do whatever is needed\n # to get a public IP address for it.\n conn.create_server(\n 'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)\n\n.. rubric:: The proxy layer\n\nThe next layer is the *proxy* layer. Most users will make use of this layer.\nThe proxy layer is service-specific, so methods will be available under\nservice-specific connection attributes of the ``Connection`` object such as\n``compute``, ``block_storage``, ``image`` etc. For example:\n\n.. code-block:: python\n\n import openstack\n\n # Initialize and turn on debug logging\n openstack.enable_logging(debug=True)\n\n # Initialize connection\n conn = openstack.connect(cloud='mordred')\n\n # List the servers\n for server in conn.compute.servers():\n print(server.to_dict())\n\n.. note::\n\n A list of supported services is given `below <supported-services>`__.\n\n.. rubric:: The resource layer\n\nBelow this there is the *resource* layer. This provides support for the basic\nCRUD operations supported by REST APIs and is the base building block for the\nother layers. You typically will not need to use this directly but it can be\nhelpful for operations where you already have a ``Resource`` object to hand.\nFor example:\n\n.. code-block:: python\n\n import openstack\n import openstack.config.loader\n import openstack.compute.v2.server\n\n # Initialize and turn on debug logging\n openstack.enable_logging(debug=True)\n\n # Initialize connection\n conn = openstack.connect(cloud='mordred')\n\n # List the servers\n for server in openstack.compute.v2.server.Server.list(session=conn.compute):\n print(server.to_dict())\n\n.. rubric:: The raw HTTP layer\n\nFinally, there is the *raw HTTP* layer. This exposes raw HTTP semantics and\nis effectively a wrapper around the `requests`__ API with added smarts to\nhandle stuff like authentication and version management. As such, you can use\nthe ``requests`` API methods you know and love, like ``get``, ``post`` and\n``put``, and expect to receive a ``requests.Response`` object in response\n(unlike the other layers, which mostly all return objects that subclass\n``openstack.resource.Resource``). Like the *resource* layer, you will typically\nnot need to use this directly but it can be helpful to interact with APIs that\nhave not or will not be supported by openstacksdk. For example:\n\n.. code-block:: python\n\n import openstack\n\n # Initialize and turn on debug logging\n openstack.enable_logging(debug=True)\n\n # Initialize connection\n conn = openstack.connect(cloud='mordred')\n\n # List servers\n for server in openstack.compute.get('/servers').json():\n print(server)\n\n.. __: https://requests.readthedocs.io/en/latest/\n\n.. _openstack.config:\n\nConfiguration\n-------------\n\nopenstacksdk uses the ``openstack.config`` module to parse configuration.\n``openstack.config`` will find cloud configuration for as few as one cloud and\nas many as you want to put in a config file. It will read environment variables\nand config files, and it also contains some vendor specific default values so\nthat you don't have to know extra info to use OpenStack\n\n* If you have a config file, you will get the clouds listed in it\n* If you have environment variables, you will get a cloud named `envvars`\n* If you have neither, you will get a cloud named `defaults` with base defaults\n\nYou can view the configuration identified by openstacksdk in your current\nenvironment by running ``openstack.config.loader``. For example:\n\n.. code-block:: bash\n\n $ python -m openstack.config.loader\n\nMore information at https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html\n\n.. _supported-services:\n\nSupported services\n------------------\n\nThe following services are currently supported. A full list of all available\nOpenStack service can be found in the `Project Navigator`__.\n\n.. note::\n\n Support here does not guarantee full-support for all APIs. It simply means\n some aspect of the project is supported.\n\n.. list-table:: Supported services\n :widths: 15 25 10 40\n :header-rows: 1\n\n * - Service\n - Description\n - Cloud Layer\n - Proxy & Resource Layer\n\n * - **Compute**\n -\n -\n -\n\n * - Nova\n - Compute\n - \u2714\n - \u2714 (``openstack.compute``)\n\n * - **Hardware Lifecycle**\n -\n -\n -\n\n * - Ironic\n - Bare metal provisioning\n - \u2714\n - \u2714 (``openstack.baremetal``, ``openstack.baremetal_introspection``)\n\n * - Cyborg\n - Lifecycle management of accelerators\n - \u2714\n - \u2714 (``openstack.accelerator``)\n\n * - **Storage**\n -\n -\n -\n\n * - Cinder\n - Block storage\n - \u2714\n - \u2714 (``openstack.block_storage``)\n\n * - Swift\n - Object store\n - \u2714\n - \u2714 (``openstack.object_store``)\n\n * - Cinder\n - Shared filesystems\n - \u2714\n - \u2714 (``openstack.shared_file_system``)\n\n * - **Networking**\n -\n -\n -\n\n * - Neutron\n - Networking\n - \u2714\n - \u2714 (``openstack.network``)\n\n * - Octavia\n - Load balancing\n - \u2714\n - \u2714 (``openstack.load_balancer``)\n\n * - Designate\n - DNS\n - \u2714\n - \u2714 (``openstack.dns``)\n\n * - **Shared services**\n -\n -\n -\n\n * - Keystone\n - Identity\n - \u2714\n - \u2714 (``openstack.identity``)\n\n * - Placement\n - Placement\n - \u2714\n - \u2714 (``openstack.placement``)\n\n * - Glance\n - Image storage\n - \u2714\n - \u2714 (``openstack.image``)\n\n * - Barbican\n - Key management\n - \u2714\n - \u2714 (``openstack.key_manager``)\n\n * - **Workload provisioning**\n -\n -\n -\n\n * - Magnum\n - Container orchestration engine provisioning\n - \u2714\n - \u2714 (``openstack.container_infrastructure_management``)\n\n * - **Orchestration**\n -\n -\n -\n\n * - Heat\n - Orchestration\n - \u2714\n - \u2714 (``openstack.orchestration``)\n\n * - Senlin\n - Clustering\n - \u2714\n - \u2714 (``openstack.clustering``)\n\n * - Mistral\n - Workflow\n - \u2714\n - \u2714 (``openstack.workflow``)\n\n * - Zaqar\n - Messaging\n - \u2714\n - \u2714 (``openstack.message``)\n\n * - **Application lifecycle**\n -\n -\n -\n\n * - Masakari\n - Instances high availability service\n - \u2714\n - \u2714 (``openstack.instance_ha``)\n\n.. __: https://www.openstack.org/software/project-navigator/openstack-components#openstack-services\n\nLinks\n-----\n\n* `Issue Tracker <https://bugs.launchpad.net/openstacksdk>`_\n* `Code Review <https://review.opendev.org/#/q/status:open+project:openstack/openstacksdk,n,z>`_\n* `Documentation <https://docs.openstack.org/openstacksdk/latest/>`_\n* `PyPI <https://pypi.org/project/openstacksdk/>`_\n* `Mailing list <https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/>`_\n* `Release Notes <https://docs.openstack.org/releasenotes/openstacksdk>`_\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "An SDK for building applications to work with OpenStack",
"version": "4.1.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/openstacksdk/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b234efc14b97011a42190e34ed1fc210f09f969b0b49e51130674aa683ab97f8",
"md5": "a61b697e776e645c2c89ee4b4fd8082e",
"sha256": "e6821bd6f923fe6311948d1d2c01c0a11a62e8b6bcf3d11c2a18acafc8ab6311"
},
"downloads": -1,
"filename": "openstacksdk-4.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a61b697e776e645c2c89ee4b4fd8082e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1743627,
"upload_time": "2024-10-18T10:17:10",
"upload_time_iso_8601": "2024-10-18T10:17:10.390025Z",
"url": "https://files.pythonhosted.org/packages/b2/34/efc14b97011a42190e34ed1fc210f09f969b0b49e51130674aa683ab97f8/openstacksdk-4.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "327b42529e0014cf5c3e1a4f4c07ed43c1df357d57f5f61ca15cbdbfdd229654",
"md5": "d5eee8accff220eedf3c6ef652ac5dff",
"sha256": "ccac9b158e3d36b959a3bdce71bd4f883d7758fef6856841c855ff2b22c941ea"
},
"downloads": -1,
"filename": "openstacksdk-4.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d5eee8accff220eedf3c6ef652ac5dff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1233207,
"upload_time": "2024-10-18T10:17:12",
"upload_time_iso_8601": "2024-10-18T10:17:12.115515Z",
"url": "https://files.pythonhosted.org/packages/32/7b/42529e0014cf5c3e1a4f4c07ed43c1df357d57f5f61ca15cbdbfdd229654/openstacksdk-4.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 10:17:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "openstacksdk"
}
JSON