Commit Graph

127 Commits

Author SHA1 Message Date
Nate Johnston 1f031e89c2 Retire the Congress Specs 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: Ide2a1f572f046e2d9f1bf9468556dbb39c736c0f
2020-05-28 18:11:10 +02:00
akhiljain23 de1e318bc3 Update Sphinx version and switch to openstackdocstheme
Update sphinx version as in global requirement
Global requirement link [1]

Also This patch switches to use openstackdocstheme instead of
oslosphinx[2].

[1] 23ff2adcec/global-requirements.txt (L455)
[2] https://docs.openstack.org/openstackdocstheme/latest/#using-the-theme

Change-Id: I024faa5728b79eeb91c3bb8592a0474bc7900005
2019-06-21 12:48:16 +05:30
gujin fd9f1540ce Replace git.openstack.org URLs with opendev.org URLs
1. Replace git.openstack.org URLs with opendev.org URLs
2. Remove unncessary "=="

Change-Id: Ib2b91a6826bc7a4c72e30dfcdf1c34295a396407
2019-05-27 14:07:20 +08:00
Zuul df4a73b1eb Merge "Experimental component for a JSON data model" 2019-01-09 18:03:18 +00:00
Eric K 35565e8737 Experimental component for a JSON data model
The translation from JSON source data to tabular Congress data places the
limited resources of Congress developers in the way of the Congress users
having the flexibility to quickly try/use any data source and data field as
the need arises in their policy use cases. This spec is a proposal to
experiment with removing the translation step, thus retaining the source JSON
data model, as a promising way to overcome the limitation.

Change-Id: I9838e4bfb051fb8d9e1e83920e2253e1d6495ab7
2018-12-13 16:16:05 -08:00
Nguyen Hai deb1813c0b Add Train specs directory
The "T" release of OpenStack is officially "Train".

http://lists.openstack.org/pipermail/openstack-dev/2018-November/136464.html

Change-Id: I4ae1c29f74a8193fb5fc3a92963b8b52d6b1b05e
2018-11-14 14:37:36 +09:00
Eric K c102116d5f Setup Stein specs dir
Change-Id: Idae4e61621167b6ff05be55035dd8ef267a58754
2018-08-09 17:30:46 -07:00
Vu Cong Tuan 006a529286 Switch to stestr
According to Openstack summit session [1],
stestr is maintained project to which all Openstack projects should migrate.
Let's switch to stestr as other projects have already moved to it.

[1] https://etherpad.openstack.org/p/YVR-python-pti

Change-Id: I7daa364d2016e1b7951e6240b3254287361f9d0f
2018-08-10 00:15:16 +00:00
Eric K 2c423c83c2 line break at 79 char
Change-Id: Ie5adace969feac84c4791a2aaadd09421194cbf7
2018-08-09 14:50:13 -07:00
Pierre Crégut ffd9d30469 Z3 as an alternative Datalog engine
Z3 is an open source automatic theorem prover developed by Microsoft.
This spec describes how to add Z3 as an alternative Datalog engine
in Congress.

Change-Id: Ie1e891408c3f03618926cff4d88e7904b0c0e370
2018-08-01 09:18:40 +02:00
Zuul 35d99d2193 Merge "Explicit Data Types" 2018-06-18 17:52:54 +00:00
Eric K 58770c5037 Explicit Data Types
In preparation to support more policy engines in addition to the standard
Congress policy engine (e.g., ones based on SQL, influxDB, or Z3), we need
explicit typing of table columns in the data sources and the
data service engine. This spec proposes to support explicit typing, including
custom types, in an extensible, evolutionary, and backwards-compatible manner.

Change-Id: I389ff5fc8c7cdf9ca3b145c5eb8826f6e6cd28fa
2018-06-06 13:14:31 -07:00
inspurericzhang 03ef3321e1 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: I555d5cd51457984050a8822e777b4e82e15c5d99
2018-05-18 10:37:46 +08:00
Valentin Matton d993127245 Spec for verification of configuration files
This specification introduces a datasource driver and agents to collect
configuration files handled by the oslo-config library on the different
nodes and make them available to the congress datalog engine as a
datasource.

