152 Commits

Author SHA1 Message Date
Zuul
788d57ed41 Merge "CONF file structure refactor" 2018-06-22 05:03:56 +00:00
xywang
a7df08deb9 CONF file structure refactor
This is the openstack governance goal that the config files should
be merged into one folder to make the code to be better understood
and managed.

Change-Id: I33dd85145d9f5b0384323ffa51b4d68de0aeb5b7
2018-06-04 09:11:46 +08:00
Nguyen Van Trung
5d26144664 Remove ignore D000 in validation code
This commit going to remove --ignore D000 which had raised
alot of issues, such as:
- "D000 Cannot analyze code. Pygments package not found."
- Cannot check LOG which have '_' symbol in code-base.

And they also fixed in https://review.openstack.org/#/c/568729/

Change-Id: Ic5258e0262c11b9f878d867a3354aa7d1f6e67b4
2018-05-30 10:33:36 +07:00
wanghao
fe87830da2 Make doc more clearness
Now when running functional and unit tests, if user wants
to use a custom MongoDB instance, he needs to set
two environment variables: "ZAQAR_TEST_MONGODB_URL" and
"ZAQAR_TEST_MONGODB".

Change-Id: I98fe958bfb4fb7f3913de0d0bdc2490f3b441f1b
2018-05-29 15:36:11 +08:00
inspurericzhang
a40294984b Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: Ia98c598c48efd0ec8c5c6fbb3b37ad6604664f3f
2018-05-25 15:17:00 +08:00
xywang
17ef71a482 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I444cdaad0d83d9d8795dc03793aefe2fa3a51203
2018-05-22 06:12:22 +00:00
liuyamin
2085162247 Update auth_url in install docs
Beginning with the Queens release, the keystone install guide
recommends running all interfaces on the same port.So this patch
updates the install guide to reflect that change.

Change-Id: I8b1c290c9dcfb721946b6052da4c14f5bf00378e
2018-05-08 10:25:01 +08:00
melissaml
7b8776e483 Update auth_uri option to www_authenticate_uri
Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

[1]https://review.openstack.org/#/c/508522/

Change-Id: Ieff5b69018e3824074b5a528a7b9d2a00dd7fb2e
2018-04-18 19:15:13 +08:00
Nguyen Hung Phuong
5a8b084401 Nit update in jenkins.rst document
zuulv3 has been replaced by zuul so the document should be updated
in file:

doc/source/contributor/jenkins.rst

Change-Id: I38d7b843718d5d3a6e6c3881fa3016c54913ed59
2018-02-13 10:44:29 +07:00
gaofei
3d99504e27 Replace curly quotes with straight quotes
Curly quotes usually input from Chinese input method.
When read from english context, it makes some confusion.

Change-Id: I7224650e2a52e813077bb84ad3ceddb9d87f934e
2018-01-25 03:42:31 +00:00
yangzhenyu
6801ce8ff6 Update the install guide about policy json file
Since the policy json file has been removed. So the
installation guide should also be updated.

Change-Id: Ibf158e402fa31702fadf70f27d5db5a5d6814e34
2018-01-15 16:48:39 +08:00
Zuul
27ece69e8d Merge "Update the documentation link" 2017-12-04 03:50:23 +00:00
gengchc2
dfdd829ff0 tox -e docs: Line too long
Change-Id: If90cc4b8745ed3f5c98ed69673bb7d2bd4b687a6
2017-12-03 21:16:44 +00:00
Guoqiang Ding
b7093a3a4c Update the documentation link
The documentation about "ops-guide" has been moved.

Change-Id: Id195831399594631cca0457fc6bc6f0e6805ccf5
2017-12-03 21:16:05 +00:00
Vu Cong Tuan
d170c6fd57 Do not use “-y” for package install
According to "code conventions" [1], do not use "-y" option.
Instead, use apt-get install package, yum install package,
or zypper install package.

[1] https://docs.openstack.org/doc-contrib-guide/writing-style/
code-conventions.html

Change-Id: I58d11d0bb8976941ceda56a95112783090d211bf
2017-11-08 14:41:24 +07:00
Zuul
0505f5ee51 Merge "Add more backoff functions" 2017-10-27 11:01:42 +00:00
gecong1973
ef8631899e Add more backoff functions
This patch introduces more retry backoff function the delivery 
retry policy into Zaqar. It will work when Zaqar failed to send 
the notification to the subscriber. Users can define the retry 
backoff function in the options of subscription or metadata 
of queue.

Change-Id: I0bffd9249f8a0d466ecea1ac36d8adc37b742238
Implement: blueprint support-more-backoff-functions
2017-10-24 01:01:47 +00:00
Nguyen Van Trung
ffd58efb1e Move to Zuulv3 link to check status
Change-Id: Idf4888167b25375e206cf84da61764e535d608ef
2017-10-20 14:55:54 +07:00
Rui Yuan Dou
eb86aafb23 Correct descriptions of install doc
1. add create pid step
2. correct service config file name to 'zaqar-uwsgi.service'
3. move zaqar.conf into /etc/zaqar/
4. change uwsgi workdir to path '/srv/zaqar'

