improve formatting of documentation

Change-Id: I32d0e9e611893a38d891c69e2dd3dc62243bb4ca
This commit is contained in:
Romain Ziba 2015-07-28 10:31:06 +02:00
parent 8e091e0d84
commit 9220a64031
1 changed files with 39 additions and 39 deletions

View File

@ -25,9 +25,9 @@ Cerberus is easy to extend thanks to a plugin system.
The manager has some functions:
* it loads ``plugins``
* it manages ``tasks``
* it stores ``security reports`` and ``security alarms`` in database
- it loads ``plugins``
- it manages ``tasks``
- it stores ``security reports`` and ``security alarms`` in database
Plugins
@ -36,11 +36,11 @@ Plugins
Plugins are created to communicate with a particular security component.
They are defined by their:
* unique identifier (uuid)
* name
* version
* provider
* type (scanner, SIEM...)
- unique identifier (uuid)
- name
- version
- provider
- type (scanner, SIEM...)
Plugins can subscribe to events sent on the notification topic Cerberus'
manager listens on. For example, this can be useful to automatically configure
@ -55,12 +55,12 @@ Cerberus manages tasks.
In order to create a task, you need to call the Cerberus' API by passing some
information:
* The name of the task
* The plugin uuid handling the task
* The method to call on this plugin
* The type (periodic or not, default is not)
* The period if the task is periodic (for now, period is in seconds only)
* Persistent (True/False, conditional): tell Cerberus you want this task to be
- The name of the task
- The plugin uuid handling the task
- The method to call on this plugin
- The type (periodic or not, default is not)
- The period if the task is periodic (for now, period is in seconds only)
- Persistent (True/False, conditional): tell Cerberus you want this task to be
stored in database (useful if the manager handling the task is shut down)
The tasks may be stopped/started. As such, they have a state (running or not).
@ -72,20 +72,20 @@ Cerberus stores security reports provided by the security components.
These security reports have a predefined schema and Cerberus stores the
following information:
* The uuid of the security report
* The uuid of the plugin
* The report identifier
* The Openstack's component identifier (e.g: an instance id, a network id)
* The component type (e.g: instance, network)
* The component name
* The Openstack's project identifier
* The ticket identifier (see `sticks`_)
* The title
* The description
* The security rating
* The vulnerabilities
* The number of vulnerabilities
* The date of the last report
- The uuid of the security report
- The uuid of the plugin
- The report identifier
- The Openstack's component identifier (e.g: an instance id, a network id)
- The component type (e.g: instance, network)
- The component name
- The Openstack's project identifier
- The ticket identifier (see `sticks`_)
- The title
- The description
- The security rating
- The vulnerabilities
- The number of vulnerabilities
- The date of the last report
Security reports may be retrieved by their uuid.
@ -99,17 +99,17 @@ SIEM.
These security alarms have a predefined schema and Cerberus stores the
following information:
* The uuid of the alarm
* The uuid of the plugin
* The alarm identifier
* The Openstack's component identifier (e.g: an instance id, a network id)
* The Openstack's project identifier
* The ticket identifier (see `sticks`_)
* The timestamp (date when the notification has been received on oslo bus)
* The summary
* The severity
* The status (e.G: new)
* The description
- The uuid of the alarm
- The uuid of the plugin
- The alarm identifier
- The Openstack's component identifier (e.g: an instance id, a network id)
- The Openstack's project identifier
- The ticket identifier (see `sticks`_)
- The timestamp (date when the notification has been received on oslo bus)
- The summary
- The severity
- The status (e.G: new)
- The description
Security alarms may be retrieved by their uuid.