Retag of 9.0.0.0b3

-----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1
 
 iQIcBAABCAAGBQJX2aGhAAoJENQWrRWsa0P+9l4P/jo+3IZJk8O6AaDKTs+AsWGC
 curlZbhmDxpSheD2t2nx2X5PtIU6I6ND8qtIWD5RUIH8pWMD+mNxe9M3GkDU/SZo
 1C53jIM7UZKV4QnDuRD6XptI2ktNvjdcbCMcpjn+daCOuBkxLpwtyyYoNIaMnDDq
 cfwDhKu5Qlq9bUsf1vLh+44A4dF2YUfnzIrYf1kMBuWVV+mr++fMqTkZJmUX/aOK
 aXRAR3ZaDr3mIciySDohe+hyQrA+OZ6f3jS9EwvQC6WeYjjKia5GthLoXEhf8SAs
 Bho2GsgfTkygBzc/xtJQT4OxDO7YIMKmaNOIudWIG9xKhWj4QlhE7vE30HF7zJyt
 SgTwbpfkwR4XWIsai9IAcetvDQwGDlAu+Sk9wIJCCx6Xr+DKRiH3s2ZIhtaVADsE
 fFLh6LwEzRAftw//R/+k9ReLqY7stcWGtY60Gpb6IjSvlvfkieAU5N5EWvMZgtfu
 q6IRuyMQzAhW29z/C/Ox+GvN2bWRFVRbyu6+W+9xUkpNCETe6ipMmbMaG0e5IVXH
 Z7aJ0O5fYgSOpYajVO3nwz2FQRoVNBms01o9C+JEJAv8NLjZBLiSRzuppN0LTj19
 dHiwnVrPJmMtKjXTWniGJhDrbxCgOutAHwx1vMg8G/dcluiRYLlKS4io5zwPkIsQ
 s0kKzIN84PUcTNthblQL
 =X34I
 -----END PGP SIGNATURE-----

Merge tag '9.0.0_b3' into debian/newton

Retag of 9.0.0.0b3

  * New upstream release.
  * Fixed (build-)depends for this release.
  * Fixed namespace list when generating cinder.conf.
  * Using OpenStack's Gerrit as VCS URLs.
  * Rebased nozfs patches.
  * Added PYTHONPATH=. when building sphinx doc.
  * Black list 3 unit tests that non-deterministically fail:
    - test_volume.VolumeMigrationTestCase.test_retype_volume_migration_failed
    - test_volume.VolumeMigrationTestCase.test_retype_volume_migration_bad_policy
    - backup.test_backup.BackupTestCase.test_create_backup_with_temp_snapshot

Change-Id: I6f3b1355821311f8ce301da8e2ab094e902e75cf
This commit is contained in:
Thomas Goirand 2016-09-14 21:16:40 +02:00
commit 50114a2820
866 changed files with 46692 additions and 23360 deletions

1
.gitignore vendored
View File

@ -30,6 +30,7 @@ tags
# Files created by Sphinx build
doc/build
doc/source/_static/cinder.conf.sample
doc/source/drivers.rst
#Files created for API reference
api-ref/build

View File

@ -1,4 +1,5 @@
[gerrit]
host=review.openstack.org
port=29418
project=openstack/cinder.git
project=openstack/deb-cinder.git
defaultbranch=debian/newton

View File