Change-Id: I6aafbb3b84abaf3ae40561055c2c122d9a1c8dff
Closes-bug: 1716864
2017-10-17 22:27:42 +08:00
Jenkins
96a0aac2e8 Merge "Correcting typo on doc." 2017-10-09 18:32:15 +00:00
mohit.mohit2atcognizant.com
31a6325b00 Correcting typo on doc.
Fix for typo in zaqar documentation -:

  * Ref doc link - Doc Link - https://docs.openstack.org/project-install-guide/messaging/newton/verify.html
  * There is typo in string  "X-Auth-ToKen:
  * Instead it should be "X-Auth-Token:
  * This patch fixes the typo for letter k in string Token

Change-Id: I6644b2601754914166d29cf1e1af98f8e8f265e8
Closes-Bug: #1718414
2017-10-09 09:24:45 +00:00
mohit.mohit2atcognizant.com
04a983756d Adding folder path
Fixes the zaqar documentation
 * Ref to Doc Url - URL: https://docs.openstack.org/zaqar/latest/install/install-ubuntu.html
 * It is not spelled to copy the files on /etc/zaqar
 * Later on it is mentioend to copy the sample policy.json file to /etc/zaqar
 * Adding the root folder path for it on the string "sample file to the directory etc/zaqar/:"
 * It is mentioned to make a directory but the directory name and path is missing.
 * As per the above we have to create the directory "/etc/zaqar"
 * This patch would update the missing folder path on the documentation.

Change-Id: Ib538857ef0abef9617d44e3f803b4bcd191bc546
Closes-Bug: #1718366
2017-10-09 09:10:31 +00:00
wangxiyuan
02c49fe3f7 Remove "enabled" in CORS guide
The "enabled" config option has been removed already.

Change-Id: I35586d11e93b6d62513738dd6263e6fe1032d2af
2017-09-08 10:46:31 +08:00
shangxiaobj
b2d9b90499 Replace http with https for doc links
Use https instead of http for docs links.

Change-Id: I46b16918995a89d2ec68a5d3124fc7db53228e54
2017-09-03 20:12:49 -07:00
Rui Yuan Dou
eec827b565 Correct typo of zaqar index doc page
Change-Id: Iefc7c07effb2e05a2c11a06cbe835f11f3932df9
2017-08-23 17:24:13 +08:00
Jenkins
0d3ea781ca Merge "Update and optimize documentation links" 2017-08-10 23:22:14 +00:00
liuyamin
49a397ebfb Use doc8 check
doc8 is a linter for documents and used in openstack-manuals. It is better to
enforce document linters for simple checking.

The current rules are really simple like:
- line length check (80 chars)
- new line at the end of file
- Trailing whitespace

Change-Id: I328e2b2b82739696b95eca4a4130ca347893b0dc
2017-08-10 09:07:41 +08:00
wanghao
900bdbe3d9 Notification Delivery Policy
This patch introduces the delivery retry policy into Zaqar.
It will work when the notification sent from Zaqar to the
subscriber failed.
User can define the retry policy in the options of subscription or
metadata of queue.

Change-Id: I1a74c2d5b69fb82826c303468099db34b3e41b5b
Implements: bp notification-delivery-policy
2017-08-09 08:58:39 +08:00
Jenkins
09f3f6f594 Merge "Add project info to contributor doc" 2017-07-31 05:11:14 +00:00
Feilong Wang
626844a970 Add project info to contributor doc
Change-Id: I3e65614477904f0cd72bf3fa87bbbf6b27f39b8b
2017-07-31 01:42:27 +00:00
Feilong Wang
0a6c04e479 Migrate configuration docs
Co-Authored-By: wanghao<sxmatch1986@gmail.com>

Closes-bug: #1706193

Change-Id: Ib0145f9aaf4f498d236fb4a0beaa01aeb6379177
2017-07-27 11:30:17 +08:00
Hangdong Zhang
07e4c7df4d Update and optimize documentation links
1. Update URLs according to document migration
2. Update the dead and outdated links
3. Optimize (e.g. http -> https)

Change-Id: I374aefe56d8fbe6c606e0f327314609a7375deb5
2017-07-20 18:31:18 +08:00
wangxiyuan
13b85cc38f Refactor the doc tree
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
2017-07-19 10:12:28 +08:00
Andreas Jaeger
e9586d7e94 Minor cleanup on conf.py files
* Remove generated comments
* Remove templates_path setting, there's no template to use.
* Do not set html_static_path, there's no _static directory to use.

