70 Commits

Author SHA1 Message Date
Harshada Mangesh Kakad
3fa4b8003a Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: I4d0044c110c32f87ac0316a7e665e2bb9ea88813
Partial-Bug: #1529836
2016-01-06 09:36:45 -08:00
Mudassir Latif
5191751760 Allow replicated volumes to be recoverable
Currently, once they are in ‘error’ or ‘failed-over’ states you can’t
do anything with them. We need to allow enable_replication after the
admin has resolved any issues that may have prevented the operation.

Same thing for after a fail-over, you cannot enable replication on it.

This change allows for more states to be recoverable via enable
replication. It also more uniformly sets the state to ‘error’ when
something bad happens.

'enabled' --> replication is on.
'disabled' --> replication is off by design.
'failed-over' --> we have just failed over. Replication is off.
'error' --> an error occurred during the last operation.

allowed flow is:
'enabled' --> 'failed-over'/'disabled'/'error'
'error' --> 'enabled'/'error'
'disabled' --> 'enabled'/'error'
'failed-over' --> 'enabled'/'error'

Change-Id: Icbc22b8501b048b1755019305430177ba0a9385f
Partial-Bug: #1491631
2015-12-22 07:36:11 -08:00
Kendall Nelson
fc7d9fc31e Adding devref about genconfig
This adds a description of the generation of opts.py and
cinder.conf.sample, the commands to generate them, and the scripts
that do the work generating them.

Change-Id: I6217e81acb9ee49c66cd510d55b40e1fd6fc3b3b
2015-12-02 16:14:56 -06:00
John Griffith
c30ce044b7 Update list_replication_targets
We were planning to let the list targets call be a
free for all, and just be a generic dict of info.

This probably isn't such a great idea, inparticular since
we have a required identifier field for each replication
device it makes more sense to just use that in the response
and leave the rest of the info internal.

In the future if there's a need we can always implement a
show command that displays all the dirty details.

This patch changes the identifier name to 'target_device_id'
to be more self describing, and updates the docstrings and
devref docs to reflect the changes and agreed upon changes.

Change-Id: If14130f5d5bb2e6df4478bd0e14a1f33d706bf78
2015-11-24 14:46:52 -07:00
Michał Dulko
ad47daaef0 Add guidelines for release notes to devref
Starting from this cycle (and stable Liberty) we're using reno for
release notes. This commit adds guidelines on when a release note is
required to be added.

Change-Id: If5aa6ab8317ec2f4295d899a45f80f11504d2a2c
2015-11-23 14:13:28 +01:00
Jenkins
8e03c3b335 Merge "Update cinder-manage man to match current options" 2015-11-09 20:51:37 +00:00
Jenkins
a6f92ceaf0 Merge "Update the devref for volume migration" 2015-11-09 06:24:06 +00:00
Jimmy McCrory
28fdeabff5 Update cinder-manage man to match current options
Add missing 'volume update_host' and 'service remove' commands, and
remove 'storage management' and 'volume reattach' commands.

Change-Id: Ie37fb4288b1bea1035d934136454af186eb8b44c
Closes-Bug: #1512844
2015-11-03 19:15:18 +00:00
Sean McGinnis
a77335012f Update docs to generate Guru Meditation Report
Guru Meditation Reports (GMR) code in oslo.reports was recently updated
to expect SIGUSR2 as opposed to SIGUSR1, because it is reserved by
Apache 'mod_wsgi' for its own use.

Signal was changed and merged in change:
I9d3b6079ba2cca41fe4723723a6f80b2c3c0b9c0

Change-Id: Id58dd3c32b095f4c6b14caf650d36f2fc7dfb12c
2015-10-21 17:41:06 -05:00
Eric Harney
2828bfcfb0 devref doc: assorted fixes in "Unit Tests"
Fix the example command for running a unit test.
(Colon versus period.)

Fix box formatting for tox commands.  (Need extra
newline after double colon.)

Fix a typo in the same section.

Fix broken ostestr doc link.

Remove testr and flake8 links that don't go anywhere.

Change-Id: I243e4f0639ef4a87e8950e0428b7556919094b0e
2015-10-19 15:46:38 -04:00
Vincent Hou
1fad889f5c Update the devref for volume migration
This patch proposes a thorough update to the development doc
for the volume migration. Several improvements to volume
migration have been made during the last development cycle
and this patch attempts to document the current state.

