diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index 2cdd0f5cd..000000000 --- a/doc/Makefile +++ /dev/null @@ -1,136 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html pdf dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " pdf to make pdf with rst2pdf" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -pdf: - $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf - @echo - @echo "Build finished. The PDFs are in $(BUILDDIR)/pdf." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NebulaDocs.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NebulaDocs.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/NebulaDocs" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NebulaDocs" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/source/index.rst b/doc/source/index.rst index df613dd65..19b9bdead 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,10 +1,21 @@ Welcome to the OpenStack SDK! ============================= -This documentation is split into two sections: one for -:doc:`users ` looking to build applications which make use of -OpenStack, and another for those looking to -:doc:`contribute ` to this project. +This documentation is split into three sections: + +* an :doc:`installation ` guide +* a section for :doc:`users ` looking to build applications + which make use of OpenStack +* a section for those looking to :doc:`contribute ` + to this project + +Installation +------------ + +.. toctree:: + :maxdepth: 2 + + install/index For Users --------- @@ -12,12 +23,8 @@ For Users .. toctree:: :maxdepth: 2 - users/index - install/index user/index -.. TODO(shade) merge users/index and user/index into user/index - For Contributors ---------------- diff --git a/doc/source/users/connection.rst b/doc/source/user/connection.rst similarity index 100% rename from doc/source/users/connection.rst rename to doc/source/user/connection.rst diff --git a/doc/source/user/examples b/doc/source/user/examples new file mode 120000 index 000000000..9f9d1de88 --- /dev/null +++ b/doc/source/user/examples @@ -0,0 +1 @@ +../../../examples \ No newline at end of file diff --git a/doc/source/user/examples/cleanup-servers.py b/doc/source/user/examples/cleanup-servers.py deleted file mode 100644 index 628c8657f..000000000 --- a/doc/source/user/examples/cleanup-servers.py +++ /dev/null @@ -1,13 +0,0 @@ -import openstack.cloud - -# Initialize and turn on debug logging -openstack.cloud.simple_logging(debug=True) - -for cloud_name, region_name in [ - ('my-vexxhost', 'ca-ymq-1'), - ('my-citycloud', 'Buf1'), - ('my-internap', 'ams01')]: - # Initialize cloud - cloud = openstack.openstack_cloud(cloud=cloud_name, region_name=region_name) - for server in cloud.search_servers('my-server'): - cloud.delete_server(server, wait=True, delete_ips=True) diff --git a/doc/source/user/examples/debug-logging.py b/doc/source/user/examples/debug-logging.py deleted file mode 100644 index c0d91e125..000000000 --- a/doc/source/user/examples/debug-logging.py +++ /dev/null @@ -1,6 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging(debug=True) - -cloud = openstack.openstack_cloud( - cloud='my-vexxhost', region_name='ca-ymq-1') -cloud.get_image('Ubuntu 16.04.1 LTS [2017-03-03]') diff --git a/doc/source/user/examples/find-an-image.py b/doc/source/user/examples/find-an-image.py deleted file mode 100644 index 74c666a60..000000000 --- a/doc/source/user/examples/find-an-image.py +++ /dev/null @@ -1,7 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging() - -cloud = openstack.openstack_cloud(cloud='fuga', region_name='cystack') -cloud.pprint([ - image for image in cloud.list_images() - if 'ubuntu' in image.name.lower()]) diff --git a/doc/source/user/examples/http-debug-logging.py b/doc/source/user/examples/http-debug-logging.py deleted file mode 100644 index eff9d7572..000000000 --- a/doc/source/user/examples/http-debug-logging.py +++ /dev/null @@ -1,6 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging(http_debug=True) - -cloud = openstack.openstack_cloud( - cloud='my-vexxhost', region_name='ca-ymq-1') -cloud.get_image('Ubuntu 16.04.1 LTS [2017-03-03]') diff --git a/doc/source/user/examples/munch-dict-object.py b/doc/source/user/examples/munch-dict-object.py deleted file mode 100644 index bfde7b41b..000000000 --- a/doc/source/user/examples/munch-dict-object.py +++ /dev/null @@ -1,7 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging(debug=True) - -cloud = openstack.openstack_cloud(cloud='ovh', region_name='SBG1') -image = cloud.get_image('Ubuntu 16.10') -print(image.name) -print(image['name']) diff --git a/doc/source/user/examples/normalization.py b/doc/source/user/examples/normalization.py deleted file mode 100644 index 22b9b0f26..000000000 --- a/doc/source/user/examples/normalization.py +++ /dev/null @@ -1,7 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging() - -cloud = openstack.openstack_cloud(cloud='fuga', region_name='cystack') -image = cloud.get_image( - 'Ubuntu 16.04 LTS - Xenial Xerus - 64-bit - Fuga Cloud Based Image') -cloud.pprint(image) diff --git a/doc/source/user/examples/service-conditional-overrides.py b/doc/source/user/examples/service-conditional-overrides.py deleted file mode 100644 index 845e7ab7c..000000000 --- a/doc/source/user/examples/service-conditional-overrides.py +++ /dev/null @@ -1,5 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging(debug=True) - -cloud = openstack.openstack_cloud(cloud='rax', region_name='DFW') -print(cloud.has_service('network')) diff --git a/doc/source/user/examples/service-conditionals.py b/doc/source/user/examples/service-conditionals.py deleted file mode 100644 index 9bb198cbc..000000000 --- a/doc/source/user/examples/service-conditionals.py +++ /dev/null @@ -1,6 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging(debug=True) - -cloud = openstack.openstack_cloud(cloud='kiss', region_name='region1') -print(cloud.has_service('network')) -print(cloud.has_service('container-orchestration')) diff --git a/doc/source/user/examples/strict-mode.py b/doc/source/user/examples/strict-mode.py deleted file mode 100644 index 251547160..000000000 --- a/doc/source/user/examples/strict-mode.py +++ /dev/null @@ -1,8 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging() - -cloud = openstack.openstack_cloud( - cloud='fuga', region_name='cystack', strict=True) -image = cloud.get_image( - 'Ubuntu 16.04 LTS - Xenial Xerus - 64-bit - Fuga Cloud Based Image') -cloud.pprint(image) diff --git a/doc/source/user/examples/upload-large-object.py b/doc/source/user/examples/upload-large-object.py deleted file mode 100644 index 6b5c392a8..000000000 --- a/doc/source/user/examples/upload-large-object.py +++ /dev/null @@ -1,10 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging(debug=True) - -cloud = openstack.openstack_cloud(cloud='ovh', region_name='SBG1') -cloud.create_object( - container='my-container', name='my-object', - filename='/home/mordred/briarcliff.sh3d', - segment_size=1000000) -cloud.delete_object('my-container', 'my-object') -cloud.delete_container('my-container') diff --git a/doc/source/user/examples/upload-object.py b/doc/source/user/examples/upload-object.py deleted file mode 100644 index 6b5c392a8..000000000 --- a/doc/source/user/examples/upload-object.py +++ /dev/null @@ -1,10 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging(debug=True) - -cloud = openstack.openstack_cloud(cloud='ovh', region_name='SBG1') -cloud.create_object( - container='my-container', name='my-object', - filename='/home/mordred/briarcliff.sh3d', - segment_size=1000000) -cloud.delete_object('my-container', 'my-object') -cloud.delete_container('my-container') diff --git a/doc/source/user/examples/user-agent.py b/doc/source/user/examples/user-agent.py deleted file mode 100644 index 094c91e1c..000000000 --- a/doc/source/user/examples/user-agent.py +++ /dev/null @@ -1,6 +0,0 @@ -import openstack.cloud -openstack.cloud.simple_logging(http_debug=True) - -cloud = openstack.openstack_cloud( - cloud='datacentred', app_name='AmazingApp', app_version='1.0') -cloud.list_networks() diff --git a/doc/source/users/guides/baremetal.rst b/doc/source/user/guides/baremetal.rst similarity index 100% rename from doc/source/users/guides/baremetal.rst rename to doc/source/user/guides/baremetal.rst diff --git a/doc/source/users/guides/block_storage.rst b/doc/source/user/guides/block_storage.rst similarity index 100% rename from doc/source/users/guides/block_storage.rst rename to doc/source/user/guides/block_storage.rst diff --git a/doc/source/users/guides/clustering.rst b/doc/source/user/guides/clustering.rst similarity index 100% rename from doc/source/users/guides/clustering.rst rename to doc/source/user/guides/clustering.rst diff --git a/doc/source/users/guides/clustering/action.rst b/doc/source/user/guides/clustering/action.rst similarity index 100% rename from doc/source/users/guides/clustering/action.rst rename to doc/source/user/guides/clustering/action.rst diff --git a/doc/source/users/guides/clustering/cluster.rst b/doc/source/user/guides/clustering/cluster.rst similarity index 100% rename from doc/source/users/guides/clustering/cluster.rst rename to doc/source/user/guides/clustering/cluster.rst diff --git a/doc/source/users/guides/clustering/event.rst b/doc/source/user/guides/clustering/event.rst similarity index 100% rename from doc/source/users/guides/clustering/event.rst rename to doc/source/user/guides/clustering/event.rst diff --git a/doc/source/users/guides/clustering/node.rst b/doc/source/user/guides/clustering/node.rst similarity index 100% rename from doc/source/users/guides/clustering/node.rst rename to doc/source/user/guides/clustering/node.rst diff --git a/doc/source/users/guides/clustering/policy.rst b/doc/source/user/guides/clustering/policy.rst similarity index 100% rename from doc/source/users/guides/clustering/policy.rst rename to doc/source/user/guides/clustering/policy.rst diff --git a/doc/source/users/guides/clustering/policy_type.rst b/doc/source/user/guides/clustering/policy_type.rst similarity index 100% rename from doc/source/users/guides/clustering/policy_type.rst rename to doc/source/user/guides/clustering/policy_type.rst diff --git a/doc/source/users/guides/clustering/profile.rst b/doc/source/user/guides/clustering/profile.rst similarity index 100% rename from doc/source/users/guides/clustering/profile.rst rename to doc/source/user/guides/clustering/profile.rst diff --git a/doc/source/users/guides/clustering/profile_type.rst b/doc/source/user/guides/clustering/profile_type.rst similarity index 100% rename from doc/source/users/guides/clustering/profile_type.rst rename to doc/source/user/guides/clustering/profile_type.rst diff --git a/doc/source/users/guides/clustering/receiver.rst b/doc/source/user/guides/clustering/receiver.rst similarity index 100% rename from doc/source/users/guides/clustering/receiver.rst rename to doc/source/user/guides/clustering/receiver.rst diff --git a/doc/source/users/guides/compute.rst b/doc/source/user/guides/compute.rst similarity index 100% rename from doc/source/users/guides/compute.rst rename to doc/source/user/guides/compute.rst diff --git a/doc/source/users/guides/connect.rst b/doc/source/user/guides/connect.rst similarity index 100% rename from doc/source/users/guides/connect.rst rename to doc/source/user/guides/connect.rst diff --git a/doc/source/users/guides/connect_from_config.rst b/doc/source/user/guides/connect_from_config.rst similarity index 100% rename from doc/source/users/guides/connect_from_config.rst rename to doc/source/user/guides/connect_from_config.rst diff --git a/doc/source/users/guides/database.rst b/doc/source/user/guides/database.rst similarity index 100% rename from doc/source/users/guides/database.rst rename to doc/source/user/guides/database.rst diff --git a/doc/source/users/guides/identity.rst b/doc/source/user/guides/identity.rst similarity index 100% rename from doc/source/users/guides/identity.rst rename to doc/source/user/guides/identity.rst diff --git a/doc/source/users/guides/image.rst b/doc/source/user/guides/image.rst similarity index 100% rename from doc/source/users/guides/image.rst rename to doc/source/user/guides/image.rst diff --git a/doc/source/users/guides/key_manager.rst b/doc/source/user/guides/key_manager.rst similarity index 100% rename from doc/source/users/guides/key_manager.rst rename to doc/source/user/guides/key_manager.rst diff --git a/doc/source/users/guides/logging.rst b/doc/source/user/guides/logging.rst similarity index 100% rename from doc/source/users/guides/logging.rst rename to doc/source/user/guides/logging.rst diff --git a/doc/source/users/guides/message.rst b/doc/source/user/guides/message.rst similarity index 100% rename from doc/source/users/guides/message.rst rename to doc/source/user/guides/message.rst diff --git a/doc/source/users/guides/meter.rst b/doc/source/user/guides/meter.rst similarity index 100% rename from doc/source/users/guides/meter.rst rename to doc/source/user/guides/meter.rst diff --git a/doc/source/users/guides/network.rst b/doc/source/user/guides/network.rst similarity index 100% rename from doc/source/users/guides/network.rst rename to doc/source/user/guides/network.rst diff --git a/doc/source/users/guides/object_store.rst b/doc/source/user/guides/object_store.rst similarity index 100% rename from doc/source/users/guides/object_store.rst rename to doc/source/user/guides/object_store.rst diff --git a/doc/source/users/guides/orchestration.rst b/doc/source/user/guides/orchestration.rst similarity index 100% rename from doc/source/users/guides/orchestration.rst rename to doc/source/user/guides/orchestration.rst diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 10513936f..d28c2abb6 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -1,15 +1,155 @@ -================== - Shade User Guide -================== +Getting started with the OpenStack SDK +====================================== + +For a listing of terms used throughout the SDK, including the names of +projects and services supported by it, see the :doc:`glossary <../glossary>`. + +Installation +------------ + +The OpenStack SDK is available on +`PyPI `_ under the name +**openstacksdk**. To install it, use ``pip``:: + + $ pip install openstacksdk + +.. _user_guides: + +User Guides +----------- + +These guides walk you through how to make use of the libraries we provide +to work with each OpenStack service. If you're looking for a cookbook +approach, this is where you'll want to begin. + +.. TODO(shade) Merge guides/logging and logging .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + + Configuration + Connect to an OpenStack Cloud + Connect to an OpenStack Cloud Using a Config File + Using Cloud Abstration Layer + Logging + Shade Logging + Microversions + Baremetal + Block Storage + Clustering + Compute + Database + Identity + Image + Key Manager + Message + Meter + Network + Object Store + Orchestration + +API Documentation +----------------- + +Service APIs are exposed through a two-layered approach. The classes +exposed through our *Connection* interface are the place to start if you're +an application developer consuming an OpenStack cloud. The *Resource* +interface is the layer upon which the *Connection* is built, with +*Connection* methods accepting and returning *Resource* objects. + +The Cloud Abstraction layer has a data model. + +.. toctree:: + :maxdepth: 1 - config/index - usage - logging model - microversions + +Connection Interface +******************** + +A *Connection* instance maintains your cloud config, session and authentication +information providing you with a set of higher-level interfaces to work with +OpenStack services. + +.. toctree:: + :maxdepth: 1 + + connection + +Once you have a *Connection* instance, the following services may be exposed +to you. The combination of your ``CloudRegion`` and the catalog of the cloud +in question control which services are exposed, but listed below are the ones +provided by the SDK. + +.. toctree:: + :maxdepth: 1 + + Baremetal + Block Storage + Clustering + Compute + Database + Identity v2 + Identity v3 + Image v1 + Image v2 + Key Manager + Load Balancer + Message v1 + Message v2 + Network + Meter + Metric + Object Store + Orchestration + Workflow + +Resource Interface +****************** + +The *Resource* layer is a lower-level interface to communicate with OpenStack +services. While the classes exposed by the *Connection* build a convenience +layer on top of this, *Resources* can be used directly. However, the most +common usage of this layer is in receiving an object from a class in the +*Connection* layer, modifying it, and sending it back into the *Connection* +layer, such as to update a resource on the server. + +The following services have exposed *Resource* classes. + +.. toctree:: + :maxdepth: 1 + + Baremetal + Block Storage + Clustering + Compute + Database + Identity + Image + Key Management + Load Balancer + Meter + Metric + Network + Orchestration + Object Store + Workflow + +Low-Level Classes +***************** + +The following classes are not commonly used by application developers, +but are used to construct applications to talk to OpenStack APIs. Typically +these parts are managed through the `Connection Interface`_, but their use +can be customized. + +.. toctree:: + :maxdepth: 1 + + resource + resource2 + service_filter + utils Presentations ============= diff --git a/doc/source/users/proxies/baremetal.rst b/doc/source/user/proxies/baremetal.rst similarity index 97% rename from doc/source/users/proxies/baremetal.rst rename to doc/source/user/proxies/baremetal.rst index 5ca777b2a..b10f38b63 100644 --- a/doc/source/users/proxies/baremetal.rst +++ b/doc/source/user/proxies/baremetal.rst @@ -1,7 +1,7 @@ Baremetal API ============== -For details on how to use baremetal, see :doc:`/users/guides/baremetal` +For details on how to use baremetal, see :doc:`/user/guides/baremetal` .. automodule:: openstack.baremetal.v1._proxy diff --git a/doc/source/users/proxies/block_storage.rst b/doc/source/user/proxies/block_storage.rst similarity index 95% rename from doc/source/users/proxies/block_storage.rst rename to doc/source/user/proxies/block_storage.rst index ba9f7e355..8395709c3 100644 --- a/doc/source/users/proxies/block_storage.rst +++ b/doc/source/user/proxies/block_storage.rst @@ -1,7 +1,7 @@ Block Storage API ================= -For details on how to use block_storage, see :doc:`/users/guides/block_storage` +For details on how to use block_storage, see :doc:`/user/guides/block_storage` .. automodule:: openstack.block_storage.v2._proxy diff --git a/doc/source/users/proxies/clustering.rst b/doc/source/user/proxies/clustering.rst similarity index 100% rename from doc/source/users/proxies/clustering.rst rename to doc/source/user/proxies/clustering.rst diff --git a/doc/source/users/proxies/compute.rst b/doc/source/user/proxies/compute.rst similarity index 99% rename from doc/source/users/proxies/compute.rst rename to doc/source/user/proxies/compute.rst index 3d3b3cb13..d713b9c0a 100644 --- a/doc/source/users/proxies/compute.rst +++ b/doc/source/user/proxies/compute.rst @@ -1,7 +1,7 @@ Compute API =========== -For details on how to use compute, see :doc:`/users/guides/compute` +For details on how to use compute, see :doc:`/user/guides/compute` .. automodule:: openstack.compute.v2._proxy diff --git a/doc/source/users/proxies/database.rst b/doc/source/user/proxies/database.rst similarity index 96% rename from doc/source/users/proxies/database.rst rename to doc/source/user/proxies/database.rst index 493589b7b..6a3cdb372 100644 --- a/doc/source/users/proxies/database.rst +++ b/doc/source/user/proxies/database.rst @@ -1,7 +1,7 @@ Database API ============ -For details on how to use database, see :doc:`/users/guides/database` +For details on how to use database, see :doc:`/user/guides/database` .. automodule:: openstack.database.v1._proxy diff --git a/doc/source/users/proxies/identity_v2.rst b/doc/source/user/proxies/identity_v2.rst similarity index 96% rename from doc/source/users/proxies/identity_v2.rst rename to doc/source/user/proxies/identity_v2.rst index 0cd4b77e2..2bb5500a2 100644 --- a/doc/source/users/proxies/identity_v2.rst +++ b/doc/source/user/proxies/identity_v2.rst @@ -1,7 +1,7 @@ Identity API v2 =============== -For details on how to use identity, see :doc:`/users/guides/identity` +For details on how to use identity, see :doc:`/user/guides/identity` .. automodule:: openstack.identity.v2._proxy diff --git a/doc/source/users/proxies/identity_v3.rst b/doc/source/user/proxies/identity_v3.rst similarity index 98% rename from doc/source/users/proxies/identity_v3.rst rename to doc/source/user/proxies/identity_v3.rst index a5366a019..e2c5b125e 100644 --- a/doc/source/users/proxies/identity_v3.rst +++ b/doc/source/user/proxies/identity_v3.rst @@ -1,7 +1,7 @@ Identity API v3 =============== -For details on how to use identity, see :doc:`/users/guides/identity` +For details on how to use identity, see :doc:`/user/guides/identity` .. automodule:: openstack.identity.v3._proxy diff --git a/doc/source/users/proxies/image_v1.rst b/doc/source/user/proxies/image_v1.rst similarity index 91% rename from doc/source/users/proxies/image_v1.rst rename to doc/source/user/proxies/image_v1.rst index 185d60eb8..7be486538 100644 --- a/doc/source/users/proxies/image_v1.rst +++ b/doc/source/user/proxies/image_v1.rst @@ -1,7 +1,7 @@ Image API v1 ============ -For details on how to use image, see :doc:`/users/guides/image` +For details on how to use image, see :doc:`/user/guides/image` .. automodule:: openstack.image.v1._proxy diff --git a/doc/source/users/proxies/image_v2.rst b/doc/source/user/proxies/image_v2.rst similarity index 96% rename from doc/source/users/proxies/image_v2.rst rename to doc/source/user/proxies/image_v2.rst index f88d7450a..121e2cc7a 100644 --- a/doc/source/users/proxies/image_v2.rst +++ b/doc/source/user/proxies/image_v2.rst @@ -1,7 +1,7 @@ Image API v2 ============ -For details on how to use image, see :doc:`/users/guides/image` +For details on how to use image, see :doc:`/user/guides/image` .. automodule:: openstack.image.v2._proxy diff --git a/doc/source/users/proxies/key_manager.rst b/doc/source/user/proxies/key_manager.rst similarity index 98% rename from doc/source/users/proxies/key_manager.rst rename to doc/source/user/proxies/key_manager.rst index 7d24bb13e..291fb77fe 100644 --- a/doc/source/users/proxies/key_manager.rst +++ b/doc/source/user/proxies/key_manager.rst @@ -2,7 +2,7 @@ KeyManager API ============== For details on how to use key_management, see -:doc:`/users/guides/key_manager` +:doc:`/user/guides/key_manager` .. automodule:: openstack.key_manager.v1._proxy diff --git a/doc/source/users/proxies/load_balancer_v2.rst b/doc/source/user/proxies/load_balancer_v2.rst similarity index 100% rename from doc/source/users/proxies/load_balancer_v2.rst rename to doc/source/user/proxies/load_balancer_v2.rst diff --git a/doc/source/users/proxies/message_v1.rst b/doc/source/user/proxies/message_v1.rst similarity index 92% rename from doc/source/users/proxies/message_v1.rst rename to doc/source/user/proxies/message_v1.rst index 3803eaf24..42ed3ff7b 100644 --- a/doc/source/users/proxies/message_v1.rst +++ b/doc/source/user/proxies/message_v1.rst @@ -1,7 +1,7 @@ Message API v1 ============== -For details on how to use message, see :doc:`/users/guides/message` +For details on how to use message, see :doc:`/user/guides/message` .. automodule:: openstack.message.v1._proxy diff --git a/doc/source/users/proxies/message_v2.rst b/doc/source/user/proxies/message_v2.rst similarity index 96% rename from doc/source/users/proxies/message_v2.rst rename to doc/source/user/proxies/message_v2.rst index 5575663a9..dbf1f4778 100644 --- a/doc/source/users/proxies/message_v2.rst +++ b/doc/source/user/proxies/message_v2.rst @@ -1,7 +1,7 @@ Message API v2 ============== -For details on how to use message, see :doc:`/users/guides/message` +For details on how to use message, see :doc:`/user/guides/message` .. automodule:: openstack.message.v2._proxy diff --git a/doc/source/users/proxies/meter.rst b/doc/source/user/proxies/meter.rst similarity index 97% rename from doc/source/users/proxies/meter.rst rename to doc/source/user/proxies/meter.rst index a08e6f211..4a2f3a1bf 100644 --- a/doc/source/users/proxies/meter.rst +++ b/doc/source/user/proxies/meter.rst @@ -4,7 +4,7 @@ Meter API .. caution:: BETA: This API is a work in progress and is subject to change. -For details on how to use meter, see :doc:`/users/guides/meter` +For details on how to use meter, see :doc:`/user/guides/meter` .. automodule:: openstack.meter.v2._proxy diff --git a/doc/source/users/proxies/metric.rst b/doc/source/user/proxies/metric.rst similarity index 100% rename from doc/source/users/proxies/metric.rst rename to doc/source/user/proxies/metric.rst diff --git a/doc/source/users/proxies/network.rst b/doc/source/user/proxies/network.rst similarity index 99% rename from doc/source/users/proxies/network.rst rename to doc/source/user/proxies/network.rst index 20f895772..5bce51b28 100644 --- a/doc/source/users/proxies/network.rst +++ b/doc/source/user/proxies/network.rst @@ -1,7 +1,7 @@ Network API =========== -For details on how to use network, see :doc:`/users/guides/network` +For details on how to use network, see :doc:`/user/guides/network` .. automodule:: openstack.network.v2._proxy diff --git a/doc/source/users/proxies/object_store.rst b/doc/source/user/proxies/object_store.rst similarity index 96% rename from doc/source/users/proxies/object_store.rst rename to doc/source/user/proxies/object_store.rst index db685e4b9..ca6e28b34 100644 --- a/doc/source/users/proxies/object_store.rst +++ b/doc/source/user/proxies/object_store.rst @@ -1,7 +1,7 @@ Object Store API ================ -For details on how to use this API, see :doc:`/users/guides/object_store` +For details on how to use this API, see :doc:`/user/guides/object_store` .. automodule:: openstack.object_store.v1._proxy diff --git a/doc/source/users/proxies/orchestration.rst b/doc/source/user/proxies/orchestration.rst similarity index 96% rename from doc/source/users/proxies/orchestration.rst rename to doc/source/user/proxies/orchestration.rst index e663e64ed..9c2a9dbd9 100644 --- a/doc/source/users/proxies/orchestration.rst +++ b/doc/source/user/proxies/orchestration.rst @@ -1,7 +1,7 @@ Orchestration API ================= -For details on how to use orchestration, see :doc:`/users/guides/orchestration` +For details on how to use orchestration, see :doc:`/user/guides/orchestration` .. automodule:: openstack.orchestration.v1._proxy diff --git a/doc/source/users/proxies/workflow.rst b/doc/source/user/proxies/workflow.rst similarity index 100% rename from doc/source/users/proxies/workflow.rst rename to doc/source/user/proxies/workflow.rst diff --git a/doc/source/users/resource.rst b/doc/source/user/resource.rst similarity index 100% rename from doc/source/users/resource.rst rename to doc/source/user/resource.rst diff --git a/doc/source/users/resource2.rst b/doc/source/user/resource2.rst similarity index 100% rename from doc/source/users/resource2.rst rename to doc/source/user/resource2.rst diff --git a/doc/source/users/resources/baremetal/index.rst b/doc/source/user/resources/baremetal/index.rst similarity index 100% rename from doc/source/users/resources/baremetal/index.rst rename to doc/source/user/resources/baremetal/index.rst diff --git a/doc/source/users/resources/baremetal/v1/chassis.rst b/doc/source/user/resources/baremetal/v1/chassis.rst similarity index 100% rename from doc/source/users/resources/baremetal/v1/chassis.rst rename to doc/source/user/resources/baremetal/v1/chassis.rst diff --git a/doc/source/users/resources/baremetal/v1/driver.rst b/doc/source/user/resources/baremetal/v1/driver.rst similarity index 100% rename from doc/source/users/resources/baremetal/v1/driver.rst rename to doc/source/user/resources/baremetal/v1/driver.rst diff --git a/doc/source/users/resources/baremetal/v1/node.rst b/doc/source/user/resources/baremetal/v1/node.rst similarity index 100% rename from doc/source/users/resources/baremetal/v1/node.rst rename to doc/source/user/resources/baremetal/v1/node.rst diff --git a/doc/source/users/resources/baremetal/v1/port.rst b/doc/source/user/resources/baremetal/v1/port.rst similarity index 100% rename from doc/source/users/resources/baremetal/v1/port.rst rename to doc/source/user/resources/baremetal/v1/port.rst diff --git a/doc/source/users/resources/baremetal/v1/port_group.rst b/doc/source/user/resources/baremetal/v1/port_group.rst similarity index 100% rename from doc/source/users/resources/baremetal/v1/port_group.rst rename to doc/source/user/resources/baremetal/v1/port_group.rst diff --git a/doc/source/users/resources/block_storage/index.rst b/doc/source/user/resources/block_storage/index.rst similarity index 100% rename from doc/source/users/resources/block_storage/index.rst rename to doc/source/user/resources/block_storage/index.rst diff --git a/doc/source/users/resources/block_storage/v2/snapshot.rst b/doc/source/user/resources/block_storage/v2/snapshot.rst similarity index 100% rename from doc/source/users/resources/block_storage/v2/snapshot.rst rename to doc/source/user/resources/block_storage/v2/snapshot.rst diff --git a/doc/source/users/resources/block_storage/v2/type.rst b/doc/source/user/resources/block_storage/v2/type.rst similarity index 100% rename from doc/source/users/resources/block_storage/v2/type.rst rename to doc/source/user/resources/block_storage/v2/type.rst diff --git a/doc/source/users/resources/block_storage/v2/volume.rst b/doc/source/user/resources/block_storage/v2/volume.rst similarity index 100% rename from doc/source/users/resources/block_storage/v2/volume.rst rename to doc/source/user/resources/block_storage/v2/volume.rst diff --git a/doc/source/users/resources/clustering/index.rst b/doc/source/user/resources/clustering/index.rst similarity index 100% rename from doc/source/users/resources/clustering/index.rst rename to doc/source/user/resources/clustering/index.rst diff --git a/doc/source/users/resources/clustering/v1/action.rst b/doc/source/user/resources/clustering/v1/action.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/action.rst rename to doc/source/user/resources/clustering/v1/action.rst diff --git a/doc/source/users/resources/clustering/v1/build_info.rst b/doc/source/user/resources/clustering/v1/build_info.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/build_info.rst rename to doc/source/user/resources/clustering/v1/build_info.rst diff --git a/doc/source/users/resources/clustering/v1/cluster.rst b/doc/source/user/resources/clustering/v1/cluster.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/cluster.rst rename to doc/source/user/resources/clustering/v1/cluster.rst diff --git a/doc/source/users/resources/clustering/v1/cluster_policy.rst b/doc/source/user/resources/clustering/v1/cluster_policy.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/cluster_policy.rst rename to doc/source/user/resources/clustering/v1/cluster_policy.rst diff --git a/doc/source/users/resources/clustering/v1/event.rst b/doc/source/user/resources/clustering/v1/event.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/event.rst rename to doc/source/user/resources/clustering/v1/event.rst diff --git a/doc/source/users/resources/clustering/v1/node.rst b/doc/source/user/resources/clustering/v1/node.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/node.rst rename to doc/source/user/resources/clustering/v1/node.rst diff --git a/doc/source/users/resources/clustering/v1/policy.rst b/doc/source/user/resources/clustering/v1/policy.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/policy.rst rename to doc/source/user/resources/clustering/v1/policy.rst diff --git a/doc/source/users/resources/clustering/v1/policy_type.rst b/doc/source/user/resources/clustering/v1/policy_type.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/policy_type.rst rename to doc/source/user/resources/clustering/v1/policy_type.rst diff --git a/doc/source/users/resources/clustering/v1/profile.rst b/doc/source/user/resources/clustering/v1/profile.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/profile.rst rename to doc/source/user/resources/clustering/v1/profile.rst diff --git a/doc/source/users/resources/clustering/v1/profile_type.rst b/doc/source/user/resources/clustering/v1/profile_type.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/profile_type.rst rename to doc/source/user/resources/clustering/v1/profile_type.rst diff --git a/doc/source/users/resources/clustering/v1/receiver.rst b/doc/source/user/resources/clustering/v1/receiver.rst similarity index 100% rename from doc/source/users/resources/clustering/v1/receiver.rst rename to doc/source/user/resources/clustering/v1/receiver.rst diff --git a/doc/source/users/resources/compute/index.rst b/doc/source/user/resources/compute/index.rst similarity index 100% rename from doc/source/users/resources/compute/index.rst rename to doc/source/user/resources/compute/index.rst diff --git a/doc/source/users/resources/compute/v2/extension.rst b/doc/source/user/resources/compute/v2/extension.rst similarity index 100% rename from doc/source/users/resources/compute/v2/extension.rst rename to doc/source/user/resources/compute/v2/extension.rst diff --git a/doc/source/users/resources/compute/v2/flavor.rst b/doc/source/user/resources/compute/v2/flavor.rst similarity index 100% rename from doc/source/users/resources/compute/v2/flavor.rst rename to doc/source/user/resources/compute/v2/flavor.rst diff --git a/doc/source/users/resources/compute/v2/image.rst b/doc/source/user/resources/compute/v2/image.rst similarity index 100% rename from doc/source/users/resources/compute/v2/image.rst rename to doc/source/user/resources/compute/v2/image.rst diff --git a/doc/source/users/resources/compute/v2/keypair.rst b/doc/source/user/resources/compute/v2/keypair.rst similarity index 100% rename from doc/source/users/resources/compute/v2/keypair.rst rename to doc/source/user/resources/compute/v2/keypair.rst diff --git a/doc/source/users/resources/compute/v2/limits.rst b/doc/source/user/resources/compute/v2/limits.rst similarity index 100% rename from doc/source/users/resources/compute/v2/limits.rst rename to doc/source/user/resources/compute/v2/limits.rst diff --git a/doc/source/users/resources/compute/v2/server.rst b/doc/source/user/resources/compute/v2/server.rst similarity index 100% rename from doc/source/users/resources/compute/v2/server.rst rename to doc/source/user/resources/compute/v2/server.rst diff --git a/doc/source/users/resources/compute/v2/server_interface.rst b/doc/source/user/resources/compute/v2/server_interface.rst similarity index 100% rename from doc/source/users/resources/compute/v2/server_interface.rst rename to doc/source/user/resources/compute/v2/server_interface.rst diff --git a/doc/source/users/resources/compute/v2/server_ip.rst b/doc/source/user/resources/compute/v2/server_ip.rst similarity index 100% rename from doc/source/users/resources/compute/v2/server_ip.rst rename to doc/source/user/resources/compute/v2/server_ip.rst diff --git a/doc/source/users/resources/database/index.rst b/doc/source/user/resources/database/index.rst similarity index 100% rename from doc/source/users/resources/database/index.rst rename to doc/source/user/resources/database/index.rst diff --git a/doc/source/users/resources/database/v1/database.rst b/doc/source/user/resources/database/v1/database.rst similarity index 100% rename from doc/source/users/resources/database/v1/database.rst rename to doc/source/user/resources/database/v1/database.rst diff --git a/doc/source/users/resources/database/v1/flavor.rst b/doc/source/user/resources/database/v1/flavor.rst similarity index 100% rename from doc/source/users/resources/database/v1/flavor.rst rename to doc/source/user/resources/database/v1/flavor.rst diff --git a/doc/source/users/resources/database/v1/instance.rst b/doc/source/user/resources/database/v1/instance.rst similarity index 100% rename from doc/source/users/resources/database/v1/instance.rst rename to doc/source/user/resources/database/v1/instance.rst diff --git a/doc/source/users/resources/database/v1/user.rst b/doc/source/user/resources/database/v1/user.rst similarity index 100% rename from doc/source/users/resources/database/v1/user.rst rename to doc/source/user/resources/database/v1/user.rst diff --git a/doc/source/users/resources/identity/index.rst b/doc/source/user/resources/identity/index.rst similarity index 100% rename from doc/source/users/resources/identity/index.rst rename to doc/source/user/resources/identity/index.rst diff --git a/doc/source/users/resources/identity/v2/extension.rst b/doc/source/user/resources/identity/v2/extension.rst similarity index 100% rename from doc/source/users/resources/identity/v2/extension.rst rename to doc/source/user/resources/identity/v2/extension.rst diff --git a/doc/source/users/resources/identity/v2/role.rst b/doc/source/user/resources/identity/v2/role.rst similarity index 100% rename from doc/source/users/resources/identity/v2/role.rst rename to doc/source/user/resources/identity/v2/role.rst diff --git a/doc/source/users/resources/identity/v2/tenant.rst b/doc/source/user/resources/identity/v2/tenant.rst similarity index 100% rename from doc/source/users/resources/identity/v2/tenant.rst rename to doc/source/user/resources/identity/v2/tenant.rst diff --git a/doc/source/users/resources/identity/v2/user.rst b/doc/source/user/resources/identity/v2/user.rst similarity index 100% rename from doc/source/users/resources/identity/v2/user.rst rename to doc/source/user/resources/identity/v2/user.rst diff --git a/doc/source/users/resources/identity/v3/credential.rst b/doc/source/user/resources/identity/v3/credential.rst similarity index 100% rename from doc/source/users/resources/identity/v3/credential.rst rename to doc/source/user/resources/identity/v3/credential.rst diff --git a/doc/source/users/resources/identity/v3/domain.rst b/doc/source/user/resources/identity/v3/domain.rst similarity index 100% rename from doc/source/users/resources/identity/v3/domain.rst rename to doc/source/user/resources/identity/v3/domain.rst diff --git a/doc/source/users/resources/identity/v3/endpoint.rst b/doc/source/user/resources/identity/v3/endpoint.rst similarity index 100% rename from doc/source/users/resources/identity/v3/endpoint.rst rename to doc/source/user/resources/identity/v3/endpoint.rst diff --git a/doc/source/users/resources/identity/v3/group.rst b/doc/source/user/resources/identity/v3/group.rst similarity index 100% rename from doc/source/users/resources/identity/v3/group.rst rename to doc/source/user/resources/identity/v3/group.rst diff --git a/doc/source/users/resources/identity/v3/policy.rst b/doc/source/user/resources/identity/v3/policy.rst similarity index 100% rename from doc/source/users/resources/identity/v3/policy.rst rename to doc/source/user/resources/identity/v3/policy.rst diff --git a/doc/source/users/resources/identity/v3/project.rst b/doc/source/user/resources/identity/v3/project.rst similarity index 100% rename from doc/source/users/resources/identity/v3/project.rst rename to doc/source/user/resources/identity/v3/project.rst diff --git a/doc/source/users/resources/identity/v3/service.rst b/doc/source/user/resources/identity/v3/service.rst similarity index 100% rename from doc/source/users/resources/identity/v3/service.rst rename to doc/source/user/resources/identity/v3/service.rst diff --git a/doc/source/users/resources/identity/v3/trust.rst b/doc/source/user/resources/identity/v3/trust.rst similarity index 100% rename from doc/source/users/resources/identity/v3/trust.rst rename to doc/source/user/resources/identity/v3/trust.rst diff --git a/doc/source/users/resources/identity/v3/user.rst b/doc/source/user/resources/identity/v3/user.rst similarity index 100% rename from doc/source/users/resources/identity/v3/user.rst rename to doc/source/user/resources/identity/v3/user.rst diff --git a/doc/source/users/resources/image/index.rst b/doc/source/user/resources/image/index.rst similarity index 100% rename from doc/source/users/resources/image/index.rst rename to doc/source/user/resources/image/index.rst diff --git a/doc/source/users/resources/image/v1/image.rst b/doc/source/user/resources/image/v1/image.rst similarity index 100% rename from doc/source/users/resources/image/v1/image.rst rename to doc/source/user/resources/image/v1/image.rst diff --git a/doc/source/users/resources/image/v2/image.rst b/doc/source/user/resources/image/v2/image.rst similarity index 100% rename from doc/source/users/resources/image/v2/image.rst rename to doc/source/user/resources/image/v2/image.rst diff --git a/doc/source/users/resources/image/v2/member.rst b/doc/source/user/resources/image/v2/member.rst similarity index 100% rename from doc/source/users/resources/image/v2/member.rst rename to doc/source/user/resources/image/v2/member.rst diff --git a/doc/source/users/resources/key_manager/index.rst b/doc/source/user/resources/key_manager/index.rst similarity index 100% rename from doc/source/users/resources/key_manager/index.rst rename to doc/source/user/resources/key_manager/index.rst diff --git a/doc/source/users/resources/key_manager/v1/container.rst b/doc/source/user/resources/key_manager/v1/container.rst similarity index 100% rename from doc/source/users/resources/key_manager/v1/container.rst rename to doc/source/user/resources/key_manager/v1/container.rst diff --git a/doc/source/users/resources/key_manager/v1/order.rst b/doc/source/user/resources/key_manager/v1/order.rst similarity index 100% rename from doc/source/users/resources/key_manager/v1/order.rst rename to doc/source/user/resources/key_manager/v1/order.rst diff --git a/doc/source/users/resources/key_manager/v1/secret.rst b/doc/source/user/resources/key_manager/v1/secret.rst similarity index 100% rename from doc/source/users/resources/key_manager/v1/secret.rst rename to doc/source/user/resources/key_manager/v1/secret.rst diff --git a/doc/source/users/resources/load_balancer/index.rst b/doc/source/user/resources/load_balancer/index.rst similarity index 100% rename from doc/source/users/resources/load_balancer/index.rst rename to doc/source/user/resources/load_balancer/index.rst diff --git a/doc/source/users/resources/load_balancer/v2/health_monitor.rst b/doc/source/user/resources/load_balancer/v2/health_monitor.rst similarity index 100% rename from doc/source/users/resources/load_balancer/v2/health_monitor.rst rename to doc/source/user/resources/load_balancer/v2/health_monitor.rst diff --git a/doc/source/users/resources/load_balancer/v2/l7_policy.rst b/doc/source/user/resources/load_balancer/v2/l7_policy.rst similarity index 100% rename from doc/source/users/resources/load_balancer/v2/l7_policy.rst rename to doc/source/user/resources/load_balancer/v2/l7_policy.rst diff --git a/doc/source/users/resources/load_balancer/v2/l7_rule.rst b/doc/source/user/resources/load_balancer/v2/l7_rule.rst similarity index 100% rename from doc/source/users/resources/load_balancer/v2/l7_rule.rst rename to doc/source/user/resources/load_balancer/v2/l7_rule.rst diff --git a/doc/source/users/resources/load_balancer/v2/listener.rst b/doc/source/user/resources/load_balancer/v2/listener.rst similarity index 100% rename from doc/source/users/resources/load_balancer/v2/listener.rst rename to doc/source/user/resources/load_balancer/v2/listener.rst diff --git a/doc/source/users/resources/load_balancer/v2/load_balancer.rst b/doc/source/user/resources/load_balancer/v2/load_balancer.rst similarity index 100% rename from doc/source/users/resources/load_balancer/v2/load_balancer.rst rename to doc/source/user/resources/load_balancer/v2/load_balancer.rst diff --git a/doc/source/users/resources/load_balancer/v2/member.rst b/doc/source/user/resources/load_balancer/v2/member.rst similarity index 100% rename from doc/source/users/resources/load_balancer/v2/member.rst rename to doc/source/user/resources/load_balancer/v2/member.rst diff --git a/doc/source/users/resources/load_balancer/v2/pool.rst b/doc/source/user/resources/load_balancer/v2/pool.rst similarity index 100% rename from doc/source/users/resources/load_balancer/v2/pool.rst rename to doc/source/user/resources/load_balancer/v2/pool.rst diff --git a/doc/source/users/resources/meter/index.rst b/doc/source/user/resources/meter/index.rst similarity index 100% rename from doc/source/users/resources/meter/index.rst rename to doc/source/user/resources/meter/index.rst diff --git a/doc/source/users/resources/meter/v2/capability.rst b/doc/source/user/resources/meter/v2/capability.rst similarity index 100% rename from doc/source/users/resources/meter/v2/capability.rst rename to doc/source/user/resources/meter/v2/capability.rst diff --git a/doc/source/users/resources/meter/v2/meter.rst b/doc/source/user/resources/meter/v2/meter.rst similarity index 100% rename from doc/source/users/resources/meter/v2/meter.rst rename to doc/source/user/resources/meter/v2/meter.rst diff --git a/doc/source/users/resources/meter/v2/resource.rst b/doc/source/user/resources/meter/v2/resource.rst similarity index 100% rename from doc/source/users/resources/meter/v2/resource.rst rename to doc/source/user/resources/meter/v2/resource.rst diff --git a/doc/source/users/resources/meter/v2/sample.rst b/doc/source/user/resources/meter/v2/sample.rst similarity index 100% rename from doc/source/users/resources/meter/v2/sample.rst rename to doc/source/user/resources/meter/v2/sample.rst diff --git a/doc/source/users/resources/meter/v2/statistics.rst b/doc/source/user/resources/meter/v2/statistics.rst similarity index 100% rename from doc/source/users/resources/meter/v2/statistics.rst rename to doc/source/user/resources/meter/v2/statistics.rst diff --git a/doc/source/users/resources/metric/index.rst b/doc/source/user/resources/metric/index.rst similarity index 100% rename from doc/source/users/resources/metric/index.rst rename to doc/source/user/resources/metric/index.rst diff --git a/doc/source/users/resources/metric/v1/archive_policy.rst b/doc/source/user/resources/metric/v1/archive_policy.rst similarity index 100% rename from doc/source/users/resources/metric/v1/archive_policy.rst rename to doc/source/user/resources/metric/v1/archive_policy.rst diff --git a/doc/source/users/resources/metric/v1/capabilities.rst b/doc/source/user/resources/metric/v1/capabilities.rst similarity index 100% rename from doc/source/users/resources/metric/v1/capabilities.rst rename to doc/source/user/resources/metric/v1/capabilities.rst diff --git a/doc/source/users/resources/metric/v1/metric.rst b/doc/source/user/resources/metric/v1/metric.rst similarity index 100% rename from doc/source/users/resources/metric/v1/metric.rst rename to doc/source/user/resources/metric/v1/metric.rst diff --git a/doc/source/users/resources/metric/v1/resource.rst b/doc/source/user/resources/metric/v1/resource.rst similarity index 100% rename from doc/source/users/resources/metric/v1/resource.rst rename to doc/source/user/resources/metric/v1/resource.rst diff --git a/doc/source/users/resources/network/index.rst b/doc/source/user/resources/network/index.rst similarity index 100% rename from doc/source/users/resources/network/index.rst rename to doc/source/user/resources/network/index.rst diff --git a/doc/source/users/resources/network/v2/address_scope.rst b/doc/source/user/resources/network/v2/address_scope.rst similarity index 100% rename from doc/source/users/resources/network/v2/address_scope.rst rename to doc/source/user/resources/network/v2/address_scope.rst diff --git a/doc/source/users/resources/network/v2/agent.rst b/doc/source/user/resources/network/v2/agent.rst similarity index 100% rename from doc/source/users/resources/network/v2/agent.rst rename to doc/source/user/resources/network/v2/agent.rst diff --git a/doc/source/users/resources/network/v2/auto_allocated_topology.rst b/doc/source/user/resources/network/v2/auto_allocated_topology.rst similarity index 100% rename from doc/source/users/resources/network/v2/auto_allocated_topology.rst rename to doc/source/user/resources/network/v2/auto_allocated_topology.rst diff --git a/doc/source/users/resources/network/v2/availability_zone.rst b/doc/source/user/resources/network/v2/availability_zone.rst similarity index 100% rename from doc/source/users/resources/network/v2/availability_zone.rst rename to doc/source/user/resources/network/v2/availability_zone.rst diff --git a/doc/source/users/resources/network/v2/extension.rst b/doc/source/user/resources/network/v2/extension.rst similarity index 100% rename from doc/source/users/resources/network/v2/extension.rst rename to doc/source/user/resources/network/v2/extension.rst diff --git a/doc/source/users/resources/network/v2/flavor.rst b/doc/source/user/resources/network/v2/flavor.rst similarity index 100% rename from doc/source/users/resources/network/v2/flavor.rst rename to doc/source/user/resources/network/v2/flavor.rst diff --git a/doc/source/users/resources/network/v2/floating_ip.rst b/doc/source/user/resources/network/v2/floating_ip.rst similarity index 100% rename from doc/source/users/resources/network/v2/floating_ip.rst rename to doc/source/user/resources/network/v2/floating_ip.rst diff --git a/doc/source/users/resources/network/v2/health_monitor.rst b/doc/source/user/resources/network/v2/health_monitor.rst similarity index 100% rename from doc/source/users/resources/network/v2/health_monitor.rst rename to doc/source/user/resources/network/v2/health_monitor.rst diff --git a/doc/source/users/resources/network/v2/listener.rst b/doc/source/user/resources/network/v2/listener.rst similarity index 100% rename from doc/source/users/resources/network/v2/listener.rst rename to doc/source/user/resources/network/v2/listener.rst diff --git a/doc/source/users/resources/network/v2/load_balancer.rst b/doc/source/user/resources/network/v2/load_balancer.rst similarity index 100% rename from doc/source/users/resources/network/v2/load_balancer.rst rename to doc/source/user/resources/network/v2/load_balancer.rst diff --git a/doc/source/users/resources/network/v2/metering_label.rst b/doc/source/user/resources/network/v2/metering_label.rst similarity index 100% rename from doc/source/users/resources/network/v2/metering_label.rst rename to doc/source/user/resources/network/v2/metering_label.rst diff --git a/doc/source/users/resources/network/v2/metering_label_rule.rst b/doc/source/user/resources/network/v2/metering_label_rule.rst similarity index 100% rename from doc/source/users/resources/network/v2/metering_label_rule.rst rename to doc/source/user/resources/network/v2/metering_label_rule.rst diff --git a/doc/source/users/resources/network/v2/network.rst b/doc/source/user/resources/network/v2/network.rst similarity index 100% rename from doc/source/users/resources/network/v2/network.rst rename to doc/source/user/resources/network/v2/network.rst diff --git a/doc/source/users/resources/network/v2/network_ip_availability.rst b/doc/source/user/resources/network/v2/network_ip_availability.rst similarity index 100% rename from doc/source/users/resources/network/v2/network_ip_availability.rst rename to doc/source/user/resources/network/v2/network_ip_availability.rst diff --git a/doc/source/users/resources/network/v2/pool.rst b/doc/source/user/resources/network/v2/pool.rst similarity index 100% rename from doc/source/users/resources/network/v2/pool.rst rename to doc/source/user/resources/network/v2/pool.rst diff --git a/doc/source/users/resources/network/v2/pool_member.rst b/doc/source/user/resources/network/v2/pool_member.rst similarity index 100% rename from doc/source/users/resources/network/v2/pool_member.rst rename to doc/source/user/resources/network/v2/pool_member.rst diff --git a/doc/source/users/resources/network/v2/port.rst b/doc/source/user/resources/network/v2/port.rst similarity index 100% rename from doc/source/users/resources/network/v2/port.rst rename to doc/source/user/resources/network/v2/port.rst diff --git a/doc/source/users/resources/network/v2/qos_bandwidth_limit_rule.rst b/doc/source/user/resources/network/v2/qos_bandwidth_limit_rule.rst similarity index 100% rename from doc/source/users/resources/network/v2/qos_bandwidth_limit_rule.rst rename to doc/source/user/resources/network/v2/qos_bandwidth_limit_rule.rst diff --git a/doc/source/users/resources/network/v2/qos_dscp_marking_rule.rst b/doc/source/user/resources/network/v2/qos_dscp_marking_rule.rst similarity index 100% rename from doc/source/users/resources/network/v2/qos_dscp_marking_rule.rst rename to doc/source/user/resources/network/v2/qos_dscp_marking_rule.rst diff --git a/doc/source/users/resources/network/v2/qos_minimum_bandwidth_rule.rst b/doc/source/user/resources/network/v2/qos_minimum_bandwidth_rule.rst similarity index 100% rename from doc/source/users/resources/network/v2/qos_minimum_bandwidth_rule.rst rename to doc/source/user/resources/network/v2/qos_minimum_bandwidth_rule.rst diff --git a/doc/source/users/resources/network/v2/qos_policy.rst b/doc/source/user/resources/network/v2/qos_policy.rst similarity index 100% rename from doc/source/users/resources/network/v2/qos_policy.rst rename to doc/source/user/resources/network/v2/qos_policy.rst diff --git a/doc/source/users/resources/network/v2/qos_rule_type.rst b/doc/source/user/resources/network/v2/qos_rule_type.rst similarity index 100% rename from doc/source/users/resources/network/v2/qos_rule_type.rst rename to doc/source/user/resources/network/v2/qos_rule_type.rst diff --git a/doc/source/users/resources/network/v2/quota.rst b/doc/source/user/resources/network/v2/quota.rst similarity index 100% rename from doc/source/users/resources/network/v2/quota.rst rename to doc/source/user/resources/network/v2/quota.rst diff --git a/doc/source/users/resources/network/v2/rbac_policy.rst b/doc/source/user/resources/network/v2/rbac_policy.rst similarity index 100% rename from doc/source/users/resources/network/v2/rbac_policy.rst rename to doc/source/user/resources/network/v2/rbac_policy.rst diff --git a/doc/source/users/resources/network/v2/router.rst b/doc/source/user/resources/network/v2/router.rst similarity index 100% rename from doc/source/users/resources/network/v2/router.rst rename to doc/source/user/resources/network/v2/router.rst diff --git a/doc/source/users/resources/network/v2/security_group.rst b/doc/source/user/resources/network/v2/security_group.rst similarity index 100% rename from doc/source/users/resources/network/v2/security_group.rst rename to doc/source/user/resources/network/v2/security_group.rst diff --git a/doc/source/users/resources/network/v2/security_group_rule.rst b/doc/source/user/resources/network/v2/security_group_rule.rst similarity index 100% rename from doc/source/users/resources/network/v2/security_group_rule.rst rename to doc/source/user/resources/network/v2/security_group_rule.rst diff --git a/doc/source/users/resources/network/v2/segment.rst b/doc/source/user/resources/network/v2/segment.rst similarity index 100% rename from doc/source/users/resources/network/v2/segment.rst rename to doc/source/user/resources/network/v2/segment.rst diff --git a/doc/source/users/resources/network/v2/service_profile.rst b/doc/source/user/resources/network/v2/service_profile.rst similarity index 100% rename from doc/source/users/resources/network/v2/service_profile.rst rename to doc/source/user/resources/network/v2/service_profile.rst diff --git a/doc/source/users/resources/network/v2/service_provider.rst b/doc/source/user/resources/network/v2/service_provider.rst similarity index 100% rename from doc/source/users/resources/network/v2/service_provider.rst rename to doc/source/user/resources/network/v2/service_provider.rst diff --git a/doc/source/users/resources/network/v2/subnet.rst b/doc/source/user/resources/network/v2/subnet.rst similarity index 100% rename from doc/source/users/resources/network/v2/subnet.rst rename to doc/source/user/resources/network/v2/subnet.rst diff --git a/doc/source/users/resources/network/v2/subnet_pool.rst b/doc/source/user/resources/network/v2/subnet_pool.rst similarity index 100% rename from doc/source/users/resources/network/v2/subnet_pool.rst rename to doc/source/user/resources/network/v2/subnet_pool.rst diff --git a/doc/source/users/resources/object_store/index.rst b/doc/source/user/resources/object_store/index.rst similarity index 100% rename from doc/source/users/resources/object_store/index.rst rename to doc/source/user/resources/object_store/index.rst diff --git a/doc/source/users/resources/object_store/v1/account.rst b/doc/source/user/resources/object_store/v1/account.rst similarity index 100% rename from doc/source/users/resources/object_store/v1/account.rst rename to doc/source/user/resources/object_store/v1/account.rst diff --git a/doc/source/users/resources/object_store/v1/container.rst b/doc/source/user/resources/object_store/v1/container.rst similarity index 100% rename from doc/source/users/resources/object_store/v1/container.rst rename to doc/source/user/resources/object_store/v1/container.rst diff --git a/doc/source/users/resources/object_store/v1/obj.rst b/doc/source/user/resources/object_store/v1/obj.rst similarity index 100% rename from doc/source/users/resources/object_store/v1/obj.rst rename to doc/source/user/resources/object_store/v1/obj.rst diff --git a/doc/source/users/resources/orchestration/index.rst b/doc/source/user/resources/orchestration/index.rst similarity index 100% rename from doc/source/users/resources/orchestration/index.rst rename to doc/source/user/resources/orchestration/index.rst diff --git a/doc/source/users/resources/orchestration/v1/resource.rst b/doc/source/user/resources/orchestration/v1/resource.rst similarity index 100% rename from doc/source/users/resources/orchestration/v1/resource.rst rename to doc/source/user/resources/orchestration/v1/resource.rst diff --git a/doc/source/users/resources/orchestration/v1/stack.rst b/doc/source/user/resources/orchestration/v1/stack.rst similarity index 100% rename from doc/source/users/resources/orchestration/v1/stack.rst rename to doc/source/user/resources/orchestration/v1/stack.rst diff --git a/doc/source/users/resources/workflow/index.rst b/doc/source/user/resources/workflow/index.rst similarity index 100% rename from doc/source/users/resources/workflow/index.rst rename to doc/source/user/resources/workflow/index.rst diff --git a/doc/source/users/resources/workflow/v2/execution.rst b/doc/source/user/resources/workflow/v2/execution.rst similarity index 100% rename from doc/source/users/resources/workflow/v2/execution.rst rename to doc/source/user/resources/workflow/v2/execution.rst diff --git a/doc/source/users/resources/workflow/v2/workflow.rst b/doc/source/user/resources/workflow/v2/workflow.rst similarity index 100% rename from doc/source/users/resources/workflow/v2/workflow.rst rename to doc/source/user/resources/workflow/v2/workflow.rst diff --git a/doc/source/users/service_filter.rst b/doc/source/user/service_filter.rst similarity index 100% rename from doc/source/users/service_filter.rst rename to doc/source/user/service_filter.rst diff --git a/doc/source/users/utils.rst b/doc/source/user/utils.rst similarity index 100% rename from doc/source/users/utils.rst rename to doc/source/user/utils.rst diff --git a/doc/source/users/examples b/doc/source/users/examples deleted file mode 120000 index d4cb9b9c8..000000000 --- a/doc/source/users/examples +++ /dev/null @@ -1 +0,0 @@ -../../../examples/ \ No newline at end of file diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst deleted file mode 100644 index ded0ad57f..000000000 --- a/doc/source/users/index.rst +++ /dev/null @@ -1,139 +0,0 @@ -Getting started with the OpenStack SDK -====================================== - -For a listing of terms used throughout the SDK, including the names of -projects and services supported by it, see the :doc:`glossary <../glossary>`. - -Installation ------------- - -The OpenStack SDK is available on -`PyPI `_ under the name -**openstacksdk**. To install it, use ``pip``:: - - $ pip install openstacksdk - -.. _user_guides: - -User Guides ------------ - -These guides walk you through how to make use of the libraries we provide -to work with each OpenStack service. If you're looking for a cookbook -approach, this is where you'll want to begin. - -.. toctree:: - :maxdepth: 1 - - Connect to an OpenStack Cloud - Connect to an OpenStack Cloud Using a Config File - Logging - Baremetal - Block Storage - Clustering - Compute - Database - Identity - Image - Key Manager - Message - Meter - Network - Object Store - Orchestration - -API Documentation ------------------ - -Service APIs are exposed through a two-layered approach. The classes -exposed through our *Connection* interface are the place to start if you're -an application developer consuming an OpenStack cloud. The *Resource* -interface is the layer upon which the *Connection* is built, with -*Connection* methods accepting and returning *Resource* objects. - -Connection Interface -******************** - -A *Connection* instance maintains your cloud config, session and authentication -information providing you with a set of higher-level interfaces to work with -OpenStack services. - -.. toctree:: - :maxdepth: 1 - - connection - -Once you have a *Connection* instance, the following services may be exposed -to you. The combination of your ``CloudRegion`` and the catalog of the cloud -in question control which services are exposed, but listed below are the ones -provided by the SDK. - -.. toctree:: - :maxdepth: 1 - - Baremetal - Block Storage - Clustering - Compute - Database - Identity v2 - Identity v3 - Image v1 - Image v2 - Key Manager - Load Balancer - Message v1 - Message v2 - Network - Meter - Metric - Object Store - Orchestration - Workflow - -Resource Interface -****************** - -The *Resource* layer is a lower-level interface to communicate with OpenStack -services. While the classes exposed by the *Connection* build a convenience -layer on top of this, *Resources* can be used directly. However, the most -common usage of this layer is in receiving an object from a class in the -*Connection* layer, modifying it, and sending it back into the *Connection* -layer, such as to update a resource on the server. - -The following services have exposed *Resource* classes. - -.. toctree:: - :maxdepth: 1 - - Baremetal - Block Storage - Clustering - Compute - Database - Identity - Image - Key Management - Load Balancer - Meter - Metric - Network - Orchestration - Object Store - Workflow - -Low-Level Classes -***************** - -The following classes are not commonly used by application developers, -but are used to construct applications to talk to OpenStack APIs. Typically -these parts are managed through the `Connection Interface`_, but their use -can be customized. - -.. toctree:: - :maxdepth: 1 - - resource - resource2 - service_filter - utils diff --git a/examples/cloud/cleanup-servers.py b/examples/cloud/cleanup-servers.py new file mode 100644 index 000000000..7f9257b58 --- /dev/null +++ b/examples/cloud/cleanup-servers.py @@ -0,0 +1,26 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack + +# Initialize and turn on debug logging +openstack.simple_logging(debug=True) + +for cloud_name, region_name in [ + ('my-vexxhost', 'ca-ymq-1'), + ('my-citycloud', 'Buf1'), + ('my-internap', 'ams01')]: + # Initialize cloud + cloud = openstack.openstack_cloud( + cloud=cloud_name, region_name=region_name) + for server in cloud.search_servers('my-server'): + cloud.delete_server(server, wait=True, delete_ips=True) diff --git a/doc/source/user/examples/create-server-dict.py b/examples/cloud/create-server-dict.py similarity index 52% rename from doc/source/user/examples/create-server-dict.py rename to examples/cloud/create-server-dict.py index 3f9fc8223..4557ee188 100644 --- a/doc/source/user/examples/create-server-dict.py +++ b/examples/cloud/create-server-dict.py @@ -1,7 +1,19 @@ -import openstack.cloud +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack # Initialize and turn on debug logging -openstack.cloud.simple_logging(debug=True) +openstack.simple_logging(debug=True) for cloud_name, region_name, image, flavor_id in [ ('my-vexxhost', 'ca-ymq-1', 'Ubuntu 16.04.1 LTS [2017-03-03]', @@ -11,7 +23,8 @@ for cloud_name, region_name, image, flavor_id in [ ('my-internap', 'ams01', 'Ubuntu 16.04 LTS (Xenial Xerus)', 'A1.4')]: # Initialize cloud - cloud = openstack.openstack_cloud(cloud=cloud_name, region_name=region_name) + cloud = openstack.openstack_cloud( + cloud=cloud_name, region_name=region_name) # Boot a server, wait for it to boot, and then do whatever is needed # to get a public ip for it. diff --git a/doc/source/user/examples/create-server-name-or-id.py b/examples/cloud/create-server-name-or-id.py similarity index 54% rename from doc/source/user/examples/create-server-name-or-id.py rename to examples/cloud/create-server-name-or-id.py index 16c011aa1..a269f2fe6 100644 --- a/doc/source/user/examples/create-server-name-or-id.py +++ b/examples/cloud/create-server-name-or-id.py @@ -1,7 +1,19 @@ -import openstack.cloud +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack # Initialize and turn on debug logging -openstack.cloud.simple_logging(debug=True) +openstack.simple_logging(debug=True) for cloud_name, region_name, image, flavor in [ ('my-vexxhost', 'ca-ymq-1', @@ -11,7 +23,8 @@ for cloud_name, region_name, image, flavor in [ ('my-internap', 'ams01', 'Ubuntu 16.04 LTS (Xenial Xerus)', 'A1.4')]: # Initialize cloud - cloud = openstack.openstack_cloud(cloud=cloud_name, region_name=region_name) + cloud = openstack.openstack_cloud( + cloud=cloud_name, region_name=region_name) cloud.delete_server('my-server', wait=True, delete_ips=True) # Boot a server, wait for it to boot, and then do whatever is needed diff --git a/examples/cloud/debug-logging.py b/examples/cloud/debug-logging.py new file mode 100644 index 000000000..a9cc31c2b --- /dev/null +++ b/examples/cloud/debug-logging.py @@ -0,0 +1,18 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging(debug=True) + +cloud = openstack.openstack_cloud( + cloud='my-vexxhost', region_name='ca-ymq-1') +cloud.get_image('Ubuntu 16.04.1 LTS [2017-03-03]') diff --git a/examples/cloud/find-an-image.py b/examples/cloud/find-an-image.py new file mode 100644 index 000000000..089b08640 --- /dev/null +++ b/examples/cloud/find-an-image.py @@ -0,0 +1,19 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging() + +cloud = openstack.openstack_cloud(cloud='fuga', region_name='cystack') +cloud.pprint([ + image for image in cloud.list_images() + if 'ubuntu' in image.name.lower()]) diff --git a/examples/cloud/http-debug-logging.py b/examples/cloud/http-debug-logging.py new file mode 100644 index 000000000..e5b1a7e9d --- /dev/null +++ b/examples/cloud/http-debug-logging.py @@ -0,0 +1,18 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging(http_debug=True) + +cloud = openstack.openstack_cloud( + cloud='my-vexxhost', region_name='ca-ymq-1') +cloud.get_image('Ubuntu 16.04.1 LTS [2017-03-03]') diff --git a/examples/cloud/munch-dict-object.py b/examples/cloud/munch-dict-object.py new file mode 100644 index 000000000..df3a0e76c --- /dev/null +++ b/examples/cloud/munch-dict-object.py @@ -0,0 +1,19 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging(debug=True) + +cloud = openstack.openstack_cloud(cloud='ovh', region_name='SBG1') +image = cloud.get_image('Ubuntu 16.10') +print(image.name) +print(image['name']) diff --git a/examples/cloud/normalization.py b/examples/cloud/normalization.py new file mode 100644 index 000000000..80f1ff4c9 --- /dev/null +++ b/examples/cloud/normalization.py @@ -0,0 +1,19 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging() + +cloud = openstack.openstack_cloud(cloud='fuga', region_name='cystack') +image = cloud.get_image( + 'Ubuntu 16.04 LTS - Xenial Xerus - 64-bit - Fuga Cloud Based Image') +cloud.pprint(image) diff --git a/doc/source/user/examples/server-information.py b/examples/cloud/server-information.py similarity index 51% rename from doc/source/user/examples/server-information.py rename to examples/cloud/server-information.py index 5d9599d06..8ae710631 100644 --- a/doc/source/user/examples/server-information.py +++ b/examples/cloud/server-information.py @@ -1,5 +1,17 @@ -import openstack.cloud -openstack.cloud.simple_logging(debug=True) +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging(debug=True) cloud = openstack.openstack_cloud(cloud='my-citycloud', region_name='Buf1') try: @@ -20,4 +32,3 @@ try: finally: # Delete it - this is a demo cloud.delete_server(server, wait=True, delete_ips=True) - diff --git a/examples/cloud/service-conditional-overrides.py b/examples/cloud/service-conditional-overrides.py new file mode 100644 index 000000000..7991a1ec3 --- /dev/null +++ b/examples/cloud/service-conditional-overrides.py @@ -0,0 +1,17 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging(debug=True) + +cloud = openstack.openstack_cloud(cloud='rax', region_name='DFW') +print(cloud.has_service('network')) diff --git a/examples/cloud/service-conditionals.py b/examples/cloud/service-conditionals.py new file mode 100644 index 000000000..5e81d1dad --- /dev/null +++ b/examples/cloud/service-conditionals.py @@ -0,0 +1,18 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging(debug=True) + +cloud = openstack.openstack_cloud(cloud='kiss', region_name='region1') +print(cloud.has_service('network')) +print(cloud.has_service('container-orchestration')) diff --git a/examples/cloud/strict-mode.py b/examples/cloud/strict-mode.py new file mode 100644 index 000000000..74cfd05ff --- /dev/null +++ b/examples/cloud/strict-mode.py @@ -0,0 +1,20 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging() + +cloud = openstack.openstack_cloud( + cloud='fuga', region_name='cystack', strict=True) +image = cloud.get_image( + 'Ubuntu 16.04 LTS - Xenial Xerus - 64-bit - Fuga Cloud Based Image') +cloud.pprint(image) diff --git a/examples/cloud/upload-large-object.py b/examples/cloud/upload-large-object.py new file mode 100644 index 000000000..f274c2e7e --- /dev/null +++ b/examples/cloud/upload-large-object.py @@ -0,0 +1,22 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging(debug=True) + +cloud = openstack.openstack_cloud(cloud='ovh', region_name='SBG1') +cloud.create_object( + container='my-container', name='my-object', + filename='/home/mordred/briarcliff.sh3d', + segment_size=1000000) +cloud.delete_object('my-container', 'my-object') +cloud.delete_container('my-container') diff --git a/examples/cloud/upload-object.py b/examples/cloud/upload-object.py new file mode 100644 index 000000000..f274c2e7e --- /dev/null +++ b/examples/cloud/upload-object.py @@ -0,0 +1,22 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging(debug=True) + +cloud = openstack.openstack_cloud(cloud='ovh', region_name='SBG1') +cloud.create_object( + container='my-container', name='my-object', + filename='/home/mordred/briarcliff.sh3d', + segment_size=1000000) +cloud.delete_object('my-container', 'my-object') +cloud.delete_container('my-container') diff --git a/examples/cloud/user-agent.py b/examples/cloud/user-agent.py new file mode 100644 index 000000000..309355b5e --- /dev/null +++ b/examples/cloud/user-agent.py @@ -0,0 +1,18 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import openstack +openstack.simple_logging(http_debug=True) + +cloud = openstack.openstack_cloud( + cloud='datacentred', app_name='AmazingApp', app_version='1.0') +cloud.list_networks() diff --git a/examples/clustering/policy.py b/examples/clustering/policy.py index 0f37820d2..5d7e8b25e 100644 --- a/examples/clustering/policy.py +++ b/examples/clustering/policy.py @@ -14,7 +14,7 @@ Managing policies in the Cluster service. For a full guide see -https://developer.openstack.org/sdks/python/openstacksdk/users/guides/cluster.html +https://developer.openstack.org/sdks/python/openstacksdk/user/guides/cluster.html """ diff --git a/examples/clustering/policy_type.py b/examples/clustering/policy_type.py index 447ecf265..27c06ac6a 100644 --- a/examples/clustering/policy_type.py +++ b/examples/clustering/policy_type.py @@ -14,7 +14,7 @@ Managing policy types in the Cluster service. For a full guide see -https://developer.openstack.org/sdks/python/openstacksdk/users/guides/cluster.html +https://developer.openstack.org/sdks/python/openstacksdk/user/guides/cluster.html """ diff --git a/examples/clustering/profile.py b/examples/clustering/profile.py index 0fad312c5..397374b8c 100644 --- a/examples/clustering/profile.py +++ b/examples/clustering/profile.py @@ -19,7 +19,7 @@ from examples.connect import SERVER_NAME Managing profiles in the Cluster service. For a full guide see -https://developer.openstack.org/sdks/python/openstacksdk/users/guides/cluster.html +https://developer.openstack.org/sdks/python/openstacksdk/user/guides/cluster.html """ diff --git a/examples/clustering/profile_type.py b/examples/clustering/profile_type.py index 2856e4e0f..9f3f3cc26 100644 --- a/examples/clustering/profile_type.py +++ b/examples/clustering/profile_type.py @@ -14,7 +14,7 @@ Managing profile types in the Cluster service. For a full guide see -https://developer.openstack.org/sdks/python/openstacksdk/users/guides/clustering.html +https://developer.openstack.org/sdks/python/openstacksdk/user/guides/clustering.html """ diff --git a/examples/image/create.py b/examples/image/create.py index 45b4bc7d0..c3d64496b 100644 --- a/examples/image/create.py +++ b/examples/image/create.py @@ -16,7 +16,7 @@ from examples.connect import EXAMPLE_IMAGE_NAME Create resources with the Image service. For a full guide see -http://developer.openstack.org/sdks/python/openstacksdk/users/guides/image.html +http://developer.openstack.org/sdks/python/openstacksdk/user/guides/image.html """ diff --git a/examples/image/delete.py b/examples/image/delete.py index dc6560366..6344bf98a 100644 --- a/examples/image/delete.py +++ b/examples/image/delete.py @@ -16,7 +16,7 @@ from examples.connect import EXAMPLE_IMAGE_NAME Delete resources with the Image service. For a full guide see -http://developer.openstack.org/sdks/python/openstacksdk/users/guides/image.html +http://developer.openstack.org/sdks/python/openstacksdk/user/guides/image.html """ diff --git a/examples/image/download.py b/examples/image/download.py index 8b68dd6aa..f1611116f 100644 --- a/examples/image/download.py +++ b/examples/image/download.py @@ -16,7 +16,7 @@ import hashlib Download an image with the Image service. For a full guide see -http://developer.openstack.org/sdks/python/openstacksdk/users/guides/image.html +http://developer.openstack.org/sdks/python/openstacksdk/user/guides/image.html """ diff --git a/examples/image/list.py b/examples/image/list.py index decb6e5d9..843e5f965 100644 --- a/examples/image/list.py +++ b/examples/image/list.py @@ -14,7 +14,7 @@ List resources from the Image service. For a full guide see -http://developer.openstack.org/sdks/python/openstacksdk/users/guides/image.html +http://developer.openstack.org/sdks/python/openstacksdk/user/guides/image.html """