We're hosting the config ref on openstack/openstack-manuals, so
it's not necessary to keep this anymore.
Change-Id: I6bc24a55db699311d65394d5d6329088b6d73690
This patch adds Zaqar-specific contents of the OpenStack Installation
Guide in the Zaqar repository per [1]. It only covers installation on
Red Hat-based systems.
Also this patch adds tox.ini environment for install-guide and adds
openstackdocs-theme to test-requirements.txt.
The Zaqar Installation Guide structure is based on Install Guide
Cookiecutter: https://review.openstack.org/#/c/314229/.
[1] http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html
Change-Id: I72300c146b22511da4432775fc84e8c821a3fd12
Implements: blueprint install-guide-in-tree
Partially-Implements: blueprint projectspecificinstallguides
We're using zaqar.notification.tasks to look for the notifier
driver by stevedore, so this patch just rename the package
name to keep consistence. No impact for end user and migration.
Change-Id: I7694af4dbc4f73703e429560fb0a1457f3e1193a
There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.
Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
New changes to zaqar-bench were introduced by
I0a7aaeaeac6da1b2c9f08fbfdddd467de5747a28 patch.
This patch adds the information about new '-api' option and about using
Keystone authentication to 'Running benchmark' tutorial.
Also this patch fixes the information about verbose mode, because now
verbose mode is the default in zaqar-bench. This change wasn't
introduced by any patch to zaqar-bench.
Change-Id: Ie07928a4625caf1d79b44e28b6b82296b224f2cc
Partial-Implements: blueprint contributor-docs-refactoring
Currertly Zaqar has only one storage pipeline stage which can be used as
option in `zaqar.conf`: `zaqar.notification.notifier`.
It would be nice to have the information about writing stages for the
storage layer pipelines in the Zaqar Developer Documentation.
The tutorial with such information could be useful for Zaqar
contributors. Zaqar Configuration Reference then can provide a link to
this tutorial for the people who are willing to write their own external
stages outside Zaqar package.
This patch adds such tutorial.
Partial-Implements: blueprint contributor-docs-refactoring
Change-Id: Ia53017943037eed748a81fac0e4653341d6276a8
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Closes-bug: #1529836
Change-Id: I3701a14026a85898bc01f3102369a2f87de56015
This patch improves Zaqar documentation and fixes currently existing
bugs.
Bugs this patch currently addresses and solutions:
Short names for documentation locations used in this commit message:
GitRepo - https://github.com/openstack/zaqar/
Contributor Docs - http://docs.openstack.org/developer/zaqar/
Wiki - https://wiki.openstack.org/wiki/Zaqar/
1. DRY violation and spreaded information for contributors bug.
The information for Zaqar contributors is spreaded/duplicated across
GitRepo, Contributor Docs and Wiki.
Examples of DRY violation are these three articles:
https://wiki.openstack.org/wiki/Zaqar/Give_Zaqar_a_try,
https://github.com/openstack/zaqar/blob/master/README.rst,
http://docs.openstack.org/developer/zaqar/development-environment.html
Example of spreaded information is: "zaqar/tests/functional/README.rst"
Normally the contributor want to see the information from this file in
"doc/source/running_tests.rst".
Solution: move useful missing information for contributors from Wiki and
GitRepo to Contributor Docs, then replace all contributor information in
Wiki and GitRepo with links to Contributor Docs.
2. Outdated information, missing new information and broken links bug.
Example is "test_suite.rst":
a. It still states that Zaqar test suite lives in two directories -
"tests" and "zaqar/tests", but now it's not true.
b. Doesn't contain information about how test invocation is organized,
what really happens when "tox -e py27" command executes.
Solution: replace outdated information with new, fix broken links if
possible, add useful missing information.
3. Style and formatting bugs.
The reference is http://docs.openstack.org/contributor-guide/.
Many documents in Contributor Docs have wrong line wrapping - some lines
are wrapped too short and some are wrapped too long.
Lines must wrap at 79 characters, exceptions are code and links.
Example is "first_review.rst" which lines are not wrapped at all.
Enumerated lists must be written using "#. " syntax.
Example with wrong enumerated list is "development.environment.rst".
Some inline elements must be styled according to:
http://docs.openstack.org/contributor-guide/rst-conv/inline-markups.html
Example with wrong styling of inline elements is
"development.environment.rst" where many paths and file names are not
marked with `` (double backticks).
By default code inserts are implicitly styled with python syntax.
There are many places in Contributor Docs where console (bash) code is
wrongly styled with python syntax.
Also there are some failed attempts to apply a formatting in Contributor
Docs. For example there is a broken list in "first_review.rst" at line
52.
Solution: fix broken formatting, apply proper style where it is needed.
Some of these bugs fixes closes few bug reports from:
https://etherpad.openstack.org/p/zaqar-mitaka-docs
Change-Id: Id668684248bdee03eb43b537dc2c6bb2a68ed23d
1.) Corrected headings according to rules of migrations by
placing "=======" on headings in the files
2.) Some headings have extra "====", they are removed
3.) Launchpad url have '~' which makes error: page not found
,so it is removed
Change-Id: I99581025d579f18da9ebe57267fb002cbcba28dd
As per zaqar development-environment.rst,
To integrate zaqar in an openstack environment,
we need to enable zagar service by adding the below line to the devstack local.conf
enable_service zaqar-server
However, now zaqar add as a plugin (not as a devstack service) to
the devstack environment by adding below line to the devstack local.conf
enable_plugin zaqar https://github.com/openstack/zaqar
This patch is fixed the issue.
Closes-Bug: #1496233
Change-Id: I677257c2f3ae4caa3f39fde2fabee9ee5c113a5c
In zaqar documents, a config option under the [driver] section is wrongly named as "message_storage".
However actually as per zaqar code it should be name as "message_store".
This patch fix this name issue.
Closes-Bug: #1496202
Change-Id: I7fdff8b7cb87850920f7144aea84e907221bbcf7
Considering that most of this feature landed during the Liberty
cycle, it made sense to make Websocket a v2 feature.
APIImpact
Implements-blueprint: persistent-transport
Change-Id: I52ef38f32afd688239d4aee9ac379cd8dea03d6c
For enabling zaqar server it is written using
enable-service but the correct one is
enable_service
Change-Id: I4ed28a4b92358da11ca6bb3746e8fde68d23f683
Closes-Bug: #1490435
Change GNU/Linux system (Ubuntu, Fedora-based distributions) dependencies
Add the missing packages which are required. Otherwise, it throws errors
while running the 'tox -e genconfig' command in the doc.
Change-Id: Ie339dd590367f5a6a39ef246b632803e6677c089
Closes-Bug: #1488765
We've been generating docs for the `zaqar.transport.wsgi.app` module,
which tries to create an instance of the wsgi transport, which then
tries to create an instance of the data controller and connect to the
database.
This module does not contain any docs and we shouldn't require a running
DB instance to generate these docs.
Change-Id: Id1c3cabc61a790bc0e5cccb22e660c933788ded8
Closes-bug: #1489426
Update development-environment.rst guide to include recent changes, for example
removed or updated sample configuration files as well as installing required
dependencies.
With these changes applied it was possible to successfully run a Zaqar server.
Change-Id: If113dc39a7a5466f15ebd3d9defede4e8c1b8098
Remove data modules from the sqlalchemy package since we don't support
them anymore.
Closes-bug: #1461962
Change-Id: I28abb510ea918ece65e5b28271b4d921221e6877
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.
Change-Id: I1d8280cef8e260576550cab85574b663266ae314
The http://ci.openstack.org/ documentation site has been deprecated,
replaced by redirects to corresponding paths within
http://docs.openstack.org/infra/ where other Project Infrastructure
documentation already resides.
Change-Id: I382df4ed7e43fcc33ff6d5ac29835c6f011e2ac9
Wikipedia's list of common misspellings [1] has a machine-readable
version. This patch fixes those misspellings mentioned in the list
which don't have multiple right variants (as e.g. "accension", which can
be both "accession" and "ascension"), such misspellings are left
untouched. The list of changes was manually re-checked for false
positives.
[1] https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines
Change-Id: I961e9cbf27eb39461148f58dc6e8bdc1c9599541
Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
An API package has been created in common to store the API base class,
request and response classes, API validation and schemas.
The processing of the requests and responses will be added in a follow
up patch.
Change-Id: I3068b6fffde2d4d88a6009ca2ed703b38b791273
Partial-Implements: blueprint cross-transport-api-spec
Given we are going to implement notification, so the 'queues'
package is not suitable for current scope of zaqar. This
patch will remove the 'queues' package.
Partially implements: blueprint notifications
Change-Id: I6984f31f4bd1e646b585c45c088ed239b58587c4
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.
Change-Id: I972d2aa54bf70b58cf5d0f8ed1ec67be42f484a6
