stackforge/rubick
Code Issues Proposed changes

[doc] Rename ostack_validator to rubick

Browse Source
This commit is contained in:
Oleg Gelbukh
2013-10-23 09:36:19 +00:00
parent e6ebe3508f
commit a742ede88d
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/rules_engine.rst
View File

@@ -33,7 +33,7 @@ Rule-based inspection
All rule-based inspections are using pre-defined actions written in python, All rule-based inspections are using pre-defined actions written in python,
currently they are defined in "steps.py" file in the directory: currently they are defined in "steps.py" file in the directory:
``ostack_validator/inspections/lettuce``. They are based on lettuce framework - ``rubick/inspections/lettuce``. They are based on lettuce framework -
bdd framework for python. bdd framework for python.
Store and reuse rules Store and reuse rules
@@ -48,7 +48,7 @@ will also support migrating existing rule set to the database.
You can store your rules wherever you want and add it through the UI or simply You can store your rules wherever you want and add it through the UI or simply
by putting them in text files in directory by putting them in text files in directory
``ostack_validator/inspections/lettuce``. ``rubick/inspections/lettuce``.
Rules file must have name in the following format:: Rules file must have name in the following format::
\*.feature \*.feature
@@ -75,12 +75,12 @@ an example::
stop() stop()
New methods can use 2 classes from the inspections framework: New methods can use 2 classes from the inspections framework:
``ostack_validator/model.py`` and ``ostack_validator/common.py``. There you can ``rubick/model.py`` and ``rubick/common.py``. There you can
find many adapters to OpenStack services configuration data and all additional find many adapters to OpenStack services configuration data and all additional
information collected from OpenStack nodes. After that you can use you brand information collected from OpenStack nodes. After that you can use you brand
new rule in the scenarios as described above. new rule in the scenarios as described above.
In module ``ostack_validator/common.py`` you can find ``Inspection``, ``Issue``, In module ``rubick/common.py`` you can find ``Inspection``, ``Issue``,
``Mark``, ``Error`` and ``Version`` classes for your convenience in rule ``Mark``, ``Error`` and ``Version`` classes for your convenience in rule
defining. Module ``model.py`` contains Openstack model based on configuration defining. Module ``model.py`` contains Openstack model based on configuration
schemas. schemas.