1 tosca_definitions_version: tosca_simple_yaml_1_3
3 onap.datatypes.ToscaConceptIdentifier:
4 derived_from: tosca.datatypes.Root
12 onap.datatype.controlloop.Target:
13 derived_from: tosca.datatypes.Root
14 description: Definition for a entity in A&AI to perform a control loop operation on
18 description: Category for the target type
29 Map of values that identify the resource. If none are provided, it is assumed that the
30 entity that generated the ONSET event will be the target.
33 clamp_possible_values: ClampExecution:CSAR_RESOURCES
36 onap.datatype.controlloop.Actor:
37 derived_from: tosca.datatypes.Root
38 description: An actor/operation/target definition
42 description: The actor performing the operation.
45 clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor
48 description: The operation the actor is performing.
50 clamp_possible_values: Dictionary:DefaultOperations,ClampExecution:CDS/operation
53 type: onap.datatype.controlloop.Target
54 description: The resource the operation should be performed on.
58 description: Name/value pairs of payload information passed by Policy to the actor
61 clamp_possible_values: ClampExecution:CDS/payload
64 onap.datatype.controlloop.Operation:
65 derived_from: tosca.datatypes.Root
66 description: An operation supported by an actor
70 description: Unique identifier for the operation
74 description: A user-friendly description of the intent for the operation
77 type: onap.datatype.controlloop.Actor
78 description: The definition of the operation to be performed.
82 description: The amount of time for the actor to perform the operation.
86 description: The number of retries the actor should attempt to perform the operation.
91 description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation.
93 default: final_success
96 description: Points to the operation to invoke on Actor operation failure.
98 default: final_failure
101 description: Points to the operation to invoke when the time out for the operation occurs.
103 default: final_failure_timeout
106 description: Points to the operation to invoke when the current operation has exceeded its max retries.
108 default: final_failure_retries
111 description: Points to the operation to invoke when the current operation causes an exception.
113 default: final_failure_exception
116 description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.
118 default: final_failure_guard
119 onap.datatypes.monitoring.managedObjectDNsBasic:
126 description: Managed object distinguished name
130 name: onap.datatypes.monitoring.managedObjectDNsBasic
132 derived_from: tosca.datatypes.Root
134 onap.datatypes.monitoring.managedObjectDNsBasics:
137 managedObjectDNsBasic:
138 name: managedObjectDNsBasic
141 description: Managed object distinguished name object
145 type: onap.datatypes.monitoring.managedObjectDNsBasic
149 name: onap.datatypes.monitoring.managedObjectDNsBasics
151 derived_from: tosca.datatypes.Root
153 onap.datatypes.monitoring.measurementGroup:
157 name: measurementTypes
160 description: List of measurement types
164 type: onap.datatypes.monitoring.measurementTypes
168 managedObjectDNsBasic:
169 name: managedObjectDNsBasic
172 description: List of managed object distinguished names
176 type: onap.datatypes.monitoring.managedObjectDNsBasics
180 name: onap.datatypes.monitoring.measurementGroup
182 derived_from: tosca.datatypes.Root
184 onap.datatypes.monitoring.measurementGroups:
188 name: measurementGroup
191 description: Measurement Group
195 type: onap.datatypes.monitoring.measurementGroup
199 name: onap.datatypes.monitoring.measurementGroups
201 derived_from: tosca.datatypes.Root
203 onap.datatypes.monitoring.measurementType:
207 name: measurementType
210 description: Measurement type
214 name: onap.datatypes.monitoring.measurementType
216 derived_from: tosca.datatypes.Root
218 onap.datatypes.monitoring.measurementTypes:
222 name: measurementType
225 description: Measurement type object
229 type: onap.datatypes.monitoring.measurementType
233 name: onap.datatypes.monitoring.measurementTypes
235 derived_from: tosca.datatypes.Root
237 onap.datatypes.monitoring.nfFilter:
244 description: List of model names
253 name: modelInvariantIDs
256 description: List of model invariant IDs
265 name: modelVersionIDs
268 description: List of model version IDs
280 description: List of network functions
288 name: onap.datatypes.monitoring.nfFilter
290 derived_from: tosca.datatypes.Root
292 onap.datatypes.monitoring.subscription:
296 name: measurementGroups
299 description: Measurement Groups
303 type: onap.datatypes.monitoring.measurementGroups
311 description: File based granularity period
319 description: ROP file location
324 name: subscriptionName
327 description: Name of the subscription
332 name: administrativeState
335 description: State of the subscription
346 description: Network function filter
350 type: onap.datatypes.monitoring.nfFilter
354 name: onap.datatypes.monitoring.subscription
356 derived_from: tosca.datatypes.Root
358 org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest:
360 derived_from: tosca.datatypes.Root
363 type: onap.datatypes.ToscaConceptIdentifier
366 description: The name and version of a REST request to be sent to a REST endpoint
371 - valid_values: [POST, PUT, GET, DELETE]
372 description: The REST method to use
376 description: The path of the REST request relative to the base URL
380 description: The body of the REST request for PUT and POST requests
385 - in_range: [100, 599]
386 description: THe expected HTTP status code for the REST request
387 org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity:
389 derived_from: tosca.datatypes.Root
391 configurationEntityId:
392 type: onap.datatypes.ToscaConceptIdentifier
395 description: The name and version of a Configuration Entity to be handled by the HTTP Control Loop Element
399 type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest
401 description: A sequence of REST commands to send to the REST endpoint
403 onap.policies.Monitoring:
404 derived_from: tosca.policies.Root
405 description: a base policy type for all policies that govern monitoring provisioning
407 name: onap.policies.Monitoring
408 onap.policies.Sirisha:
409 derived_from: tosca.policies.Root
410 description: a base policy type for all policies that govern monitoring provisioning
412 name: onap.policies.Sirisha
413 onap.policies.monitoring.dcae-pm-subscription-handler:
417 type: onap.datatypes.monitoring.subscription
419 description: PMSH Policy JSON
423 name: onap.policies.monitoring.dcae-pm-subscription-handler
425 derived_from: onap.policies.Monitoring
427 onap.policies.controlloop.operational.Common:
428 derived_from: tosca.policies.Root
430 name: onap.policies.controlloop.operational.Common
432 Operational Policy for Control Loop execution. Originated in Frankfurt to support TOSCA Compliant
433 Policy Types. This does NOT support the legacy Policy YAML policy type.
437 description: The unique control loop id.
442 Overall timeout for executing all the operations. This timeout should equal or exceed the total
443 timeout for each operation listed.
447 description: Whether an abatement event message will be expected for the control loop from DCAE.
452 description: Initial operation to execute upon receiving an Onset event message for the Control Loop.
456 description: List of operations to be performed when Control Loop is triggered.
459 type: onap.datatype.controlloop.Operation
460 onap.policies.controlloop.operational.common.Apex:
461 derived_from: onap.policies.controlloop.operational.Common
464 name: onap.policies.controlloop.operational.common.Apex
465 description: Operational policies for Apex PDP
467 engineServiceParameters:
469 description: The engine parameters like name, instanceCount, policy implementation, parameters etc.
471 eventInputParameters:
473 description: The event input parameters.
475 eventOutputParameters:
477 description: The event output parameters.
481 description: Name/value pairs of properties to be set for APEX if needed.
484 org.onap.policy.clamp.controlloop.Participant:
486 derived_from: tosca.nodetypes.Root
491 org.onap.policy.clamp.controlloop.ControlLoopElement:
493 derived_from: tosca.nodetypes.Root
500 description: Specifies the organization that provides the control loop element
502 type: onap.datatypes.ToscaConceptIdentifier
507 type: onap.datatypes.ToscaConceptIdentifier
511 description: The identity of the participant type that hosts this type of Control Loop Element
516 - greater_or_equal: 0
519 description: A value indicating the start phase in which this control loop element will be started, the
520 first start phase is zero. Control Loop Elements are started in their start_phase order and stopped
521 in reverse start phase order. Control Loop Elements with the same start phase are started and
522 stopped simultaneously
523 uninitializedToPassiveTimeout:
527 - greater_or_equal: 0
531 description: The maximum time in seconds to wait for a state chage from uninitialized to passive
532 passiveToRunningTimeout:
536 - greater_or_equal: 0
540 description: The maximum time in seconds to wait for a state chage from passive to running
541 runningToPassiveTimeout:
545 - greater_or_equal: 0
549 description: The maximum time in seconds to wait for a state chage from running to passive
550 passiveToUninitializedTimeout:
554 - greater_or_equal: 0
558 description: The maximum time in seconds to wait for a state chage from passive to uninitialized
559 org.onap.policy.clamp.controlloop.ControlLoop:
561 derived_from: tosca.nodetypes.Root
568 description: Specifies the organization that provides the control loop element
575 type: onap.datatypes.ToscaConceptIdentifier
576 description: Specifies a list of control loop element definitions that make up this control loop definition
577 org.onap.policy.clamp.controlloop.PolicyControlLoopElement:
579 derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement
582 type: onap.datatypes.ToscaConceptIdentifier
585 type: onap.datatypes.ToscaConceptIdentifier
587 org.onap.policy.clamp.controlloop.DerivedPolicyControlLoopElement:
589 derived_from: org.onap.policy.clamp.controlloop.PolicyControlLoopElement
592 type: onap.datatypes.ToscaConceptIdentifier
595 type: onap.datatypes.ToscaConceptIdentifier
597 org.onap.policy.clamp.controlloop.DerivedDerivedPolicyControlLoopElement:
599 derived_from: org.onap.policy.clamp.controlloop.DerivedPolicyControlLoopElement
602 type: onap.datatypes.ToscaConceptIdentifier
605 type: onap.datatypes.ToscaConceptIdentifier
607 org.onap.policy.clamp.controlloop.CDSControlLoopElement:
609 derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement
612 type: onap.datatypes.ToscaConceptIdentifier
614 org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement:
616 derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement
634 org.onap.policy.clamp.controlloop.HttpControlLoopElement:
636 derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement
641 description: The base URL to be prepended to each path, identifies the host for the REST endpoints.
647 description: HTTP headers to send on REST requests
648 configurationEntities:
652 type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity
654 description: The connfiguration entities the Control Loop Element is managing and their associated REST requests
658 pmsh_monitoring_policy:
659 type: onap.datatypes.ToscaConceptIdentifier
660 description: The ID of the PMSH monitoring policy to use
662 name: MICROSERVICE_vLoadBalancerMS_v1_0_dcae-pm-subscription-handler_1_0_0test
664 pmsh_operational_policy:
665 type: onap.datatypes.ToscaConceptIdentifier
666 description: The ID of the PMSH operational policy to use
668 name: operational.apex.pmcontrol
671 org.onap.policy.controlloop.PolicyControlLoopParticipant:
673 type: org.onap.policy.clamp.controlloop.Participant
675 description: Participant for DCAE microservices
678 org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement:
680 type: org.onap.policy.clamp.controlloop.PolicyControlLoopElement
682 description: Control loop element for the monitoring policy for Performance Management Subscription Handling
686 name: org.onap.PM_Policy
689 name: org.onap.policy.controlloop.PolicyControlLoopParticipant
692 name: onap.policies.monitoring.pm-subscription-handler
695 get_input: pmsh_monitoring_policy
696 org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement:
698 type: org.onap.policy.clamp.controlloop.PolicyControlLoopElement
700 description: Control loop element for the operational policy for Performance Management Subscription Handling
704 name: org.onap.PM_Policy
707 name: org.onap.policy.controlloop.PolicyControlLoopParticipant
710 name: onap.policies.operational.pm-subscription-handler
713 get_input: pmsh_operational_policy
714 org.onap.k8s.controlloop.K8SControlLoopParticipant:
716 type: org.onap.policy.clamp.controlloop.Participant
718 description: Participant for K8S
721 org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement:
722 # Chart from new repository
724 type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement
726 description: Control loop element for the K8S microservice for PMSH
730 name: K8sParticipant0
733 name: org.onap.k8s.controlloop.K8SControlLoopParticipant
742 repoName: chartmuseum
744 address: chart-museum
746 userName: onapinitializer
747 password: demo123456!
749 global.masterPassword: test
751 org.onap.domain.database.Local_K8SMicroserviceControlLoopElement:
752 # Chart installation without passing repository info
754 type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement
756 description: Control loop element for the K8S microservice for local chart
760 name: K8sParticipant0
763 name: org.onap.k8s.controlloop.K8SControlLoopParticipant
771 org.onap.controlloop.HttpControlLoopParticipant:
773 type: org.onap.policy.clamp.controlloop.Participant
775 description: Participant for Http requests
778 org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement:
779 # Consul http config for PMSH.
781 type: org.onap.policy.clamp.controlloop.HttpControlLoopElement
783 description: Control loop element for the http requests of PMSH microservice
787 name: HttpParticipant0
790 name: org.onap.k8s.controlloop.HttpControlLoopParticipant
792 uninitializedToPassiveTimeout: 180
794 baseUrl: http://consul-server-ui:8500
796 Content-Type: application/json
797 configurationEntities:
798 - configurationEntityId:
806 path: v1/kv/dcae-pmsh2
808 "control_loop_name":"pmsh-control-loop",
809 "operational_policy_name":"pmsh-operational-policy",
810 "aaf_password":"demo123456!",
811 "aaf_identity":"dcae@dcae.onap.org",
812 "cert_path":"/opt/app/pmsh/etc/certs/cert.pem",
813 "key_path":"/opt/app/pmsh/etc/certs/key.pem",
814 "ca_cert_path":"/opt/app/pmsh/etc/certs/cacert.pem",
818 "subscriptionName":"ExtraPM-All-gNB-R2B",
819 "administrativeState":"UNLOCKED",
821 "fileLocation":"\/pm\/pm.xml",
827 "modelInvariantIDs":[
834 "measurementGroups":[
839 "measurementType":"countera"
842 "measurementType":"counterb"
845 "managedObjectDNsBasic":[
859 "measurementType":"counterc"
862 "measurementType":"counterd"
865 "managedObjectDNsBasic":[
878 "streams_subscribes":{
880 "type":"message_router",
882 "topic_url":"https://10.152.183.151:3905/events/AAI_EVENT",
883 "client_role":"org.onap.dcae.aaiSub",
884 "location":"san-francisco",
885 "client_id":"1575976809466"
888 "policy_pm_subscriber":{
889 "type":"message_router",
891 "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS",
892 "client_role":"org.onap.dcae.pmSubscriber",
893 "location":"san-francisco",
894 "client_id":"1575876809456"
898 "streams_publishes":{
899 "policy_pm_publisher":{
900 "type":"message_router",
902 "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS",
903 "client_role":"org.onap.dcae.pmPublisher",
904 "location":"san-francisco",
905 "client_id":"1475976809466"
909 "type":"message_router",
911 "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.SOME_OTHER_TOPIC",
912 "client_role":"org.onap.dcae.pmControlPub",
913 "location":"san-francisco",
914 "client_id":"1875976809466"
919 expectedResponse: 200
920 org.onap.domain.sample.GenericK8s_ControlLoopDefinition:
922 type: org.onap.policy.clamp.controlloop.ControlLoop
924 description: Control loop for Hello World
928 - name: org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement
930 - name: org.onap.domain.database.Local_K8SMicroserviceControlLoopElement
932 - name: org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement
934 - name: org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement
936 - name: org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement
940 - MICROSERVICE_vLoadBalancerMS_v1_0_dcae-pm-subscription-handler_1_0_0test:
941 type: onap.policies.monitoring.dcae-pm-subscription-handler
943 name: MICROSERVICE_vLoadBalancerMS_v1_0_dcae-pm-subscription-handler_1_0_0test
946 policy-id: MICROSERVICE_vLoadBalancerMS_v1_0_dcae-pm-subscription-handler_1_0_0test
947 policy-version: 1.0.0
951 fileLocation: /pm/pm.xml
952 subscriptionName: subscriptiona
953 administrativeState: UNLOCKED
955 onap.datatypes.monitoring.nfFilter:
957 - e80a6ae3-cafd-4d24-850d-e14c084a5ca9
959 - 5845y423-g654-6fju-po78-8n53154532k6
960 - 7129e420-d396-4efb-af02-6b83499b12f8
966 onap.datatypes.monitoring.measurementGroup:
969 onap.datatypes.monitoring.measurementType:
970 measurementType: countera
972 onap.datatypes.monitoring.measurementType:
973 measurementType: counterb
974 managedObjectDNsBasic:
975 - managedObjectDNsBasic:
976 onap.datatypes.monitoring.managedObjectDNsBasic:
978 - managedObjectDNsBasic:
979 onap.datatypes.monitoring.managedObjectDNsBasic:
982 onap.datatypes.monitoring.measurementGroup:
985 onap.datatypes.monitoring.measurementType:
986 measurementType: counterc
988 onap.datatypes.monitoring.measurementType:
989 measurementType: counterd
990 managedObjectDNsBasic:
991 - managedObjectDNsBasic:
992 onap.datatypes.monitoring.managedObjectDNsBasic:
994 - managedObjectDNsBasic:
995 onap.datatypes.monitoring.managedObjectDNsBasic: