Doc updates
Updated inconsistent docs. Change-Id: I4be05f662fee6ebdf721ac93dd97611b5a686273
This commit is contained in:
parent
641989b424
commit
19fdd1557e
|
@ -171,12 +171,12 @@ This component is responsible for computing a set of potential optimization
|
|||
:ref:`Actions <action_definition>` in order to fulfill
|
||||
the :ref:`Goal <goal_definition>` of an :ref:`Audit <audit_definition>`.
|
||||
|
||||
It first reads the parameters of the :ref:`Audit <audit_definition>` from the
|
||||
associated :ref:`Audit Template <audit_template_definition>` and knows the
|
||||
:ref:`Goal <goal_definition>` to achieve.
|
||||
It first reads the parameters of the :ref:`Audit <audit_definition>` to know
|
||||
the :ref:`Goal <goal_definition>` to achieve.
|
||||
|
||||
It then selects the most appropriate :ref:`Strategy <strategy_definition>`
|
||||
from the list of available strategies achieving this goal.
|
||||
Unless specified, it then selects the most appropriate :ref:`strategy
|
||||
<strategy_definition>` from the list of available strategies achieving this
|
||||
goal.
|
||||
|
||||
The :ref:`Strategy <strategy_definition>` is then dynamically loaded (via
|
||||
`stevedore <http://docs.openstack.org/developer/stevedore/>`_). The
|
||||
|
@ -290,7 +290,7 @@ the Audit parameters from the
|
|||
:ref:`Watcher Database <watcher_database_definition>`. It instantiates the
|
||||
appropriate :ref:`strategy <strategy_definition>` (using entry points)
|
||||
given both the :ref:`goal <goal_definition>` and the strategy associated to the
|
||||
parent :ref:`audit template <audit_template_definition>` of the :ref:`Audit
|
||||
parent :ref:`audit template <audit_template_definition>` of the :ref:`audit
|
||||
<audit_definition>`. If no strategy is associated to the audit template, the
|
||||
strategy is dynamically selected by the Decision Engine.
|
||||
|
||||
|
|
|
@ -5,11 +5,12 @@
|
|||
hide methods
|
||||
hide stereotypes
|
||||
|
||||
table(goal) {
|
||||
table(goals) {
|
||||
primary_key(id: Integer)
|
||||
uuid : String[36]
|
||||
name : String[63]
|
||||
display_name : String[63]
|
||||
efficacy_specification : JSONEncodedList, nullable
|
||||
|
||||
created_at : DateTime
|
||||
updated_at : DateTime
|
||||
|
@ -18,12 +19,13 @@ table(goal) {
|
|||
}
|
||||
|
||||
|
||||
table(strategy) {
|
||||
table(strategies) {
|
||||
primary_key(id: Integer)
|
||||
foreign_key(goal_id : Integer)
|
||||
uuid : String[36]
|
||||
name : String[63]
|
||||
display_name : String[63]
|
||||
parameters_spec : JSONEncodedDict, nullable
|
||||
|
||||
created_at : DateTime
|
||||
updated_at : DateTime
|
||||
|
@ -32,7 +34,7 @@ table(strategy) {
|
|||
}
|
||||
|
||||
|
||||
table(audit_template) {
|
||||
table(audit_templates) {
|
||||
primary_key(id: Integer)
|
||||
foreign_key("goal_id : Integer")
|
||||
foreign_key("strategy_id : Integer, nullable")
|
||||
|
@ -50,14 +52,17 @@ table(audit_template) {
|
|||
}
|
||||
|
||||
|
||||
table(audit) {
|
||||
table(audits) {
|
||||
primary_key(id: Integer)
|
||||
foreign_key("audit_template_id : Integer")
|
||||
foreign_key("goal_id : Integer")
|
||||
foreign_key("strategy_id : Integer, nullable")
|
||||
uuid : String[36]
|
||||
audit_type : String[20]
|
||||
state : String[20], nullable
|
||||
deadline :DateTime, nullable
|
||||
deadline : DateTime, nullable
|
||||
interval : Integer, nullable
|
||||
parameters : JSONEncodedDict, nullable
|
||||
host_aggregate : Integer, nullable
|
||||
|
||||
created_at : DateTime
|
||||
updated_at : DateTime
|
||||
|
@ -66,9 +71,10 @@ table(audit) {
|
|||
}
|
||||
|
||||
|
||||
table(action_plan) {
|
||||
table(action_plans) {
|
||||
primary_key(id: Integer)
|
||||
foreign_key("audit_id : Integer, nullable")
|
||||
foreign_key("strategy_id : Integer")
|
||||
uuid : String[36]
|
||||
first_action_id : Integer
|
||||
state : String[20], nullable
|
||||
|
@ -81,7 +87,7 @@ table(action_plan) {
|
|||
}
|
||||
|
||||
|
||||
table(action) {
|
||||
table(actions) {
|
||||
primary_key(id: Integer)
|
||||
foreign_key("action_plan_id : Integer")
|
||||
uuid : String[36]
|
||||
|
@ -97,7 +103,7 @@ table(action) {
|
|||
}
|
||||
|
||||
|
||||
table(efficacy_indicator) {
|
||||
table(efficacy_indicators) {
|
||||
primary_key(id: Integer)
|
||||
foreign_key("action_plan_id : Integer")
|
||||
uuid : String[36]
|
||||
|
@ -112,12 +118,27 @@ table(efficacy_indicator) {
|
|||
deleted : Integer
|
||||
}
|
||||
|
||||
"goal" <.. "strategy" : Foreign Key
|
||||
"goal" <.. "audit_template" : Foreign Key
|
||||
"strategy" <.. "audit_template" : Foreign Key
|
||||
"audit_template" <.. "audit" : Foreign Key
|
||||
"action_plan" <.. "action" : Foreign Key
|
||||
"action_plan" <.. "efficacy_indicator" : Foreign Key
|
||||
"audit" <.. "action_plan" : Foreign Key
|
||||
table(scoring_engines) {
|
||||
primary_key(id: Integer)
|
||||
uuid : String[36]
|
||||
name : String[63]
|
||||
description : String[255], nullable
|
||||
metainfo : Text, nullable
|
||||
|
||||
created_at : DateTime
|
||||
updated_at : DateTime
|
||||
deleted_at : DateTime
|
||||
deleted : Integer
|
||||
}
|
||||
|
||||
"goals" <.. "strategies" : Foreign Key
|
||||
"goals" <.. "audit_templates" : Foreign Key
|
||||
"strategies" <.. "audit_templates" : Foreign Key
|
||||
"goals" <.. "audits" : Foreign Key
|
||||
"strategies" <.. "audits" : Foreign Key
|
||||
"action_plans" <.. "actions" : Foreign Key
|
||||
"action_plans" <.. "efficacy_indicators" : Foreign Key
|
||||
"strategies" <.. "action_plans" : Foreign Key
|
||||
"audits" <.. "action_plans" : Foreign Key
|
||||
|
||||
@enduml
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 56 KiB |
Loading…
Reference in New Issue