Commit Graph

171 Commits

Author SHA1 Message Date
Nate Johnston bba805af02 Retire the Congress project
Recently the TC has worked on determining the criteria for when an
OpenStack project should be retired.  When there was not a PTL nominee
for the Congress project, that triggered the TC to review the project
health per [1], and the TC has determined [2] that development work on
the project has ceased.  This decision was announced in the
openstack-discuss mailing list in April 2020 [3].

This commit retires the repository per the process for governance
removal in the Victoria cycle as specified in the Mandatory Repository
Retirement resolution [4] and detailed in the infra manual [5].

Should interest in developing Congress as part of OpenStack revive,
please revert this commit to have the project rejoin the list of active
projects.

The community wishes to express our thanks and appreciation to all of
those who have contributed to the Congress project over the years.

[1] https://governance.openstack.org/tc/reference/dropping-projects.html
[2] http://eavesdrop.openstack.org/irclogs/%23openstack-tc/latest.log.html#t2020-04-20T15:36:59
[3] http://lists.openstack.org/pipermail/openstack-discuss/2020-April/014292.html
[4] https://governance.openstack.org/tc/resolutions/20190711-mandatory-repository-retirement.html
[5] https://docs.opendev.org/opendev/infra-manual/latest/drivers.html#retiring-a-project