Change-Id: I5683a839e8fb85d7d44fd01e8800481fd2bd3fbb
Implements: blueprint configuration-files-validation
Co-Authored-By: Valentin Matton <vmatt.openstack@gmail.com>
Co-Authored-By: Pierre Crégut <pierre.cregut@orange.com>
2017-10-20 13:53:06 +02:00
Jenkins 07286b8cfb Merge "Change rules field to required in library API" 2017-06-19 21:42:22 +00:00
Jenkins 6b7f377276 Merge "make policy description and kind option in library API" 2017-06-19 21:42:17 +00:00
Eric Kao 9cda4ce089 make policy description and kind option in library API
To be consistent with existing policy API behavior

Change-Id: I958e9ea4825e55e26c229cd482860cd2c2dc58bc
2017-06-06 14:50:09 -07:00
Eric Kao 72bc419a33 Change rules field to required in library API
Use explicit empty collection if there are no rules.

Change-Id: Ie58956911ab4a1f75f05ca4d20e7cc4cd43c8948
2017-06-06 12:46:38 -07:00
Eric Kao 84d17c4fac remove owner field in library policies
Does not make sense to have owner before a policy is activated.

Change-Id: I12be26fccf6a6610af60276e8a28ae98e1a11995
2017-05-25 23:30:52 -07:00
Eric Kao c03c63501f policy library spec
Change-Id: If73f762463e8cae99f16d9e80baac330433c1b26
2017-05-22 20:18:18 -07:00
Anh Tran fd835fbd40 Typ fix: defintion => definition
Change-Id: I4e65426366f80cb154553e02f086885bcb30de5e
2017-02-07 14:16:06 +07:00
gecong1973 a70a977b34 Fix a typo
TrivialFix

Change-Id: I7c0543faedb102bcf4160ea4f3bc8417a44e2ac1
2016-11-21 15:42:13 +08:00
Jenkins 54f3e47e87 Merge "Adds selectability for translators in PollingDataSource class" 2016-07-21 01:04:29 +00:00
Masahito Muroi f68fa5dce4 Adds selectability for translators in PollingDataSource class
PollingDataSource class polls all data from related services once
the DataSource is initialized. If the polling spends long time
to fetch the data, even though any policy rule doesn't use some
of the DataSource's translator, it causes performance issue.

This spec resolves the performance issue by diasbling translator
to poll data.

blueprint selectable-translator

Change-Id: Ie00cf5a8f8fc160de62d2013c4fb6113b6ba624f
2016-07-08 16:17:49 +09:00
Eric K 4379a8c44f Support HT-HA deployments
Some applications require Congress to be highly available (HA). Some
applications require a Congress policy engine to handle a high volume
of queries (high throughput - HT).

This spec describes how we can support several deployment schemes that
address some HA and HT requirements.

blueprint high-availability-design

Change-Id: I0ce2fc3895f022d3b363c9674c6dafbbc7447c75
2016-06-30 15:30:24 -07:00
Masahito Muroi f982d19f70 Adds newton directory
For Newton release developments, it adds newton directory.

Change-Id: Ic5f640c7c0b645a6f3236397e0a7609475eca5ab
2016-04-04 14:57:24 +09:00
Jenkins 5fa83b1306 Merge "Adds availability zones to nova datasource driver" 2015-12-03 02:12:31 +00:00
Jenkins 3e8cccc0a3 Merge "Push Type Datasource Driver" 2015-12-03 02:11:40 +00:00
Masahito Muroi 0a61e1cf81 Push Type Datasource Driver
Currently, Congress only has datasource drivers which polls data
from cloud service. This spec proposes a push type datasource driver
which receives data from cloud service.

blueprint push-type-datasource-driver

Change-Id: Ie8e76547ff0f9f67e0aeb05b36ee1b66e8b4cb61
2015-12-01 18:36:16 +09:00
Jenkins ce21f8b706 Merge "Add spec for handling unknown schemas" 2015-11-26 04:11:20 +00:00
Anusha Ramineni 07fdddf785 Add Mitaka directory to toctree
This commit adds Mitaka directory to toctree and open it up
for submissions.

Change-Id: Ic07f8b34f7ffa2176c2317f16ed2d1061ba4a4d3
2015-11-26 08:38:06 +05:30
Tim Hinrichs 9354843f96 Add spec for handling unknown schemas
blueprint unknown-schemas

Change-Id: I1d92140d1e0c98f513a422e429d34e77cd554383
2015-11-25 14:22:25 -08:00
Joon-Myung Kang 56e879ea2c Adds availability zones to nova datasource driver
The current nova provides availability zones but nova data source
driver does not support it. In order to give more flexible and
extensible usage, we need to add it to nova driver.