Change-Id: Ibe233d82a0694b29ecdf4abce4af735b34821c3f
Partial-implements: blueprint migration-improvement
2015-10-15 02:26:19 -07:00
John Griffith
5ee2efe223 Update config format for replication_devices
The first pass at setting up config entries for
replication targets was a hacky custom string parser
with its own unique syntax.

A better option is to use oslo.cfg's MultiOpt in conjunction
with Dict types so we can eliminate quite a bit of custom
parsing and most importantly use a standard syntax for conf
entries to make things easy for admins and reduce the
probability of syntax errors and mistakes in config setttings.

Change-Id: Ie300c1f1db548d258906eebbcea8265583086468
Closes-Bug: #1504696
2015-10-13 09:00:41 -06:00
John Griffith
bb59afc5ab Add device identifier to replication device
One thing that may be needed by some back ends
that are implementing replication is some sort
of back end device identifier.

For managed back ends this shouldn't be an issue
but for unmanaged, it's handy to have some sort
of identifier string.

This patch just adds that to the response examples
in the volume.manager code as well as adds an update
to the dev docs to point it out.

Change-Id: Ic113d905e65c756439425b03035179e65ce0b39e
2015-10-07 16:49:36 -06:00
Craige McWhirter
1b5f47414d Create a page of drivers with stevedore.sphinxext
As per:
http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html

The point behind the addition of the stevedore.sphinxext extension is
"to document drivers and other types of plugins to make the available
sets built into projects easier to discover" (dhellman).

Change-Id: I8427398e8d01c36f346e493a8144c1012ca7c5bf
2015-09-15 15:54:34 +10:00
Anton Arefiev
66202a7778 Add instructions on how to deploy API under Apache
Add new documentation with steps how to deploy Cinder API under Apache.

Implements: blueprint non-eventlet-wsgi-app

Change-Id: I25335991206a2563d266baac6730d130890777db
2015-09-01 18:35:42 +03:00
John Griffith
fe538dc63d Cinder replication V2
This adds a scaled back replication implementation
that leaves the bulk of the work up to the driver.
We just provide basic admin API methods to do things
like enable/disable and fail-over.  Set up and
specification of replication targets for a specific
back end are now intended to be part of the cinder.conf
in the driver section itself.

Replication targets are configured via the cinder.conf
file in their associated driver section.  See the devref
doc included in this commit for details on the format.

The next step in configuration is to create a volume-type
with replication info in the extra-specs.
    extra-specs = replication=enable, volume_backend_name=foo

This instructs the driver to utilize replication, default is
up to the driver but would suggest single way rep and in the case
of multiple targets, driver could choose or have a default.

If the back end doesn't report replication=enabled in it's stats
updates the scheduler will fail to place the volume due to invalid
host, or no hosts available.

Vendors can easily modify extra-specs or their own config settings
to modify this behavior, any vendor-unique adaptation can be
provided through the use of scoped keys.  Suggested examples
will be published in docs.

See doc/source/devref/replication.rst for more info

Implements BP: replication-v2
DocImpact

Change-Id: I406390e4d5f3c9947df1c4f2de68821e0fd7f75b
2015-08-24 15:37:15 -06:00
John Griffith
ef42efe5f1 Update devref unit tests doc
Simple update for our painfully out of date devref docs.

Just a short refresh on unit_tests, there's a lot that could
and probably should be added there, but this change just gets
rid of the obsolete references to Nose and adds info regarding
tox and how to use it.

Change-Id: Ib1ff174ee9ccb8ecb258558d77202062204dfec3
2015-08-18 17:08:13 -06:00
Yusuke Hayashi
e2261a3b33 Remove incorrect URLs from jenkins.rst
Remove URLs from jenkins.rst which is no longer exist
and fix incorrect URLs.

Change-Id: I7418dbe35518987de96fa31bcedb85a5d92cdc2e
Closes-Bug: #1480012
2015-08-08 01:22:19 +09:00
Atsushi SAKAI
a544f5cbb2 Rename filename from il8n.rst to i18n.rst
Internationalization's abbreviation is i18n.
This patch renames l to one.

Closes-Bug: #1477393

Change-Id: Ia7f236bd6eae3bf8613f7589916905a811c68e65
2015-07-23 12:26:44 +00:00
Ivan Kolodyazhny
063cc75c87 Remove obsolete API from documentation
Cinder doesn't support EC2 API and doesn't contain cinder.api.ec2
module.
Also references to cinder.api.openstack.auth and cinder.api.cloud were
removed too.

