openstack
/
searchlight-specs
Code Issues Proposed changes
RETIRED, OpenStack Search (Searchlight) Specifications
12 Commits 1 Branch 0 Tags 999 KiB
Go to file
leizhang cdfc99eef1 Move notification-forwarding for SearchLight BP to Newton 
It will use zaqar (messaging-as-a-service) to translate SearchLight index
into zaqar message, and push it to clients.

Change-Id: I3bd9884d0e62dae95a97d13135e7f8ba7e1c544a
Implements: blueprint notification-forwarding
 		2016-03-18 06:30:46 +00:00
doc/source Add OpenStack Newton release to spec repo 2016-02-02 15:45:57 +00:00
images Zero Downtime Reindexing Proposal 2016-01-28 09:46:47 -07:00
specs Move notification-forwarding for SearchLight BP to Newton 2016-03-18 06:30:46 +00:00
tests Setup Initial Spec Repo Contents 2015-11-13 11:00:49 -07:00
.gitignore Setup Initial Spec Repo Contents 2015-11-13 11:00:49 -07:00
.gitreview Added .gitreview 2015-11-13 09:12:13 +00:00
.testr.conf Setup Initial Spec Repo Contents 2015-11-13 11:00:49 -07:00
LICENSE Setup Initial Spec Repo Contents 2015-11-13 11:00:49 -07:00
README.rst Setup Initial Spec Repo Contents 2015-11-13 11:00:49 -07:00
requirements.txt Setup Initial Spec Repo Contents 2015-11-13 11:00:49 -07:00
setup.cfg Setup Initial Spec Repo Contents 2015-11-13 11:00:49 -07:00
setup.py Setup Initial Spec Repo Contents 2015-11-13 11:00:49 -07:00
tox.ini Setup Initial Spec Repo Contents 2015-11-13 11:00:49 -07:00

README.rst

OpenStack Searchlight Specifications

Please read the Searchlight process documentation on feature requests and bug reports:

http://docs.openstack.org/developer/searchlight/feature-requests-bugs.html

This git repository is used to hold approved design specifications for additions to the Searchlight project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

You can find an example spec in doc/source/specs/template.rst. A skeleton that contains all the sections required for a spec file is located in doc/source/specs/skeleton.rst and can be copied, then filled in with the details of a new blueprint for convenience.

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints will get fully implemented.

Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.

Prior to the Miktaka development cycle, this repository was not used for spec reviews. Reviews prior to Mitaka were completed entirely through Launchpad blueprints:

http://blueprints.launchpad.net/searchlight

For more information about working with gerrit, see:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory. Please do not check in the generated HTML files as a part of your commit.