diff options
author | waynedunican <wayne.dunican@est.tech> | 2021-10-22 09:47:05 +0100 |
---|---|---|
committer | Wayne Dunican <wayne.dunican@est.tech> | 2021-10-26 14:02:46 +0100 |
commit | 7fabab19ae21883c649a66d2688e3aa8a6e68e97 (patch) | |
tree | 55ced49756638e33e1fd7a2628ec76d660207688 /docs/development/devtools/tosca/instantiation_pptnt_smoke.json | |
parent | eb95c73db7a846e124d3b2d55b595c96736f4a40 (diff) |
Create documentation for policy participant smoke tests
Issue-ID: POLICY-3730
Change-Id: I30b06d38aef5f0b4081878cea23f33411d2ff6f3
Signed-off-by: Wayne Dunican <wayne.dunican@est.tech>
Diffstat (limited to 'docs/development/devtools/tosca/instantiation_pptnt_smoke.json')
-rw-r--r-- | docs/development/devtools/tosca/instantiation_pptnt_smoke.json | 851 |
1 files changed, 851 insertions, 0 deletions
diff --git a/docs/development/devtools/tosca/instantiation_pptnt_smoke.json b/docs/development/devtools/tosca/instantiation_pptnt_smoke.json new file mode 100644 index 00000000..3aa5381f --- /dev/null +++ b/docs/development/devtools/tosca/instantiation_pptnt_smoke.json @@ -0,0 +1,851 @@ +{ + "controlLoopList": [ + { + "name": "PMSHInstance0", + "version": "1.0.1", + "definition": { + "name": "org.onap.domain.pmsh.PMSHControlLoopDefinition", + "version": "1.2.3" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "PMSH control loop instance 0", + "elements": { + "709c62b3-8918-41b9-a747-d21eb79c6c21": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c21", + "definition": { + "name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement", + "version": "1.2.3" + }, + "participantType":{ + "name":"org.onap.policy.controlloop.PolicyControlLoopParticipant", + "version":"2.3.1" + }, + "participantId":{ + "name":"org.onap.PM_Policy", + "version":"1.0.0" + }, + "state":"UNINITIALISED", + "orderedState":"UNINITIALISED", + "toscaServiceTemplateFragment":{ + "data_types":{ + "onap.datatype.controlloop.Actor":{ + "constraints":[ + + ], + "properties":{ + "payload":{ + "name":"payload", + "type":"map", + "type_version":"0.0.0", + "description":"Name/value pairs of payload information passed by Policy to the actor", + "required":false, + "entry_schema":{ + "type":"string", + "type_version":"0.0.0" + }, + "metadata":{ + "clamp_possible_values":"ClampExecution:CDS/payload" + } + }, + "target":{ + "name":"target", + "type":"onap.datatype.controlloop.Target", + "type_version":"0.0.0", + "description":"The resource the operation should be performed on.", + "required":true + }, + "actor":{ + "name":"actor", + "type":"string", + "type_version":"0.0.0", + "description":"The actor performing the operation.", + "required":true, + "metadata":{ + "clamp_possible_values":"Dictionary:DefaultActors,ClampExecution:CDS/actor" + } + }, + "operation":{ + "name":"operation", + "type":"string", + "type_version":"0.0.0", + "description":"The operation the actor is performing.", + "required":true, + "metadata":{ + "clamp_possible_values":"Dictionary:DefaultOperations,ClampExecution:CDS/operation" + } + } + }, + "name":"onap.datatype.controlloop.Actor", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + }, + "description":"An actor/operation/target definition" + }, + "onap.datatype.controlloop.Operation":{ + "constraints":[ + + ], + "properties":{ + "failure_retries":{ + "name":"failure_retries", + "type":"string", + "type_version":"0.0.0", + "description":"Points to the operation to invoke when the current operation has exceeded its max retries.", + "default":"final_failure_retries", + "required":false + }, + "id":{ + "name":"id", + "type":"string", + "type_version":"0.0.0", + "description":"Unique identifier for the operation", + "required":true + }, + "failure_timeout":{ + "name":"failure_timeout", + "type":"string", + "type_version":"0.0.0", + "description":"Points to the operation to invoke when the time out for the operation occurs.", + "default":"final_failure_timeout", + "required":false + }, + "failure":{ + "name":"failure", + "type":"string", + "type_version":"0.0.0", + "description":"Points to the operation to invoke on Actor operation failure.", + "default":"final_failure", + "required":false + }, + "operation":{ + "name":"operation", + "type":"onap.datatype.controlloop.Actor", + "type_version":"0.0.0", + "description":"The definition of the operation to be performed.", + "required":true + }, + "failure_guard":{ + "name":"failure_guard", + "type":"string", + "type_version":"0.0.0", + "description":"Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.", + "default":"final_failure_guard", + "required":false + }, + "retries":{ + "name":"retries", + "type":"integer", + "type_version":"0.0.0", + "description":"The number of retries the actor should attempt to perform the operation.", + "default":0.0, + "required":true + }, + "timeout":{ + "name":"timeout", + "type":"integer", + "type_version":"0.0.0", + "description":"The amount of time for the actor to perform the operation.", + "required":true + }, + "failure_exception":{ + "name":"failure_exception", + "type":"string", + "type_version":"0.0.0", + "description":"Points to the operation to invoke when the current operation causes an exception.", + "default":"final_failure_exception", + "required":false + }, + "description":{ + "name":"description", + "type":"string", + "type_version":"0.0.0", + "description":"A user-friendly description of the intent for the operation", + "required":false + }, + "success":{ + "name":"success", + "type":"string", + "type_version":"0.0.0", + "description":"Points to the operation to invoke on success. A value of \"final_success\" indicates and end to the operation.", + "default":"final_success", + "required":false + } + }, + "name":"onap.datatype.controlloop.Operation", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + }, + "description":"An operation supported by an actor" + }, + "onap.datatype.controlloop.Target":{ + "constraints":[ + + ], + "properties":{ + "entityIds":{ + "name":"entityIds", + "type":"map", + "type_version":"0.0.0", + "description":"Map of values that identify the resource. If none are provided, it is assumed that the\nentity that generated the ONSET event will be the target.\n", + "required":false, + "entry_schema":{ + "type":"string", + "type_version":"0.0.0" + }, + "metadata":{ + "clamp_possible_values":"ClampExecution:CSAR_RESOURCES" + } + }, + "targetType":{ + "name":"targetType", + "type":"string", + "type_version":"0.0.0", + "description":"Category for the target type", + "required":true, + "constraints":[ + { + "valid_values":[ + "VNF", + "VM", + "VFMODULE", + "PNF" + ] + } + ] + } + }, + "name":"onap.datatype.controlloop.Target", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + }, + "description":"Definition for a entity in A&AI to perform a control loop operation on" + }, + "onap.datatypes.ToscaConceptIdentifier":{ + "constraints":[ + + ], + "properties":{ + "version":{ + "name":"version", + "type":"string", + "type_version":"0.0.0", + "required":true + }, + "name":{ + "name":"name", + "type":"string", + "type_version":"0.0.0", + "required":true + } + }, + "name":"onap.datatypes.ToscaConceptIdentifier", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + } + }, + "onap.datatypes.monitoring.managedObjectDNsBasic":{ + "constraints":[ + + ], + "properties":{ + "DN":{ + "name":"DN", + "type":"string", + "type_version":"0.0.0", + "description":"Managed object distinguished name", + "required":true, + "constraints":[ + + ], + "metadata":{ + + } + } + }, + "name":"onap.datatypes.monitoring.managedObjectDNsBasic", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + } + }, + "onap.datatypes.monitoring.managedObjectDNsBasics":{ + "constraints":[ + + ], + "properties":{ + "managedObjectDNsBasic":{ + "name":"managedObjectDNsBasic", + "type":"map", + "type_version":"0.0.0", + "description":"Managed object distinguished name object", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"onap.datatypes.monitoring.managedObjectDNsBasic", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + } + }, + "name":"onap.datatypes.monitoring.managedObjectDNsBasics", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + } + }, + "onap.datatypes.monitoring.measurementGroup":{ + "constraints":[ + + ], + "properties":{ + "measurementTypes":{ + "name":"measurementTypes", + "type":"list", + "type_version":"0.0.0", + "description":"List of measurement types", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"onap.datatypes.monitoring.measurementTypes", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + }, + "managedObjectDNsBasic":{ + "name":"managedObjectDNsBasic", + "type":"list", + "type_version":"0.0.0", + "description":"List of managed object distinguished names", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"onap.datatypes.monitoring.managedObjectDNsBasics", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + } + }, + "name":"onap.datatypes.monitoring.measurementGroup", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + } + }, + "onap.datatypes.monitoring.measurementGroups":{ + "constraints":[ + + ], + "properties":{ + "measurementGroup":{ + "name":"measurementGroup", + "type":"map", + "type_version":"0.0.0", + "description":"Measurement Group", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"onap.datatypes.monitoring.measurementGroup", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + } + }, + "name":"onap.datatypes.monitoring.measurementGroups", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + } + }, + "onap.datatypes.monitoring.measurementType":{ + "constraints":[ + + ], + "properties":{ + "measurementType":{ + "name":"measurementType", + "type":"string", + "type_version":"0.0.0", + "description":"Measurement type", + "required":true, + "constraints":[ + + ], + "metadata":{ + + } + } + }, + "name":"onap.datatypes.monitoring.measurementType", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + } + }, + "onap.datatypes.monitoring.measurementTypes":{ + "constraints":[ + + ], + "properties":{ + "measurementType":{ + "name":"measurementType", + "type":"map", + "type_version":"0.0.0", + "description":"Measurement type object", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"onap.datatypes.monitoring.measurementType", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + } + }, + "name":"onap.datatypes.monitoring.measurementTypes", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + } + }, + "onap.datatypes.monitoring.nfFilter":{ + "constraints":[ + + ], + "properties":{ + "modelVersionIDs":{ + "name":"modelVersionIDs", + "type":"list", + "type_version":"0.0.0", + "description":"List of model version IDs", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"string", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + }, + "modelInvariantIDs":{ + "name":"modelInvariantIDs", + "type":"list", + "type_version":"0.0.0", + "description":"List of model invariant IDs", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"string", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + }, + "modelNames":{ + "name":"modelNames", + "type":"list", + "type_version":"0.0.0", + "description":"List of model names", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"string", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + }, + "nfNames":{ + "name":"nfNames", + "type":"list", + "type_version":"0.0.0", + "description":"List of network functions", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"string", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + } + }, + "name":"onap.datatypes.monitoring.nfFilter", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + } + }, + "onap.datatypes.monitoring.subscription":{ + "constraints":[ + + ], + "properties":{ + "measurementGroups":{ + "name":"measurementGroups", + "type":"list", + "type_version":"0.0.0", + "description":"Measurement Groups", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"onap.datatypes.monitoring.measurementGroups", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + }, + "fileBasedGP":{ + "name":"fileBasedGP", + "type":"integer", + "type_version":"0.0.0", + "description":"File based granularity period", + "required":true, + "constraints":[ + + ], + "metadata":{ + + } + }, + "fileLocation":{ + "name":"fileLocation", + "type":"string", + "type_version":"0.0.0", + "description":"ROP file location", + "required":true, + "constraints":[ + + ], + "metadata":{ + + } + }, + "subscriptionName":{ + "name":"subscriptionName", + "type":"string", + "type_version":"0.0.0", + "description":"Name of the subscription", + "required":true, + "constraints":[ + + ], + "metadata":{ + + } + }, + "administrativeState":{ + "name":"administrativeState", + "type":"string", + "type_version":"0.0.0", + "description":"State of the subscription", + "required":true, + "constraints":[ + { + "valid_values":[ + "LOCKED", + "UNLOCKED" + ] + } + ], + "metadata":{ + + } + }, + "nfFilter":{ + "name":"nfFilter", + "type":"map", + "type_version":"0.0.0", + "description":"Network function filter", + "required":true, + "constraints":[ + + ], + "entry_schema":{ + "type":"onap.datatypes.monitoring.nfFilter", + "type_version":"0.0.0", + "constraints":[ + + ] + }, + "metadata":{ + + } + } + }, + "name":"onap.datatypes.monitoring.subscription", + "version":"0.0.0", + "derived_from":"tosca.datatypes.Root", + "metadata":{ + + } + } + }, + "policy_types":{ + "onap.policies.Monitoring":{ + "properties":{ + + }, + "name":"onap.policies.Monitoring", + "version":"1.0.0", + "derived_from":"tosca.policies.Root", + "metadata":{ + + }, + "description":"a base policy type for all policies that govern monitoring provisioning" + }, + "onap.policies.Sirisha":{ + "properties":{ + + }, + "name":"onap.policies.Sirisha", + "version":"1.0.0", + "derived_from":"tosca.policies.Root", + "metadata":{ + + }, + "description":"a base policy type for all policies that govern monitoring provisioning" + }, + "onap.policies.controlloop.operational.Common":{ + "properties":{ + "abatement":{ + "name":"abatement", + "type":"boolean", + "type_version":"0.0.0", + "description":"Whether an abatement event message will be expected for the control loop from DCAE.", + "default":false, + "required":true + }, + "operations":{ + "name":"operations", + "type":"list", + "type_version":"0.0.0", + "description":"List of operations to be performed when Control Loop is triggered.", + "required":true, + "entry_schema":{ + "type":"onap.datatype.controlloop.Operation", + "type_version":"0.0.0" + } + }, + "trigger":{ + "name":"trigger", + "type":"string", + "type_version":"0.0.0", + "description":"Initial operation to execute upon receiving an Onset event message for the Control Loop.", + "required":true + }, + "timeout":{ + "name":"timeout", + "type":"integer", + "type_version":"0.0.0", + "description":"Overall timeout for executing all the operations. This timeout should equal or exceed the total\ntimeout for each operation listed.\n", + "required":true + }, + "id":{ + "name":"id", + "type":"string", + "type_version":"0.0.0", + "description":"The unique control loop id.", + "required":true + } + }, + "name":"onap.policies.controlloop.operational.Common", + "version":"1.0.0", + "derived_from":"tosca.policies.Root", + "metadata":{ + + }, + "description":"Operational Policy for Control Loop execution. Originated in Frankfurt to support TOSCA Compliant\nPolicy Types. This does NOT support the legacy Policy YAML policy type.\n" + }, + "onap.policies.controlloop.operational.common.Apex":{ + "properties":{ + "engineServiceParameters":{ + "name":"engineServiceParameters", + "type":"string", + "type_version":"0.0.0", + "description":"The engine parameters like name, instanceCount, policy implementation, parameters etc.", + "required":true + }, + "eventOutputParameters":{ + "name":"eventOutputParameters", + "type":"string", + "type_version":"0.0.0", + "description":"The event output parameters.", + "required":true + }, + "javaProperties":{ + "name":"javaProperties", + "type":"string", + "type_version":"0.0.0", + "description":"Name/value pairs of properties to be set for APEX if needed.", + "required":false + }, + "eventInputParameters":{ + "name":"eventInputParameters", + "type":"string", + "type_version":"0.0.0", + "description":"The event input parameters.", + "required":true + } + }, + "name":"onap.policies.controlloop.operational.common.Apex", + "version":"1.0.0", + "derived_from":"onap.policies.controlloop.operational.Common", + "metadata":{ + + }, + "description":"Operational policies for Apex PDP" + }, + "onap.policies.monitoring.dcae-pm-subscription-handler":{ + "properties":{ + "pmsh_policy":{ + "name":"pmsh_policy", + "type":"onap.datatypes.monitoring.subscription", + "type_version":"0.0.0", + "description":"PMSH Policy JSON", + "required":false, + "constraints":[ + + ], + "metadata":{ + + } + } + }, + "name":"onap.policies.monitoring.dcae-pm-subscription-handler", + "version":"1.0.0", + "derived_from":"onap.policies.Monitoring", + "metadata":{ + + } + } + }, + "topology_template":{ + + }, + "name":"NULL", + "version":"0.0.0" + }, + "propertiesMap": { + "provider_instance": { + "name": "provider_instance", + "version": "1.2.3", + "type": "org.onap.datatypes.policy.clamp.controlloop.policControlLoopElement.Chart", + "typeVersion": "1.0.0", + "description": "The helm chart for the microservice", + "required": true + } + }, + "description": "Monitoring Policy Control Loop Element for the PMSH instance 0 control loop" + }, + "709c62b3-8918-41b9-a747-d21eb79c6c22": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c22", + "definition": { + "name": "org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement", + "version": "1.2.3" + }, + "participantType":{ + "name":"org.onap.policy.controlloop.PolicyControlLoopParticipant", + "version":"2.3.1" + }, + "participantId":{ + "name":"org.onap.PM_Policy", + "version":"1.0.0" + }, + "state":"UNINITIALISED", + "orderedState":"UNINITIALISED", + "propertiesMap": { + "provider_instance": { + "name": "provider_instance", + "version": "1.2.3", + "type": "org.onap.datatypes.policy.clamp.controlloop.policControlLoopElement.Chart", + "typeVersion": "1.0.0", + "description": "The helm chart for the microservice", + "required": true + } + }, + "description": "Operational Policy Control Loop Element for the PMSH instance 0 control loop" + } + } + } + ] +}
\ No newline at end of file |