Change-Id: I30f71cf541d93d3ab68780328e2dea6ebd326b63
2015-07-14 18:57:19 +03:00
Jenkins
c4c7acc2ae Merge "Removing archaic references" 2015-07-13 23:37:32 +00:00
David Medberry
b6d4176b97 Removing archaic references
This document was originally imported from Nova. Removing some of the
old references to Quickstart and Hypervisors.

http://docs.openstack.org/developer/cinder/devref/development.environment.html
has a dangling link to a ../quickstart document (removed long ago.)

Change-Id: If70f4cb45034e78304cd8c5c5d5deccb692d19e7
Closes-bug: #1225822
2015-07-13 12:09:16 -06:00
liu-sheng
c2e1db7c1d Switch to oslo.reports
The Guru Meditation Reports has graduated from oslo-incubator, Cinder
should switch to use oslo.reports to keep the code base clean.

NOTE: this should be merged after the requirements has been synchronized.

Change-Id: Ic91a0c5eed09ecdec93e707e901f4bcc55980f72
Closes-Bug: 1469575
2015-07-02 09:58:33 +08:00
wanghao
f2dc050e4d Introduce Guru Meditation Reports into Cinder
This commit integrates functionality from the
`openstack.common.report` module into Cinder.
This enables Cinder services to receive SIGUSR1
and print a Guru Meditation Report to stderr.
The required modules were added to
'openstack-common.conf' as well.

It is essentially a copy from implementation of
nova side.

Change-Id: I5bbdc0f97db9b0ebd7b48e50ab7869e2ca33aead
Implements: blueprint guru-meditation-report
2015-06-16 12:01:28 +08:00
Abel Lopez
fa98f4722f cinder-manage man update
Adding section for cinder-manage db purge which was added with
https://review.openstack.org/#/c/146766

Change-Id: Ie84d7b11e60dbbc9d2da8d8ae137310c280d3897
2015-02-24 12:49:44 -08:00
Jeremy Stanley
0ced872d5f Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I1e0c546a72c75193e8c742c02dc189d178a0312c
2014-12-05 04:39:45 +00:00
git-harry
0106c02057 Update prerequisite packages in development docs
The packages listed for Linux distros are updated to meet the
prerequisites to run the unit tests.

Change-Id: Iedd9e4d04d7700d418ddb07881ac76ad758466cb
Closes-bug: #1367670
2014-11-19 23:09:36 +00:00
yatin karel
b7b7fc4099 Documentation Bug fix committed
I have corrected the spelling mistakes, that were described in the bug.

Change-Id: I53371b9a70651078bf051d6bc384d1107724d39b
Closes-Bug: #1393133
2014-11-16 18:11:03 +05:30
Alberto Planas
72bc39c946 Adds openSUSE support for developer documentation
Add information for openSUSE as developer platform.

Change-Id: I3d5429f78b06cd38b10756570acea96fb23ed021
2014-09-29 17:25:10 +02:00
Jenkins
a530c5dd05 Merge "Stop using intersphinx" 2014-09-18 06:49:17 +00:00
Jenkins
58eda5d1f4 Merge "Fix help for running specified unit tests" 2014-09-15 08:28:25 +00:00
Andreas Jaeger
3ab7af8dc1 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This causes docs jobs to fail because we error out on warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-12 22:40:23 +02:00
Ivan Kolodyazhny
8d4e09d630 Fix help for running specified unit tests
Change-Id: I385fcf88ae6a2e839c99ef13cd4f410ce3c0ee5f
2014-09-05 12:39:03 +03:00
James Carey
ac33ad9ec9 Use oslo.i18n
oslo.i18n provides the i18n function that were provided by
oslo-incubator's gettextutils module.

Change-Id: I1f361a8321fb02f03b4f3f3e2ef688fcf19514a3
2014-08-08 17:26:41 -05:00
liyingjun
6eba7aa103 fix a small typo in development.environment.rst
virutalenv ==> virtualenv

Change-Id: If090ab7b92230fba15d7be98a84b51cce507bedd
Closes-bug: 1358531
2014-08-08 15:04:35 +08:00
Eiichi Aikawa
11c268bd69 Remove definition of Python Source Code Encodings
The definition of Python Source Code Encodings is no longer needed.
This patch remove those.