@ -28,6 +28,8 @@ import os
import subprocess
import sys
import openstackdocstheme # noqa
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -41,8 +43,7 @@ sys.path.insert(0, os.path.abspath('./'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'os_api_ref',
'oslosphinx',
'os_api_ref'
]
# The suffix of source filenames.
@ -56,7 +57,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Cinder API Reference'
project = u'Block Storage API Reference'
copyright = u'OpenStack Foundation'
# The version info for the project you're documenting, acts as replacement for
@ -111,6 +112,13 @@ pygments_style = 'sphinx'
# html_theme_path = ["."]
# html_theme = '_theme'
html_theme = 'openstackdocs'
html_theme_path = [openstackdocstheme.get_html_theme_path()]
html_theme_options = {
"sidebar_mode": "toc",
}
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.

18
api-ref/source/index.rst Normal file
View File

@ -0,0 +1,18 @@
=================
Block Storage API
=================
Contents:
.. toctree::
:maxdepth: 1
v1/index
v2/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`

View File

@ -1,8 +1,8 @@
:tocdepth: 2
===============
Cinder API V1
===============
====================
Block Storage API V1
====================
.. rest_expand_all::

View File

@ -9,8 +9,8 @@ Administrators only, depending on policy settings.
Shows, updates, and deletes quotas for a tenant.
Show quota details for user
===========================
Show quota details for user (v1)
================================
.. rest_method:: GET /v1/{tenant_id}/os-quota-sets/{tenant_id}/detail/{user_id}
@ -106,8 +106,8 @@ Response Example
:language: javascript
Show quotas
===========
Show quotas (v1)
================
.. rest_method:: GET /v1/{tenant_id}/os-quota-sets/{tenant_id}
@ -157,8 +157,8 @@ Response Example
:language: javascript
Update quotas
=============
Update quotas (v1)
==================
.. rest_method:: PUT /v1/{tenant_id}/os-quota-sets/{tenant_id}
@ -227,8 +227,8 @@ Response Example
:language: javascript
Delete quotas
=============
Delete quotas (v1)
==================
.. rest_method:: DELETE /v1/{tenant_id}/os-quota-sets/{tenant_id}
@ -250,8 +250,8 @@ Response Example
.. literalinclude:: ./samples/user-quotas-delete-response.json
:language: javascript
Show quotas for user
====================
Show quotas for user (v1)
=========================
.. rest_method:: GET /v1/{tenant_id}/os-quota-sets/{tenant_id}/{user_id}
@ -304,8 +304,8 @@ Response Example
Update quotas for user
======================
Update quotas for user (v1)
===========================
.. rest_method:: POST /v1/{tenant_id}/os-quota-sets/{tenant_id}/{user_id}
@ -375,8 +375,8 @@ Response Example
:language: javascript
Delete quotas for user
======================
Delete quotas for user (v1)
===========================
.. rest_method:: DELETE /v1/{tenant_id}/os-quota-sets/{tenant_id}/{user_id}

View File

@ -430,6 +430,12 @@ name_2:
in: body
required: true
type: string
OS-SCH-HNT:scheduler_hints:
description: |
The dictionary of data to send to the scheduler.
in: body
required: false
type: object
quota_set:
description: |
A ``quota_set`` object.
@ -481,12 +487,6 @@ reserved_1:
in: body
required: true
type: integer
OS-SCH-HNT:scheduler_hints:
description: |
The dictionary of data to send to the scheduler.
in: body
required: false
type: object
security_group_rules:
description: |
The number of rules that are allowed for each

View File

@ -8,8 +8,8 @@ Creates, lists, shows information for, and deletes snapshots. Shows
and updates snapshot metadata.
Show snapshot details
=====================
Show snapshot details (v1)
==========================
.. rest_method:: GET /v1/{tenant_id}/snapshots/{snapshot_id}
@ -34,8 +34,8 @@ Response Example
:language: javascript
Delete snapshot
===============
Delete snapshot (v1)
====================
.. rest_method:: DELETE /v1/{tenant_id}/snapshots/{snapshot_id}
@ -53,8 +53,8 @@ Request
- snapshot_id: snapshot_id
List snapshots with details
===========================
List snapshots with details (v1)
================================
.. rest_method:: GET /v1/{tenant_id}/snapshots/detail
@ -78,8 +78,8 @@ Response Example
:language: javascript
Create snapshot
===============
Create snapshot (v1)
====================
.. rest_method:: POST /v1/{tenant_id}/snapshots
@ -101,8 +101,8 @@ Request Example
.. literalinclude:: ./samples/snapshot-create-request.json
:language: javascript
List snapshots
==============
List snapshots (v1)
===================
.. rest_method:: GET /v1/{tenant_id}/snapshots
@ -128,8 +128,8 @@ Response Example
:language: javascript
Show snapshot metadata
======================
Show snapshot metadata (v1)
===========================
.. rest_method:: GET /v1/{tenant_id}/snapshots/{snapshot_id}/metadata
@ -156,8 +156,8 @@ Response Example
:language: javascript
Update snapshot metadata
========================
Update snapshot metadata (v1)
=============================
.. rest_method:: PUT /v1/{tenant_id}/snapshots/{snapshot_id}/metadata

View File

@ -8,8 +8,8 @@ Lists, creates, updates, shows information for, and deletes volume
types.
List volume types
=================
List volume types (v1)
======================
.. rest_method:: GET /v1/{tenant_id}/types
@ -34,8 +34,8 @@ Response Example
:language: javascript
Create volume type
==================
Create volume type (v1)
=======================
.. rest_method:: POST /v1/{tenant_id}/types
@ -78,8 +78,8 @@ Response Example
:language: javascript
Update volume type
==================
Update volume type (v1)
=======================
.. rest_method:: PUT /v1/{tenant_id}/types/{volume_type_id}
@ -125,8 +125,8 @@ Response Example
:language: javascript
Update extra specs for a volume type
====================================
Update extra specs for a volume type (v1)
=========================================
.. rest_method:: PUT /v1/{tenant_id}/types/{volume_type_id}
@ -171,8 +171,8 @@ Response Example
:language: javascript
Show volume type details
========================
Show volume type details (v1)
=============================
.. rest_method:: GET /v1/{tenant_id}/types/{volume_type_id}
@ -199,8 +199,8 @@ Response Example
:language: javascript
Delete volume type
==================
Delete volume type (v1)
=======================
.. rest_method:: DELETE /v1/{tenant_id}/types/{volume_type_id}

View File

@ -30,8 +30,8 @@ Response Example
:language: javascript
List API versions
=================
List API versions (v1)
======================
.. rest_method:: GET /

View File

@ -10,8 +10,8 @@ volume was not created from a snapshot or source volume, these
values are null.
List volumes, with details
==========================
List volumes, with details (v1)
===============================
.. rest_method:: GET /v1/{tenant_id}/volumes/detail
@ -65,8 +65,8 @@ Response Example
:language: javascript
Create volume
=============
Create volume (v1)
==================
.. rest_method:: POST /v1/{tenant_id}/volumes
@ -122,8 +122,8 @@ Response Parameters
- metadata: metadata
List volumes
============
List volumes (v1)
=================
.. rest_method:: GET /v1/{tenant_id}/volumes
@ -160,8 +160,8 @@ Response Example
:language: javascript
Show volume details
===================
Show volume details (v1)
========================
.. rest_method:: GET /v1/{tenant_id}/volumes/{volume_id}
@ -215,8 +215,8 @@ Response Example
.. literalinclude:: ./samples/volume-show-response.json
:language: javascript
Delete volume
=============
Delete volume (v1)
==================
.. rest_method:: DELETE /v1/{tenant_id}/volumes/{volume_id}

View File

@ -1,8 +1,8 @@
:tocdepth: 2
==============
Volume API V2
==============
====================
Block Storage API V2
====================
.. rest_expand_all::

View File

@ -1055,6 +1055,12 @@ os-reset_status:
in: body
required: true
type: object
OS-SCH-HNT:scheduler_hints:
description: |
The dictionary of data to send to the scheduler.
in: body
required: false
type: object
os-set_image_metadata:
description: |
The ``os-set_image_metadata`` action.
@ -1236,12 +1242,6 @@ restore:
in: body
required: true
type: object
OS-SCH-HNT:scheduler_hints:
description: |
The dictionary of data to send to the scheduler.
in: body
required: false
type: object
security_group_rules:
description: |
The number of rules that are allowed for each

Some files were not shown because too many files have changed in this diff Show More