-\r
-tosca_definitions_version: tosca_simple_yaml_1_0_0\r
-policy_types:\r
- onap.policies.controlloop.operational.Common:\r
- derived_from: onap.datatype.controlloop.operation.Failure\r
- version: 1.0.0\r
- description: Operational Policy for Control Loop execution\r
- properties:\r
- id:\r
- type: String\r
- description: The unique control loop id.\r
- required: true\r
- timeout:\r
- type: Integer\r
- description: |\r
- Overall timeout for executing all the operations. This timeout should equal or exceed the total\r
- timeout for each operation listed.\r
- required: true\r
- constraints:\r
- - valid_values: [1, 2, 5]\r
- - equal: 5\r
- - greater_than: 7\r
- - greater_or_equal: 1\r
- - less_than: 7\r
- - less_or_equal: 1\r
- abatement:\r
- type: Boolean\r
- description: Whether an abatement event message will be expected for the control loop from DCAE.\r
- required: true\r
- default: false\r
- trigger:\r
- type: String\r
- description: Initial operation to execute upon receiving an Onset event message for the Control Loop.\r
- required: true\r
- operations:\r
- type: List\r
- description: List of operations to be performed when Control Loop is triggered.\r
- required: true\r
- entry_schema:\r
- type: onap.datatype.controlloop.Operation\r
- onap.policies.controlloop.operational.common.Drools:\r
- derived_from: onap.policies.controlloop.operational.Common\r
- type_version: 1.0.0\r
- version: 1.0.0\r
- description: Operational policies for Drools PDP\r
- properties:\r
- controllerName:\r
- type: String\r
- description: Drools controller properties\r
- required: true\r
-data_types:\r
- # TBD if this is needed\r
- onap.datatype.controlloop.operation.Failure:\r
- derived_from: onap.datatype.controlloop.Target\r
- description: Captures information of an operational failure performed for control loop\r
- properties:\r
- messages:\r
- type: String\r
- description: error message\r
- required: true\r
- category:\r
- type: String\r
- description: |\r
- The category the error occurred in. Whether this is a general error from the actor, or the operation\r
- timed out, retries were exhausted in trying to execute the operation, a guard policy prevented the\r
- operation from occuring, or an exception in the system caused the failure.\r
- constraints:\r
- - valid_values: [error, timeout, retries, guard, exception]\r
- onap.datatype.controlloop.Target:\r
- derived_from: tosca.datatypes.Root\r
- description: Definition for a entity in A&AI to perform a control loop operation on\r
- properties:\r
- targetType:\r
- type: String\r
- description: Category for the target type\r
- required: true\r
- constraints:\r
- - valid_values: [VNF, VM, VFMODULE, PNF]\r
- entityIds:\r
- type: Map\r
- description: |\r
- Map of values that identify the resource. If none are provided, it is assumed that the\r
- entity that generated the ONSET event will be the target.\r
- required: false\r
- entry_schema:\r
- type: String\r
- onap.datatype.controlloop.Actor:\r
- derived_from: tosca.datatypes.Root\r
- description: An actor/operation/target definition\r
- properties:\r
- actor:\r
- type: String\r
- description: The actor performing the operation.\r
- required: true\r
- default: [1,"String",5.5,true]\r
- operation:\r
- type: String\r
- description: The operation the actor is performing.\r
- required: true\r
- target:\r
- type: String\r
- description: The resource the operation should be performed on.\r
- required: true\r
- metadata:\r
- clamp_possible_values: <string:see clamp project for syntax>\r
- payload:\r
- type: Map\r
- description: Name/value pairs of payload information passed by Policy to the actor\r
- required: false\r
- entry_schema:\r
- type: String\r
- onap.datatype.controlloop.Operation:\r
- derived_from: tosca.datatypes.Root\r
- description: An operation supported by an actor\r
- properties:\r
- id:\r
- type: String\r
- description: Unique identifier for the operation\r
- required: true\r
- description:\r
- type: Array\r
- description: A user-friendly description of the intent for the operation\r
- required: false\r
- constraints:\r
- - min_length: 5\r
- - max_length: 7\r
- - length: 1\r
- operation:\r
- type: onap.datatype.controlloop.Actor\r
- description: The definition of the operation to be performed.\r
- required: true\r
- metadata:\r
- clamp_possible_values: <string:see clamp project for syntax>\r
- timeout:\r
- type: Integer\r
- description: The amount of time for the actor to perform the operation.\r
- required: true\r
- constraints:\r
- - valid_values: [3, 4, 5.5, 6, 10]\r
- retries:\r
- type: Integer\r
- description: The number of retries the actor should attempt to perform the operation.\r
- required: true\r
- default: 0\r
- success:\r
- type: String\r
- description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.\r
- required: false\r
- default: final_success\r
- failure:\r
- type: String\r
- description: Points to the operation to invoke on Actor operation failure.\r
- required: false\r
- default: final_failure\r
- failure_timeout:\r
- type: String\r
- description: Points to the operation to invoke when the time out for the operation occurs.\r
- required: false\r
- default: final_failure_timeout\r
- failure_retries:\r
- type: String\r
- description: Points to the operation to invoke when the current operation has exceeded its max retries.\r
- required: false\r
- default: final_failure_retries\r
- failure_exception:\r
- type: String\r
- description: Points to the operation to invoke when the current operation causes an exception.\r
- required: false\r
- default: final_failure_exception\r
- failure_guard:\r
- type: String\r
- description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.\r
- required: false\r
- default: final_failure_guard\r
+
+tosca_definitions_version: tosca_simple_yaml_1_0_0
+policy_types:
+ onap.policies.controlloop.operational.Common:
+ derived_from: onap.datatype.controlloop.operation.Failure
+ version: 1.0.0
+ description: Operational Policy for Control Loop execution
+ properties:
+ id:
+ type: String
+ description: The unique control loop id.
+ required: true
+ timeout:
+ type: Integer
+ description: |
+ Overall timeout for executing all the operations. This timeout should equal or exceed the total
+ timeout for each operation listed.
+ required: true
+ constraints:
+ - valid_values: [1, 2, 5]
+ - equal: 5
+ - greater_than: 7
+ - greater_or_equal: 1
+ - less_than: 7
+ - less_or_equal: 1
+ abatement:
+ type: Boolean
+ description: Whether an abatement event message will be expected for the control loop from DCAE.
+ required: true
+ default: false
+ trigger:
+ type: String
+ description: Initial operation to execute upon receiving an Onset event message for the Control Loop.
+ required: true
+ operations:
+ type: List
+ description: List of operations to be performed when Control Loop is triggered.
+ required: true
+ entry_schema:
+ type: onap.datatype.controlloop.Operation
+ onap.policies.controlloop.operational.common.Drools:
+ derived_from: onap.policies.controlloop.operational.Common
+ type_version: 1.0.0
+ version: 1.0.0
+ description: Operational policies for Drools PDP
+ properties:
+ controllerName:
+ type: String
+ description: Drools controller properties
+ required: true
+data_types:
+ # TBD if this is needed
+ onap.datatype.controlloop.operation.Failure:
+ derived_from: onap.datatype.controlloop.Target
+ description: Captures information of an operational failure performed for control loop
+ properties:
+ messages:
+ type: String
+ description: error message
+ required: true
+ category:
+ type: String
+ description: |
+ The category the error occurred in. Whether this is a general error from the actor, or the operation
+ timed out, retries were exhausted in trying to execute the operation, a guard policy prevented the
+ operation from occuring, or an exception in the system caused the failure.
+ constraints:
+ - valid_values: [error, timeout, retries, guard, exception]
+ onap.datatype.controlloop.Target:
+ derived_from: tosca.datatypes.Root
+ description: Definition for a entity in A&AI to perform a control loop operation on
+ properties:
+ targetType:
+ type: String
+ description: Category for the target type
+ required: true
+ constraints:
+ - valid_values: [VNF, VM, VFMODULE, PNF]
+ entityIds:
+ type: Map
+ description: |
+ Map of values that identify the resource. If none are provided, it is assumed that the
+ entity that generated the ONSET event will be the target.
+ required: false
+ entry_schema:
+ type: String
+ onap.datatype.controlloop.Actor:
+ derived_from: tosca.datatypes.Root
+ description: An actor/operation/target definition
+ properties:
+ actor:
+ type: String
+ description: The actor performing the operation.
+ required: true
+ default: [1,"String",5.5,true]
+ operation:
+ type: String
+ description: The operation the actor is performing.
+ required: true
+ target:
+ type: String
+ description: The resource the operation should be performed on.
+ required: true
+ metadata:
+ clamp_possible_values: <string:see clamp project for syntax>
+ payload:
+ type: Map
+ description: Name/value pairs of payload information passed by Policy to the actor
+ required: false
+ entry_schema:
+ type: String
+ onap.datatype.controlloop.Operation:
+ derived_from: tosca.datatypes.Root
+ description: An operation supported by an actor
+ properties:
+ id:
+ type: String
+ description: Unique identifier for the operation
+ required: true
+ description:
+ type: Array
+ description: A user-friendly description of the intent for the operation
+ required: false
+ constraints:
+ - min_length: 5
+ - max_length: 7
+ - length: 1
+ operation:
+ type: onap.datatype.controlloop.Actor
+ description: The definition of the operation to be performed.
+ required: true
+ metadata:
+ clamp_possible_values: <string:see clamp project for syntax>
+ timeout:
+ type: Integer
+ description: The amount of time for the actor to perform the operation.
+ required: true
+ constraints:
+ - valid_values: [3, 4, 5.5, 6, 10]
+ retries:
+ type: Integer
+ description: The number of retries the actor should attempt to perform the operation.
+ required: true
+ default: 0
+ success:
+ type: String
+ description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.
+ required: false
+ default: final_success
+ failure:
+ type: String
+ description: Points to the operation to invoke on Actor operation failure.
+ required: false
+ default: final_failure
+ failure_timeout:
+ type: String
+ description: Points to the operation to invoke when the time out for the operation occurs.
+ required: false
+ default: final_failure_timeout
+ failure_retries:
+ type: String
+ description: Points to the operation to invoke when the current operation has exceeded its max retries.
+ required: false
+ default: final_failure_retries
+ failure_exception:
+ type: String
+ description: Points to the operation to invoke when the current operation causes an exception.
+ required: false
+ default: final_failure_exception
+ failure_guard:
+ type: String
+ description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.
+ required: false
+ default: final_failure_guard
Code Review / clamp.git / blobdiff