1. Update URLs according to document migration
2. Update the dead and outdated links
3. Optimize (e.g. http -> https)
Change-Id: I374aefe56d8fbe6c606e0f327314609a7375deb5
This patch refactor zaqar doc according to
the doc-migration spec.
api, cli, configuration and reference should
be added in the next few patches if need.
Change-Id: I74a4949f4eace423c06ab6e8d95838df1f312d93
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
Add the missing packages which are required. Otherwise, it throws errors
while running the 'tox -e genconfig' command in the doc.
Change-Id: Ia1d59a042b6d1aa0ad140af0b270cbf098ae51df
Closes-Bug: #1507856
At at the section "1. Install prerequisites:" in zaqar README.rst
python-dev, zlib1g-dev packages is not listed for Ubuntu OS.
These packages must be installed in the environment,otherwise
"tox -e genconfig" command will fail with below error.
ERROR: genconfig: could not install deps [-r/home/datanode1/try/zaqar
/requirements.txt
Change-Id: I6e0941cdd8b7d27149c9ef14270d37399a018a6d
Closes-bug: #1505911
Many new comers run into trouble when their local mongodb
doesn't enable replica set. This patch just add a note for
that in README.rst.
Change-Id: Iee60bec1b009d482eb0efe99c4b1f09798be2c3c
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
This patch provide fix for below issue
As per zaqar README.rst, if you want to change log file name,
then you have to edit log_file option in [DEFAULT] section of ~/.zaqar/zaqar.conf
log_file = server.log
However, actually to change the log file name,
you have to args option in [handler_file] section in ~/.zaqar/logging.conf as below.
args=('zaqar.log', 'w')
Closes-bug: #1496682
Change-Id: I94d762fca1905b367722e44cb24961e3e4cfffb0
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
To specify storage drivers with new formate.
Modify libxslt package name for debian users.
Removing separate installation of packages that are dependency of others.
Change-Id: I1304eef8ae2e743196063e09d0b551ffe18cd490
This moves functional tests out of the tests directory and removes it.
blueprint tests-refactoring
Change-Id: I0e0fb4e914ede02ea2f02fa19cf898888f38b57d
The current test commands as shown in the README.rst file does not
work. The 'curl' command requires additional headers that are not
mentioned in the README.rst file. This patch provides a working
command sequence to fix it.
Change-Id: Ic5a684bb77cc118879d2d710ed08df6563ad00ab
Closes-Bug: 1349568
README.rst tells user to refer to
[drivers:message_store:mongodb] instead of
[driver:storage:mongodb] and change URI under that section
Previous instruction was unclear for new users.
Closes-Bug: #1407218
Change-Id: I5b3254fe3ceb3518cbdcef3fa91802c11eb19358
This patch adds some directions explaining what are the required
dependencies accordingly to the distribution being used in order
to install Zaqar correctly
Change-Id: Idca091b58316d06cb3482f7ab691a690628617ee
Closes-Bug: #1433247
The readme previously was not updated since zaqar moved to
oslo-config-generator generated sample config files. This amends the
setup instructions with how to generate them.
Change-Id: I20527944e3a4438b5a0c4dac4c07fcbd5d6b64a5
This patch introduces a new observer role, which lists messages but
does not claim them. As part of this work the config options were
updated and the defaults adjusted to provide a better "kick the
tires" experience.
The default number of procs and workers is now hard-coded rather
than being based on number of available CPUs, since the number of
workers you may want to run is more dependent on the size of your
Zaqar deployment and your network bandwidth than it is on the
number of CPUs on the load generator.
Finally, the "-pc" suffix was removed from the command name. This
was included in this patch because it didn't seem significant
enough to split out.
Change-Id: I8a8190fb2cebc3489c78da4f6e1e7c51d8b97017
The consumer worker actually performs two different operations. First
it claims a batch of messages, then it deletes each one before getting
the next batch.
Therefore, in order to better compare the latency of enqueuing a message
against other operations, this patch changes the reporting to provide
the individual latency of those other operations.
Change-Id: Iff7f6054904a03dc240d3f7a2a0529bd990f973b
This patch splits the previous "worker" and "processes" config
options so that producers and consumers can be controlled
independently. In this way, a wider variety of loads can be
modeled.
Change-Id: Ia5c2cf941901c12108486de6cc9b9fa69477dc1a
This commit adds several enhancements to benchmarking tool: server_url
and path to messages now can be configured in config file. Default
output of program has been changed: now it prints values in json so they
can be parsed more easily. Previous human readable representation is
accessible via --verbose flag.
The `total_requests` metric now shows all performed requests (either
failed or successful) and new metric - `successful_requests` - was
introduced to store count of successful requests.
Change-Id: Id6fe4b2046394a348ba07eb5b2b003c6024b78b0
Partially-implements: blueprint gen-bench-reports
This patch renames every package, file, match of Marconi in the codebase
to Zaqar *except* for the .gitreview file, which will have to be updated
*after* I8e587af588d9be0b5ebbab4b0f729b106a2ae537 lands.
Implements blueprint: project-rename
Change-Id: I63cf2c680cead4641f3e430af379452058bce5b3
It could be helpful to add an example mongod URI to the instructions
in README for running a local instance of Marconi. Then the setup
procedures can be more smoother. Add an example mongod URI with
lookback address(127.0.0.1) and default mongod port(27017).
Closes-Bug: #1289355
Change-Id: I5f8f70f10a0cd013a41fb7f03234bde355e5dc2c
Users sometimes get confused when maconi-server doesn't print out anything
about which IP and port it is listening on. Recommend passing '-v' so they
learn this trick right off the bat.
Change-Id: I49cd29566b18506fad4f9450ba46159f0a75590d
This approach was recommended by mordred on the dev list recently. It
will ensure that the correct deps are installed, distribute is the right
version, etc.
Change-Id: I326053a511db76178d8e63908c3f2287d66c14b9
This patch updates the README file and makes it explicit that the config
file should be copied into ~/.marconi (which is suppose to be a
directory).
Change-Id: I08a0ad74cca7068197d3cef35000b07c75076012
wanghao