46 Commits

Author SHA1 Message Date
Jenkins
a6f92ceaf0 Merge "Update the devref for volume migration" 2015-11-09 06:24:06 +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
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
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
58eda5d1f4 Merge "Fix help for running specified unit tests" 2014-09-15 08:28:25 +00: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
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
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
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
Jenkins
d72c7b6abd Merge "Fix a few Sphinx warnings" 2013-07-13 16:10:41 +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
Doug Hellmann
17e8d9cf8a Fix a few Sphinx warnings
Corrects some rst formatting to eliminate warnings in
the documenation build.

Change-Id: I4026a1c8e7fae1928ca50d80aa1b5440faf754da
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2013-07-05 16:09:50 -04:00
Sergey Vilgelm
45a1a564c0 Rename cinder.flags to cinder.common.config
Replace FLAGS with cfg.CONF
Rename modules fake_flags to conf_fixture, test_flags to test_conf, declare_flags to declare_conf, runtime_flags to runtime_conf
Renamed cinder.flags, because exactly the same was done in the glance and nova

Fixes: bug #1182037
Change-Id: I3424d0a401b3ef7a3254d3e913263554361a52ff
2013-07-03 11:28:57 +04:00
Dirk Mueller
5e1502ad89 Fix various Sphinx warnings
Change-Id: I68c9ff6fdf9115d1abb0fb756eb806b92af29286
2013-06-12 15:21:40 +02:00
Zhenguo Niu
15a907c491 Rename requires files to standard names.
Rename tools/pip-requires to requirements.txt and tools/test-requires
to test-requirements.txt. These are standard files, and tools in the
general world are growing intelligence about them.

Change-Id: Ifb2735151dc8c7f89ec01d237226669f7051ffa8
Fixes: bug #1179008
2013-05-31 06:09:05 +08:00
Mark McLoughlin
68f28d257c Add CINDER_LOCALEDIR env variable
Part of fixing bug #995287

Syncs these two commits from oslo-incubator:

  Support overriding oslo localedir too
  Add a gettextutils.install() helper function

to get a new gettextutils.install() function which allows the default
localedir to be overwritten via an environment variable.

Note that gettextutils.install() must be called before any other cinder
modules are imported since some modules attempt to translate strings
at import time (e.g. in cinder.flags). This is broken and inefficient,
but fixing it involves adding something like sphinx's l_() function and
would be very invaisve.

Change-Id: I86562b3a65d371673bb21f7179eecc7602bc0775
2013-05-13 23:17:59 +08:00
Mark McLoughlin
7cfb0388ff Remove gettext.install() from cinder/__init__.py
The gettext.install() function installs a builtin _() function which
translates a string in the translation domain supplied to the install()
function. If gettext.install() is called multiple times, it's the last
call to the function which wins and the last supplied translation domain
which is used e.g.

 >>> import os
 >>> os.environ['LANG'] = 'ja.UTF-8'
 >>> import gettext
 >>> gettext.install('keystone', unicode=1, localedir='/opt/stack/keystone/keystone/locale')
 >>> print _('Invalid syslog facility')
  n無効な syslog ファシリティ
 >>> gettext.install('cinder', unicode=1, localedir='/opt/stack/nova/cinder/locale')
 >>> print _('Invalid syslog facility')
 Invalid syslog facility

Usually this function is called early on in a toplevel script and we
assume that no other code will call it and override the installed _().
However, in Cinder, we have taken a shortcut to avoid having to call it
explicitly from each script and instead call it from cinder/__init__.py.

This shortcut would be perfectly fine if we were absolutely sure that
nova modules would never be imported from another program. It's probably
quite incorrect for a program to use cinder code (indeed, if we wanted
to support this, Cinder code shouldn't use the default _() function) but
nevertheless there are some corner cases where it happens. For example,
the keystoneclient auth_token middleware tries to import cfg from
cinder.openstack and this in turn causes gettext.install('cinder') in
other projects like glance or quantum.

To avoid any doubt here, let's just rip out the shortcut and always
call gettext.install() from the top-level script.

However, there's a bit of an annoying detail here - by default,
nosetests starts in the current directly and tries to import all modules
it finds to look for tests. Without the _() builtin installed, importing
some modules like cinder.flags will fail.

Since it only ever makes sense to load tests from the cinder/tests dir,
we can ask nose to do that by using the --tests argument via setup.cfg.

Note, this means that if you previously did this:

  $> tox -- cinder.tests.foo cinder.tests.bar

then you must now do this:

  $> tox -- --tests cinder.tests.foo,cinder.tests.bar

Change-Id: If4125d6bcbde63df95de129ac5c83b4a6d6f130a
2013-05-13 18:45:25 +08:00
Yun Mao
7dad062dd6 Remove outdated cinder test doc
cinder doesn't run pylint test. This was a left over from the
fork in nova-volume.

Change-Id: Id096ec97b37a2019baf7a0b55bfd5bce4e71908f
2013-05-09 17:58:28 -04:00
John Griffith
cb3fb51be8 Add db client packages to dev env setup doc.
Dev env setup doc hasn't been updated in a while and
needed the addition of the mysql and psql packages.

Tested this on a clean install and it looks like
the addition of these two pkgs should get us up to
date.

Change-Id: I66011478064bd8fb85bfaf56e8b14232226e0efc
2013-05-06 10:18:48 -06:00
Tom Fifield
762f2e19cf Cinder devref doc cleanups
Way back when Cinder was inagurated as a separate project, the docs
directory from Nova was used as a seed for the one in the Cinder repo

This patch is simply cleaning out images and files which have no
relation to Cinder at all, and are at best extremely outdated when
applied to Nova.

Aside from the deletions which are mainly images, and files related
to the configuration of CloudPipe, there is one modification to
conf.py which simply removes a reference to a vmware doc that no
longer exists.

Change-Id: I2140035f98bd332f25d7dd7569993bcd960a869e
2013-02-21 21:10:16 +11:00
John Garbutt
aa87498199 Removes the xensm driver
This code does not work, and is slowly being replaced by
alternative XenServer specific drivers.

Fixes LP bug #1077011

Change-Id: I1af92ecdbb49a57a0ff4c05a70d77bcb69958cb2
2012-11-20 14:47:14 +00:00
Eric Harney
b3b1d48d53 Update HACKING.rst and related changes from Nova/PEP8.
Sync up with changes made in Nova, this adds information
about line continuation (PEP8), OpenStack capitalization,
and commit messages.

Change-Id: Id6637307411bcc7a3637ac514c4ec34e26481e0d
2012-10-22 18:41:16 -04:00
John Griffith
922fdd0bdc Update dev docs
* Quick pass at implementing the basics for cinder dev docs
  * Remove the N/A compute related stuff
  * Clean up the architecture a bit to only show cinder related
  * Remove various modules form TOC's that aren't applicable

Change-Id: I0089c388524c9def7494658e836f4ed03a61f5b5
2012-09-03 17:18:10 -06:00
Jenkins
c53d8e343e Initial fork out of Nova. 2012-05-03 10:48:26 -07:00