Change-Id: I3eebb245e9e41b92c9ec82ebbd2dd6b417704819
2014-07-10 17:33:01 +09:00
Veronica Musso
22d0c38bb9 Update Cinder dev doc
Removing mention of adding your name and email to Author files in
Cinder dev doc.

Change-Id: I5b723dd9ff1153096852a4c1c6a7b59bf0d04d3c
Closes-Bug: #1309581
2014-04-16 08:16:30 -03:00
Jenkins
09de7d676d Merge "Switch over to oslosphinx" 2014-03-15 17:29:03 +00:00
Dirk Mueller
ea7d4a5992 Switch over to oslosphinx
oslosphinx is the new name of oslo.sphinx

Closes-Bug: #1277168
Change-Id: Ib30a4a5eb3a86ad5c03324a59e1a8ee4d4897a70
2014-03-11 14:19:23 +01:00
Joe Gordon
49deb5c304 Add libffi-dev to list of packages to install in dev env
libffi-dev is needed by cffi

Change-Id: Ib91bd2e1a1005dc96f9d9054ae5cb150c5fae7db
2014-03-11 03:38:17 +00:00
Zhiteng Huang
cea7fe21ce Drop Chance/SimpleScheduler Implementation
This patch removes the implementation of ChanceScheduler and SimpleScheduler
as previous changes have made sure they are internally replaced by
FilterScheduler.

The "max_gigabytes" config option is deprecated and will leave it like that
for one more release before we can remove it.

DocImpact: "ChanceScheduler and SimpleScheduler have been deprecated and
their implementation have been removed from Cinder."

Implement bp: deprecate-chance-and-simple-schedulers

Change-Id: Ifb1cb25e3bb4cdf26fa3283336b83fce5c97141e
2014-01-09 18:29:27 +08:00
Zhiteng Huang
2e0d1f41ec Fix typo/misspelled words
Fix type/misspelled words found by this handy tools:
https://github.com/lyda/misspell-check

Some 'typo's were intentional since they are part of function name,
so they are left alone.

Change-Id: I4badda869521659b541d018727a6f71f518e2ee0
2013-12-03 22:49:12 +08:00
Sean Roberts
338b282283 replace u\2013 char with dash
unicode char causes problems with maven build.

backport:none

closes-bug: #1246569

Change-Id: I3aa5c2debaed03acd2c2fb8d4e7c30738d35f4f3
2013-10-30 22:21:04 -07:00
Dirk Mueller
45a3b4471d Changed header from LLC to Foundation based on trademark policies
Fixes: Bug 1214176

Change-Id: Ieda1a75992abec647c267faa7727f5da4f7a88a3
2013-09-10 17:26:42 +02:00
Tom Fifield
19f549f3a3 Update references with new Mailing List location
Yesterday, openstack@lists.launchpad.org was migrated with
all users to openstack@list.openstack.org.

This patch updates references to the old mailing list with the
new, to ensure that people encountering them don't accidentally
try and join the old list!

Change-Id: I7cd33f95b7baa22dbd4abb6e391ee59876998f59
2013-07-28 12:08:20 -07:00
Mike Perez
72ebea66b6 Adding driver minimum features and volume stats to dev doc
This is a first pass in getting information out of the wiki and into the
dev docs, so changes can be reviewed properly as discussed at the Havana
summit.

Change-Id: I75e71b3e5df69e6b507ee64d330a9ec2455266c5
2013-07-23 23:14:55 -07:00
Jay S. Bryant
15bd189235 Add flag argument to 'cinder-manage config list'
Unlike other cinder-manage 'list' commands the 'config list'
option doesn't allow users to specify a filter to limit
the output.  This commit adds the ability to specify
the flag the user wishes to display.

If no flag is specified the default behavior is still to
display all the configured flags.  If the flag requested
is not found, cinder-manage reports that the flag was not
found.

(fixes bug 1187137)

Change-Id: I698f4c06d7e93217d8f307a880e0ae40711151c2
2013-07-15 13:40:38 -05:00
Jenkins
d72c7b6abd Merge "Fix a few Sphinx warnings" 2013-07-13 16:10:41 +00:00
Jenkins
3dc700cd60 Merge "Sync install_venv_common from oslo" 2013-07-10 05:27:14 +00:00
Monty Taylor
102c6ea2f0 Sync install_venv_common from oslo
Also grab a related doc reference while we're at it.

Change-Id: I2590970767f043f35a62a4dfa94be4ee86fbf138
2013-07-05 22:37:43 -04:00