Change-Id: I6f34216b4a47a0e58973fc8a5ef6072923077603
2015-11-24 09:23:48 +09:00
Ian Y. Choi c70fe1a11c Fixed AssertionError for running tests
Since some sentences exceeded a maximum of 79 charaters,
runtests job generated AssertionError during testr like:
'AssertionError: False is not true' and 'Line limited to
a maximum of 79 characters.'

This bug fix is for running tox and for Jenkins test.

Change-Id: I6b7292f49daf57b0ba1c2663df8369a20bde5d3e
2015-11-17 17:16:02 +09:00
Jenkins dd5b53cbe5 Merge "Remove d6cage dependency" 2015-09-29 21:21:48 +00:00
Masahito Muroi 55f21ed916 Remove d6cage dependency
Currently, API process relies on d6cage in its class. This change
removes the dependencies for new Congress distributed architecture.

blueprint dist-remove-d6cage-from-api

Change-Id: I2bc361e574e57c348e4838d586226f20a64ae98a
2015-09-09 09:56:03 +09:00
Rui Chen 1f6fc8525e Enable specs sphinx build
Currently Congress specs sphinx doc build broken,
all of the rst files can't be built into html files,
so previewing the html format of specs is impossible.
Fix it so that we can review specs in human readable way.

Some format issues exist in current rst files, so fix these
at the same time so that tox py27 and docs build can pass.

Change-Id: I0dcdfb315e8314fb54d7333c2395d41ff6a0c9a6
2015-08-31 10:53:13 +08:00
Rui Chen 7a14a0f114 Support version list API
The Congress API should be able to list current
supported API versions. Export the version list
API, and show the current API details, include:
id, status, update time, links, like other
OpenStack project: nova, neutron and etc.

APIImpact
DocImpact

blueprint api-version

Change-Id: I766a1e9e6ef0b78661ee556b586ec849f2904942
2015-07-15 11:42:32 +08:00
Jenkins 89833adaef Merge "Action listing" 2015-06-23 15:47:58 +00:00
Jenkins d60c97cfcb Merge "Policy engine API" 2015-06-15 14:49:27 +00:00
Jenkins 0622286937 Merge "Create table publishing middleware" 2015-06-09 14:25:18 +00:00
Jenkins 09655328c6 Merge "Datalog-aggregates" 2015-06-09 14:16:09 +00:00
zhang yali 7cb6cfd57a horizon-policy-abstraction spec
move specification from kilo to liberty

Abstract policy into "name", "object", "violation condition", "action"
and "data", and express this abstraction in Horizon. This abstraction
is not just a expression of datasource drivers, and it makes those
users who are not familiar with Datalog express their intent more
easily and intuitively.

modified:   horizon-policy-abstraction.rst

-Clarify the meanings of abstraction elements and give some examples
-Give an example to show how the UI looks like and how to use it

Implements: bleprint horizon-policy-abstraction
Change-Id: I4c26bcb27f3f14cd2961a6ff642d2bcfbaccca79
2015-06-08 22:52:16 +08:00
Tim Hinrichs 8e5e721f77 Policy engine API
Change-Id: I271d54758c0b03bba422e7c7d7226534803ec0b9
2015-05-17 16:04:00 -07:00
Tim Hinrichs 0769dd3260 Action listing
Change-Id: Ifd4d81c57d12fae6b5948884a94679fa990f94ce
2015-05-17 13:52:09 -07:00
Tim Hinrichs cf04a41391 Datalog-aggregates
Change-Id: Ie519ec9f21fa3d5af2183d0bf3fd348f421f2eb0
2015-05-17 13:26:52 -07:00
Tim Hinrichs 5e22802920 Create table publishing middleware
Make it easy for other projects like Nova/Neutron to publish data
in the format that Congress expects.

Change-Id: Ifdebf0f7150cd04ac27eeea7dec7a0c1ef1de341
2015-05-17 12:24:42 -07:00
Tim Hinrichs 8eca2f350f Move kilo in-discussion specs to liberty
Change-Id: Ic436ade5c4087f94a25fb1cd00bed01b03495676
2015-05-17 12:18:15 -07:00
Alexander Yip 2e63f71ec0 Add a spec for basic high availability
This basic design replicates the entire congress server and uses the database
for shared state.

Change-Id: I28cf36c1874d91e5541afc34f55eb4dbdf96c8b8
2015-04-17 19:49:06 +00:00
Jenkins 36fc55675b Merge "Explicit reactive enforcement" 2015-04-03 23:39:21 +00:00