Change-Id: Iab617f28a57fccfff8ed53da62b764a99705af6f
2017-07-05 08:54:37 +02:00
Jenkins
48f6d3c6d4 Merge "Update subscription confirm doc" 2017-07-04 21:53:29 +00:00
Jenkins
88ca5fbea7 Merge "Remove obsolete user-guide" 2017-07-04 09:48:25 +00:00
Andreas Jaeger
45233c2c8d Remove obsolete user-guide
There's now an api-ref document, so the user-guide directory is not
needed. Remove the obsolete and outdated user-guide XML docs.

Change-Id: Ic3594eb08f7ef4e025968dfdeb1b9c3319dedaee
2017-07-03 10:02:28 +02:00
Van Hung Pham
b0f96a6e12 Switch from oslosphinx to openstackdocstheme
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.

[0]https://review.openstack.org/#/c/472275/

Change-Id: Id4399e3c8c30716d7622dc7ed8ab91433cad813b
2017-07-03 09:01:07 +07:00
ZhongShengping
855e61eb58 Fix jenkins link in running-tests
The previous link doesn't exist anymore, using new link instead.

Change-Id: Idf864c9fddd4b8a06ce9fa62416cb68837c48e9a
2017-06-22 15:21:10 +08:00
wangxiyuan
84d4e6ce4c Update subscription confirm doc
If users don't use devstack, message_pipeline will not be set by
default. Update the doc to remind users it.

Change-Id: I5f452778093c23d75a80e97961f1e359d558cc43
2017-06-20 07:57:17 +00:00
gecong1973
48d6855f5d Fix some typos in zaqar
There are some typos in zaqar, this patch fix it.

Change-Id: Ic174ed786eaaa0542c68f178dee0a730ddc81b55
2017-06-15 20:49:51 -04:00
gecong1973
3a068c7b7f Fix the official Doc site of CORS
The Official Doc site of CORS is wrong, this patch fix it.

Change-Id: I330ec67554ff23b69cf1ffc20efee4fe51eb48cd
2017-06-13 05:03:58 -04:00
jolie
a4dbefc6f4 Revise text about py34
Zaqar has already dropped py34[1], so the text "py34" and
"Runs the Python unit tests with a Python 3.4 environment."
need to be deleted. Besides, we should support py35.
[1]https://review.openstack.org/#/c/418170/

Change-Id: Id5aa108160582b71a792d58b793c7b1da1096305
Closes-Bug: #1686038
2017-04-25 16:12:10 +08:00
Fei Long Wang
4cdee047f7 Remove enabled option for CORS
By default, CORS middleware can allow requests from any origin. So it's not
necessary to use the 'enabled' option.

Closes-bug: #1677049
Co-Authored-By: wangxiyuan<wangxiyuan@huawei.com>
Change-Id: Id80e17466400937bba9fbb4aa2a2b65de9d62252
2017-03-30 15:07:24 +08:00
wangxiyuan
e501f4013e Support CORS
Add the new middleware CORS for Zaqar

It only supports for WSGI.

Websocket doesn't need this feature.

Change-Id: Ifc6d2d1c5dde5152cab6e3aa2f3cf9f207481267
Implements: blueprint support-cors
2017-03-24 14:37:51 +08:00
Ken'ichi Ohmichi
66e90d3b25 Fix the link of 'Message Queuing API v2'
When jumping to the reference of 'Message Queuing API v2' from
https://docs.openstack.org/developer/zaqar/headers_queue_api_working.html#working-with-the-message-queuing-api
we could not open the page because the link was wrong.
This patch fixes it.

Change-Id: I70a2298e556e2c969d3206ffa442025ca1d65c30
2017-03-23 09:46:03 -07:00
Jenkins
9211268c0d Merge "Move auth and osprofiler to middleware folder" 2017-03-23 09:53:47 +00:00
wangxiyuan
8124ef0e71 Move auth and osprofiler to middleware folder
Now we have keystone and osprofiler middleware, and we will add
cors middleware next. So it's better to move them to a common
folder. Then they can be mantained and read easily.

Change-Id: Ic7e365860a29adaf9cbde665c16986262cff5f2b
Implements: blueprint support-cors
2017-03-13 10:29:07 +08:00
wanghao
5118dafc65 Introduce Guru to Zaqar
Guru is a mechanism whereby developers
and system administrators can generate
a report about the state of a running
Zaqar executable.

This report is called a *Guru Meditation Report*

This mechanism will help developer or operator
to fix issues in (production) deployments without
stopping Zaqar service.

Implements: blueprint introduce-guru-to-zaqar
Change-Id: I72885be396be7eb0a9dd8fd564d706a8351b02c6
2017-03-09 11:00:29 +08:00
Andreas Jaeger
371ff39c7d Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.

Fix also problems found:
* code-blocks that could not be parsed
* Usage of :option: without declaring the option.
* Add blank lines to properly end markup.
* Fix a typo.
* Fix wrong markup of docstring
* Fix title underlinings.

Change-Id: I69ddde706a04f26bfccda072822dc0d230cb330e
2017-03-04 19:59:54 +01:00