161 Commits

Author SHA1 Message Date
Jenkins
78adba3d65 Merge "[doc] Update doc index" 2017-04-11 04:25:55 +00:00
TommyLike
e5c45ffbaf [BugFix][Devref] Refactor attach/detach v2 devref
There are some issues around new attach/detach APIs/CLIs,
fix them step by step. Currently the attach/detach dev ref
is out of date and have some format issues.
Refactor attach/detach v2 devref to make it
more readable. This is the original version: [1]

DocImpact
Depends-On: bae8bd017e30425295e03d13b39202a81e923c3e
Closes-Bug: 1675976
[1] https://docs.openstack.org/developer/cinder/devref/attach_detach_conventions_v2.html

Change-Id: I26f8427b38ee08c5da7224df6423956ee9a744d2
2017-03-28 21:53:18 +08:00
lijunbo
0464cb1122 replace references to cinder.openstack.org
Change-Id: I69b75eacef37264a5afeea2cf37f1fe91be9ec13
2017-03-22 13:44:58 +08:00
wangxiyuan
9df0bce1d0 [doc] Update doc index
1. The commit[1] added the "attach_detach_conventions_v2" doc file,
but it missed to be shown in the index.
2. The commit[2] removed "database_architecture" and "oslo-middleware"
files from doc. So we should remove them from the index as well.

[1]: Ie15233c99d91de67279b56d27a5508c5ea98d769
[2]: I145464d0d63cb5a00e0e905083c260fb6621dd89

Change-Id: I077a9d522eee06c864f1458878a794548ed93584
2017-03-22 11:28:33 +08:00
Davanum Srinivas
313b016d7c Fix docs failures caused by latest eventlet
Closes-bug: #1674687

Change-Id: I9c44f84b1eb4f25a2c87612b444d22f12e6f22ce
2017-03-21 13:23:55 -04:00
Gorka Eguileor
a8840280e6 Update devref for OVO version bumping
Our devref is not explicit enough on when a versioned object change
requires a version bump and this is creating confusion in developers and
reviewers.

This patch adds explicitly when bumps are required, when not, and how to
automatically check if it's required or not.

Change-Id: I4dd21c30b3a844ff47b3b3370ecd51d3e50655d5
2017-03-13 17:19:30 +01:00
Gorka Eguileor
4be23ab476 Improve devref for API errors
Our current devref gives a very light description of how to return API
errors to callers.

This patch improves it to describe all mechanisms currently supported by
Cinder.