Change-Id: I21c9ab9820f78cf76adf11c5f0591c60f76372a8
2020-05-28 18:12:16 +02:00
caoyuan 7aa9e87eaf tox: Keeping going with docs
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: I0e40eb0e5267d1cdd0ec1195424743310f3c39f8
2019-12-19 10:47:14 +08:00
Ghanshyam Mann 49217bcec2 [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Congress is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Depends-On: https://review.opendev.org/#/c/693631/
Change-Id: I23fcb01265b734c0a87f5ad81b25a1eac179eb06
2019-11-16 14:33:11 +00:00
whoami-rajat 4eedd98a4e Generate PDF documentation
This commit adds a new tox target to build PDF documentation.
It's a part of community goal, see storyboard for more
information.

Change-Id: I58b1fb537c3758bba5a57d3cf7ce4cf10625bd89
Story: 2006076
Task: 34813
2019-09-11 09:45:45 +00:00
whoami-rajat 25e36d4a71 Fix: docs failure on gate
Congress docs job is failing on gate due to
non-existence of _static directory which is required
by config generator[1].

[1] https://github.com/openstack/congress/blob/master/doc/source/conf.py#L120-L125

Change-Id: Ia25e677019170bfdfb3a257707a013958d518d1b
2019-09-10 15:10:09 +05:30
Andreas Jaeger 3c9ca63712 Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Ib4c5aff2fe02d9511e38e2e26b4361d81d853263
2019-07-30 19:46:15 +02:00
jacky06 41363e4597 Sync Sphinx requirement
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Remove unncessary space

Change-Id: I389a0603d8f1a931a787d03eb6eeb6cb57a8388d
2019-06-18 23:04:21 +08:00
Zuul 19a6df32e6 Merge "Changes for url transition to OpenDev" 2019-05-17 05:49:29 +00:00
Eric K c0d6c6c113 Add libpq-dev to bindeps.txt and install doc
Because it is needed to install psycopg 2.8.2 on ubuntu. Resolves
dependency install failure on unit tests on ubuntu nodes.

Change-Id: I04e9272e351badc1344235571d6f2c9e79fb6223
Closes-Bug: 1828109
2019-05-07 20:47:57 +00:00
akhiljain23 ea82c5d0f7 Changes for url transition to OpenDev
This commit changes openstack.org URL to opendev.org URL

Change-Id: Ic05ddf275a9f71cd3382ee3b4580a6004a1e66fe
2019-04-22 12:30:30 +05:30
Eric K 9c40e87c60 minor doc typo fixes
Change-Id: If3247fd61533e139fc700405a05572ff2c334510
2019-03-21 20:24:19 -07:00
Eric K 78a70b6446 [doc only] Doc changes related to json ingester
User documentation.
Admin documentation.
Release note item.

Change-Id: I7e0be77f4f8e22e6c47a35a214bbef17be3790ad
2019-03-21 15:55:59 -07:00
Zuul 1c720d1da4 Merge "Add tacker driver to doc" 2019-03-04 19:40:39 +00:00
Zuul d02c95ccc9 Merge "Improve documentation of policy create API" 2019-01-07 20:12:29 +00:00
Zuul 2dc016d137 Merge "builtins for z3 theories" 2018-12-17 06:38:53 +00:00
Eric K 8382a879a6 Add tacker driver to doc
Change-Id: Ibc245ba4b653d946f472cb99e44cad56ae6d958a
2018-12-10 15:02:43 -08:00
Eric K 12974b28f0 Improve documentation of policy create API
Clarifying the different ways to create a new policy:
- Without rules
- With specified rules
- from policy library

Change-Id: I1d767e652eaf7218437d477abe9a999f2ae7b1aa
2018-12-09 21:02:13 -08:00
Pierre Crégut 4b2b6fafbe builtins for z3 theories
Adds basic comparison, arithmetic and bit arithmetic to Z3 theories.
Builtins depend on the kind of theory in use. Z3 builtins are the only
polymorphic predicates of the engine.

Change-Id: Icb68c71ec29604638282a34d34ce06f1e1d69275
Implements: blueprint alternative-engine-z3
2018-11-22 14:13:22 +01:00
Xinhui Li 1b6182951d Fix policy document
This patch is to review the policy document by removing duplication.

Change-Id: I10161a591856414aaf4578e57d546cd9ec3d6de0
2018-11-11 14:59:47 -08:00
Zuul 429d7139fb Merge "Add framework for congress-status upgrade check" 2018-10-30 19:58:21 +00:00
LeopardMa 521ccd1649 Add wiki Source Bugs and Blueprints notes link to README.rst
Change-Id: I07b8b5c6f5dbd40ff83deba2632cf76f88519e5f
2018-10-19 13:57:30 -07:00
akhil e7c13b8ae0 Add framework for congress-status upgrade check
This commit adds the functionality of congress-status CLI for performing
upgrade checks as part of the Stein cycle upgrade-checkers goal.
It only includes a sample check which must be replaced by real checks in
future.

Change-Id: I27204c1c2dce2443eaa18a85144cbc892d61b551
Story: 2003657
Task: 26125
2018-10-19 13:31:25 +00:00
Doug Hellmann b839ab565e simplify README.rst
Move some of the user intro documentation around so that the
README.rst file can be use to publish packages to PyPI. The :ref: role
for linking between pages in Sphinx is not available for use in readme
files, so most of the content is moved into the main documentation.

Change-Id: Ic7d623b3ea9f6e5485cc5bafb1475611b5fe78a7
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-10-06 14:26:31 -04:00
Eric K aa9c441838 add instruction to install rabbitmq-server
with congress distributed architecture now standard,
rabbitmq-server is required.

Change-Id: I5f79147bb75aa612073dd514fac0a15daa2c8bef
2018-08-21 19:19:58 -07:00
Eric K 47168b4cd4 Raise sphinx>=1.7.3 in docs requirements
To avoid a sphinx bug that ignores exclude_patterns in some
lower versions.
Sphinx bug: https://github.com/sphinx-doc/sphinx/issues/4771

FFE: http://lists.openstack.org/pipermail/openstack-dev/2018-August/133065.html

Change-Id: I34aca28366e5c183ceb01b37d63688ac25332740
Closes-Bug: 1778171
2018-08-09 05:24:54 +00:00
Zuul c86a2f5d0c Merge "Mark some drivers as unstable schema or unofficial" 2018-07-27 05:48:48 +00:00
Pierre Crégut c5f633dfa2 Z3 engine as an alternative Datalog engine
Basic structure for the integration of Z3 into Congress.
Defines a Z3Theory as an alternative to nonrecursive theories.
Defines a Z3Context for executing Z3Theory content.

Z3 must be installed manually and is not in the requirements
devstack will install Z3 if ENABLE_CONGRESS_Z3 is set.

Limitations:

* No built-ins
* Typechecking does not support sub-typing (will be done later through built-ins).

Partially-implements: blueprint alternative-engine-z3
Change-Id: I87ff439a3ed4a3e83c78c98add7d94275f716a01
2018-07-26 18:15:42 +02:00
Eric K 177853a371 Mark some drivers as unstable schema or unofficial
Warn user that some new drivers have unstable schemas that can
change in future releases.
Unofficial drivers are those that interface with third party services
but are not tested in CI.

Change-Id: Ib5ded08166995a46ed21df9e7dc81fc503d41783
2018-07-26 15:09:16 +00:00
Eric K 71bce81783 autodoc mock out monascaclient
current monascaclient version does not work with osc-lib 1.11.0.
Mock out the module for now until a new monascaclient is released
and put in upper constraints

https://review.openstack.org/#/c/579139/

Change-Id: Id4f7efcd32ec6dbf582b27c4b22ad2f89caa647f
2018-07-17 23:18:25 +00:00
Eric K 2bfcbc329a Unblock gate
Fixes to eliminate autodoc errors coming with sphinx upgrade.

Increase nova service timeout

Change-Id: Id7c8dcb82b3529afdc22957239870e2a27cc6e1b
2018-06-20 15:22:32 -07:00
Zuul 7a6ce94630 Merge "Follow the new PTI for document build" 2018-05-09 19:11:33 +00:00
Zuul bb9d67d0aa Merge "Fixing link in docs" 2018-05-09 18:51:36 +00:00
inspurericzhang 67fb3cbddf Replace Chinese punctuation with English punctuation
Curly quotes(Chinese punctuation) usually input from Chinese input method.
When read from english context, it makes some confusion.

Change-Id: I41b3a55b51391fe55f916cfc6877bfac2bab988a
2018-04-28 19:42:51 +08:00
akhiljain23 701b552b18 Fixing link in docs
Reference link was not working properly.

Change-Id: Ib7b80f7eb7aa0e689b1e580d1b7061ee8a88d2e6
2018-04-24 12:18:18 +05:30
Anusha Ramineni 3a182268b9 Follow the new PTI for document build
- Follow new PTI for docs build
- Add sphinxcontrib.apidoc to replace pbr autodoc

REF:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I40ee87cd5c7ff982db2da4de679419fbb94e1f72
2018-04-19 11:21:21 +00:00
Anusha Ramineni 5854127932 Update documentation regarding deprecated option
This commit updates documentation on 'drivers' config option as
its no longer required.

Implements blueprint enable-drivers-by-default
Change-Id: I48514de022708ce6595fd6be40ac2ab5884b4f4d
2018-04-18 07:52:45 +00:00
Eric K 518b242d60 Fix the unintended .: rendering in doc
Change-Id: I5ef27b5036ba0767c73838f2c64513f217ea93c1
2018-04-10 18:00:31 +00:00
Yuanbin.Chen 576e531e86 Fix doc cloudservices and policy format error
Change-Id: I97372d39271fe7211361e8fe58127f2590cdc6d8
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-04-10 20:47:53 +08:00
wangqi 5b61228523 Add a step to install tox
Before use tox, we need install it.

Change-Id: I7c5c4a752beea3e6172d20e92ac4183ae4423e4b
2018-03-12 13:06:32 +00:00
Anusha Ramineni 3f5c7fdb20 Update congress documentation
Change-Id: I9e18a5e5b4847c81a722b51163772f6ab17740a8
Partial-Bug: #1747888
2018-02-07 16:47:20 +05:30
Pierre Crégut 7248108745 Fix serialization of choices and reenable congress-agent.
oslo_config uses OrderedDict for choices in
options types. This serialize it as list of tuples.
Order is  preserved and types are naturally
deserialized back from those tuples.

Congress-agent is reenabled. It can be disabled
in devstack on  the value of ENABLE_CONGRESS_AGENT
(default is True).

Driver will initialize table to empty at first poll not
waiting for an initial response from agents.

Closes-Bug: #1742833
Change-Id: If1423e824fc457bab89f4bcd12be8826c50f5f69
2018-01-26 11:58:08 +01:00
wudong aacbf5d0f6 Modify broken link
Change-Id: I6205b07672001e047afcdfbcf30ec197ed619077
2018-01-23 09:48:55 +00:00
Zuul 44c4ae735d Merge "Documentation of the config datasource." 2018-01-04 21:42:46 +00:00
Pierre Crégut 7220b8b057 Documentation of the config datasource.
Full automatic documentation of the options for the agent part.
Documentation of the deployment of an agent.
Documentation of the devstack deployment.

Change-Id: If9f7e5b7bc23f28b3c310ee0c8642ed46048fb99
Implements: blueprint configuration-files-validation
Co-Authored-By: Pierre Crégut <pierre.cregut@orange.com>
Co-Authored-By: Valentin Matton <vmatt.openstack@gmail.com>
2017-12-08 13:09:56 +01:00
Zuul 4043745bd4 Merge "Move policy into code" 2017-12-06 20:05:25 +00:00
Lance Bragstad 3ac806a41c Move policy into code
This commit registers default policies in code. For the
Register and Document Policy in Code community goal.

bp policy-and-docs-in-code

Closes-Bug: 1724714

Change-Id: I1eea53adc19247d8b982c3e22184e8a1e2fb875c
2017-12-05 11:36:20 -08:00
Zuul 8891d04f48 Merge "Update the doc link" 2017-11-10 05:48:02 +00:00
Chaolei Li 1c9a933686 Update the doc link
Change-Id: I20ac42f44ebaef8cbcb5d4beda0d4365a45c64f1
2017-11-08 21:33:20 +08:00
Anusha Ramineni b72ae35044 Remove ceilometer datasource driver from congress
This commit removes the ceilometer datasource driver support in congress, as
ceilometer API is removed in Queens release.
Reference:https://review.openstack.org/#/c/512286/

Change-Id: Ib7ade0951f8a85102d95a0f01c3d63337f6b2404
Closes-Bug: #1729761
2017-11-07 09:21:33 +05:30
Zuul 0c17f4382a Merge "omit openstackdocstheme for READTHEDOCS" 2017-10-31 05:20:08 +00:00