Change-Id: Ie3c39e6ec042332c813ee7c851ba993a4a58c907
2017-03-13 16:42:26 +01:00
Jenkins
7e846f1bac Merge "Update guru doc to support file modification events" 2017-03-09 17:06:08 +00:00
wanghao
4de7155ba7 Update guru doc to support file modification events
Now oslo_reports has supported file modification
events instead of signal handler.
(https://review.openstack.org/#/c/260976)

But gmr.rst doesn't be updated for this change in
Cinder devref folder.
So it's better to let user know there is other way
to trigger a generation of report.

Change-Id: Ic44a5fcad999b01ce36eb06e3455bd68e8eda80a
Closes-Bug: #1671002
2017-03-09 09:10:27 +08:00
Andreas Jaeger
91e914ef10 Replace obsolete vanity openstack.org URLs
Project specific URLs are obsolete, , use docs.openstack.org - and use
https for that site.

Change-Id: Ie6930c32f07108077aa97564c3213da0f948c13b
2017-03-08 19:18:51 +01:00
Jenkins
3a705a94d3 Merge "doc: verify all rst files" 2017-02-15 10:41:28 +00:00
Danny Al-Gaaf
aea740e476 Adds db_online_data_migrations to cinder-manage manpage
Closes-Bug: #1664549

Change-Id: I99d2681b799a4efd2cce3bfe64018307d3497aad
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2017-02-14 14:29:07 +01:00
Danny Al-Gaaf
e3e749fa30 doc: verify all rst files
Make use of doc8 to verify all rst files which are not
autogenerated for errors and fail if there are any issues
found. The doc8 checks are now part of the tox 'docs'
environment and ran automatically. Checks can also be called
direcly via 'tox -e docs'.

Fix all issues found by doc8.

Closes-Bug: #1566765

Change-Id: I2b25247030a1aadcfe029c9e071ef17f2f72046b
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2017-02-14 12:36:57 +01:00
ashish.billore
9dc4c8704e Cinder tox updates for Python3
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I24f83aa15cd4301aac9a7a941fe7d4c1e497c46e
Closes-Bug: #1659390
Signed-off-by: ashish.billore <ashish.billore@gmail.com>
2017-02-13 23:21:31 +09:00
Michał Dulko
fbb7f6101e Fix "No documentation found in" errors in docs
This commit removes errors like:

 Warning: No documentation found in
          sqlalchemy = oslo_db.sqlalchemy.migration

It's done either by removing pages referring to oslo's completely or
adding proper documentation to classes.

Change-Id: I145464d0d63cb5a00e0e905083c260fb6621dd89
Closes-Bug: 1663527
2017-02-10 12:58:51 +01:00
Andreas Jaeger
1c91c0f033 Prepare for using standard python tests
Add simple script to setup mysql and postgresql databases, this script
can be run by users during testing and will be run by CI systems for
specific setup before running unit tests. This is exactly what is
currently done by OpenStack CI in project-config.

This allows to change in project-config the python-db jobs to
python-jobs since python-jobs will call this script initially.

See also
http://lists.openstack.org/pipermail/openstack-dev/2016-November/107784.html

Update devref for this.

Needed-By: I628f825d9200f7951eae46b7be78b111b1a8141c
Change-Id: If549e6f108ec6184a432d5050da4386efe794a4e
2017-02-03 07:34:35 +01:00
Jenkins
fb97be7f10 Merge "Add command information to cinder-manage.rst" 2017-02-02 14:43:07 +00:00
zheng yin
91609a47a2 Add command information to cinder-manage.rst
Cinder has a command that "cinder-manage backup update_backup_host",
but cinder-manager.rst has no its information. Therefore, I add it.

Change-Id: I7c18ce1d6853117b972f335f386c149f1b0f26e2
2017-01-10 17:33:55 +08:00
Eric Harney
c64a9da338 Fix sphinx errors related to missing paths/modules
Remove/update paths/modules in docs that are no
longer valid.

Change-Id: I085d6d804927ab2d559bd8e9d0a95de84ddef2a0
2017-01-04 14:26:19 -05:00
xing-yang
c43e1cc1b0 Add driver interface for groups
This patch adds the Generic Volume Groups interface for drivers.
Also fixed a few docstrings for groups driver functions.

Change-Id: Ia3274fa2dc8ac6f52ccc903296d42e1dae6c6945
2016-11-30 13:48:45 -05:00
Gorka Eguileor
893eb180f1 Small change to microversion header on devref
The way the API microversion dev ref is rendered can lead to a confusion
on the required header, as it reads:

 volume: OpenStack-API-Version: volume 3.0

This patch makes a small change so that the actual header is standing on
its own.

TrivialFix

Change-Id: Ibbc90ef55e2b3bfe746ee9fcfda686491469a5d2
2017-01-26 11:56:49 +01:00
John Griffith
22e6998868 Add new attachment APIS
Replaces the original patch:
  https://review.openstack.org/#/c/387712/

Use the python-cinderclient WIP:
  https://review.openstack.org/#/c/387716/

Here's what you can do currently:
  `cinder attachment-create <volume-uuid>`
      Currently only tested/implemented the reserve piece
      Will create an attachment object, set volume to a
      status of 'reserved'
  `cinder attachment-list`
      Simple list output of attachments
  `cinder attachment-show <attachment-uuid>`
      Detailed list of specified attachment
  `cinder attachment-delete <attachment-uuid>`
      Removes an attachment

Change-Id: Ie15233c99d91de67279b56d27a5508c5ea98d769
2017-01-20 11:47:10 -07:00
Jenkins
58fc2eeb46 Merge "Fix typos" 2017-01-20 13:50:21 +00:00
Nam Nguyen Hoai
170a166267 Fix typos
There are some wrong words, it should be updated.

Change-Id: I2d9ff4766d7c2dc508e3cb179446b44ccb042fcc
2017-01-21 10:05:58 +07:00
Jenkins
84625957b4 Merge "Add prefix to user message event ids" 2017-01-18 16:31:23 +00:00
Alex Meade
d876680b83 Add prefix to user message event ids
This patch adds the 'VOLUME_' prefix to all message
event ids. This will prevent collisions and confusion
when other projects add user messages and create their
own event ids.

Also fix issue where request_id column is nullable in
sqlalchemy model but not properly set in the db
migration.

Implements blueprint summarymessage
Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
Co-Authored-By: Michał Dulko <michal.dulko@gmail.com>

Change-Id: Ic23f898281870ad81c5a123302ddca50905952ea
2017-01-13 11:27:20 +01:00
xing-yang
6c698bc8e3 Add dev doc for generic volume groups
This patch adds instructions for driver developers to add
consistent group snapshot support in generic volume groups.

Change-Id: I8a223e76f8a1601e636ae3905be097d1e19a94fb
2016-11-24 21:03:58 -05:00
Jenkins
cd06286062 Merge "Rolling upgrade procedure documentation" 2016-12-16 17:04:57 +00:00
Michał Dulko
fc0034b385 Rolling upgrade procedure documentation
One of the requirements to achieve assert:supports-rolling-upgrade TC
tag is to provide a "plan that allows operators to roll out new code to
subsets of services, eliminating the need to restart all services on new
code simultaneously".

This commit documents such rolling upgrade procedure in the devref,
which is last outstanding requirement for Cinder.

Change-Id: I562deafcd4bb9f5666cc35ae77a6bf20ab889612
2016-12-16 11:03:56 +01:00
Jenkins
53677a0356 Merge "Switch default py3x to py35" 2016-12-12 17:15:52 +00:00
Sean McGinnis
ca0786778c Switch default py3x to py35
Per our conversation in the Cinder weekly meeting [1] we will
now switch to just running local tests against python 3.5 as
that is the more recent and common 3.x version available on new
distros. Other versions can still be run explicitly, but this
changes the default tox run to only use 3.5.

[1] http://eavesdrop.openstack.org/meetings/cinder/2016/cinder.2016-11-30-16.00.log.html#l-54

Change-Id: If2226cb229f016e36c4dfab6224d5ae353b926bb
2016-12-09 14:22:28 -06:00
Sean McGinnis
5d870b5621 Remove run_tests.sh wrapper
The run_tests.sh mechanism for performing operations
is no longer the preferred approach. It is now better
to just run tox. There are also issues with enforcing
upper constraints that may cause test runs to fail.

To get rid of confusion by having two different ways
to run unit tests, flake8 checks, etc., it's probably
better to just remove the run_tests.sh script completely
and direct folks to use tox instead. This way we are all
consistent and there is less concern that changes will
be made to one and not the other.

Change-Id: I03f4b49cffd9f64e4eb3bdc27995d543be9efa43
2016-12-09 14:15:54 -06:00
wangxiyuan
01357dc991 Update replication doc
Change-Id: Iecb039aaf6e8d69146c7ce58c34a1953184fea7d
2016-11-10 09:05:19 +08:00
ChangBo Guo(gcb)
dd0ab650c8 Adjust doc about threading
There are two ways to give other greenthread chance to run:
greenthread.sleep(0) or time.sleep(0). Add the second way in
threading.rst and recommend the first way for contributors.

Also, PyMySQL works well with eventlet [1], and it's the default MySQL
DB API driver for oslo.db now[2].
So adjust 'threading model' doc with such info.

[1] https://wiki.openstack.org/wiki/PyMySQL_evaluation
[2] http://docs.openstack.org/developer/oslo.db/installation.html

Change-Id: I1fcf7242a6794d74da16aa5f326887cfa7257a1b
2016-10-14 13:07:47 +08:00
Luong Anh Tuan
62a0df2339 Fix typo: remove redundant 'that'
Change-Id: Ib569ab8206ad2ddb2fd1ad43c7665f1450ad42e3
2016-10-03 13:32:45 +07:00
Dao Cong Tien
0217f47979 Fix typo in devref/api_conditional_updates.rst
Change-Id: I0cac2688e7fa764ddf353583113faca8aa2deb46
2016-09-29 11:38:42 +07:00
Michał Dulko
619d28bc45 Remove driver interface changes from reno devref
Updating reno guideline in devref to reflect latest discussion at the
IRC meeting:

<smcginnis> We really only need release notes for things that would be
good to tell deployers and end users.
<smcginnis> Internal technical details would just be confusing to most
of them, so they definitely should not have a RL.

This commit removes the line stating that we should add a release note
with the driver interfaces changes.

Change-Id: Ibcca37c85e544aa7783bc08cefd1833af87acd5d
2016-09-09 10:28:37 +02:00
Vipin Balachandran
80c25785e6 Driver documentation cleanup
Adding more details to volume driver interface documenation.

Change-Id: I79117625aa3b2d7adf57ddab7e5889bebb450176
2016-08-25 15:51:37 +05:30
Jenkins
78e75c5648 Merge "Enhance api_microversion doc" 2016-08-18 04:56:38 +00:00
Gorka Eguileor
3a7686fc6d Add CI_WIKI_NAME to driver's devref
The requirement to have CI_WIKI_NAME attribute in a driver is not
currently documented, which makes it harder for new drivers to know they
need to have this attribute.

This patch adds this requirement to the driver devref.

Change-Id: Ia49527c1ca15e3454e186fd6609794d87e630903
2016-08-16 13:34:13 +02:00
Cao ShuFeng
65531bf71e Enhance api_microversion doc
The api_version_request attribute of request should be the same
with http header.

TrivalFix

Change-Id: I1e607b8ef843e031c82dae41e174303e15ad9fce
2016-08-16 06:10:31 +00:00
Gorka Eguileor
5f0f752be8 Prevent doc generation failure on OVO decorators
Currently Sphinx will fail to generate the documentation if we are using
decorators from any OVO in cinder.objects, because the OVOs are only
added to the cinder.objects namespace when the CLI programs are run.

So we need to run `register_all` method during documentation generation
to avoid failures like:

    AttributeError: 'module' object has no attribute 'Volume'

This patch modifies autogenerated doc/source/conf.py file and since now
it is no longer completely autogenerated it is added to PEP8 checks,
which required some minor changes.

Change-Id: Ifeeef61a778f9e3f3daceba8ed05cd2036219499
2016-08-09 18:24:25 +02:00
Jenkins
8eb0c89307 Merge "Docs: Correct i18n information" 2016-08-03 02:57:30 +00:00
Jenkins
c47d38dc94 Merge "Add driver list to doc build" 2016-07-29 02:24:22 +00:00
Jenkins
d2baafc2a4 Merge "Docs: remove todo list generation" 2016-07-26 18:50:26 +00:00
Jenkins
52ad7bcc75 Merge "Docs: cleanup doc8 errors" 2016-07-26 18:49:42 +00:00
Sean McGinnis
8148038e92 Add driver list to doc build
We have tox -e gendriverlist that outputs an RST-ish report of all drivers
in the tree. This output can be used in the docs build to automatically
publish the list of drivers to make it easier to find officially supported
drivers.

This effectively removes the existing drivers.html that was generated prior
that did not actually contain any useful information.

Change-Id: I8de78723af76aabcc976733ac4b248db0b8ca16f
2016-07-26 11:09:05 -05:00
Jenkins
53ac615273 Merge "Add interface documentation to driver devref" 2016-07-26 02:55:00 +00:00
Sean McGinnis
b9c5c978d9 Docs: Correct i18n information
The internationalization devref information was out of date from our current
practices. Updated to show the correct translation markers to use and fix
example showing bad practice of mismatches marker and pre-formatting of
message string.

Change-Id: I16c34704c338979bafc7f04474d6f3d427276bed
2016-07-25 12:47:35 -05:00
Sean McGinnis
3c18c6f440 Add interface documentation to driver devref
Link the docstring generated documentation for the driver interfaces into
the drivers devref page for easy access to driver method documentation.

Change-Id: Ie22599fef99ebfac12f3b9bb251ae5bdfff4bff6
2016-07-24 17:23:29 -05:00