tosca_definitions_version: tosca_simple_yaml_1_3 data_types: onap.datatypes.ToscaConceptIdentifier: derived_from: tosca.datatypes.Root properties: name: type: string required: true version: type: string required: true 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 metadata: clamp_possible_values: ClampExecution:CSAR_RESOURCES 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 metadata: clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor operation: type: string description: The operation the actor is performing. metadata: clamp_possible_values: Dictionary:DefaultOperations,ClampExecution:CDS/operation required: true target: type: onap.datatype.controlloop.Target description: The resource the operation should be performed on. required: true payload: type: map description: Name/value pairs of payload information passed by Policy to the actor required: false metadata: clamp_possible_values: ClampExecution:CDS/payload 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: string description: A user-friendly description of the intent for the operation required: false operation: type: onap.datatype.controlloop.Actor description: The definition of the operation to be performed. required: true timeout: type: integer description: The amount of time for the actor to perform the operation. required: true 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 onap.datatypes.monitoring.managedObjectDNsBasic: constraints: [] properties: DN: name: DN type: string typeVersion: 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 typeVersion: 0.0.0 description: Managed object distinguished name object required: true constraints: [] entry_schema: type: onap.datatypes.monitoring.managedObjectDNsBasic typeVersion: 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 typeVersion: 0.0.0 description: List of measurement types required: true constraints: [] entry_schema: type: onap.datatypes.monitoring.measurementTypes typeVersion: 0.0.0 constraints: [] metadata: {} managedObjectDNsBasic: name: managedObjectDNsBasic type: list typeVersion: 0.0.0 description: List of managed object distinguished names required: true constraints: [] entry_schema: type: onap.datatypes.monitoring.managedObjectDNsBasics typeVersion: 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 typeVersion: 0.0.0 description: Measurement Group required: true constraints: [] entry_schema: type: onap.datatypes.monitoring.measurementGroup typeVersion: 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 typeVersion: 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 typeVersion: 0.0.0 description: Measurement type object required: true constraints: [] entry_schema: type: onap.datatypes.monitoring.measurementType typeVersion: 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: modelNames: name: modelNames type: list typeVersion: 0.0.0 description: List of model names required: true constraints: [] entry_schema: type: string typeVersion: 0.0.0 constraints: [] metadata: {} modelInvariantIDs: name: modelInvariantIDs type: list typeVersion: 0.0.0 description: List of model invariant IDs required: true constraints: [] entry_schema: type: string typeVersion: 0.0.0 constraints: [] metadata: {} modelVersionIDs: name: modelVersionIDs type: list typeVersion: 0.0.0 description: List of model version IDs required: true constraints: [] entry_schema: type: string typeVersion: 0.0.0 constraints: [] metadata: {} nfNames: name: nfNames type: list typeVersion: 0.0.0 description: List of network functions required: true constraints: [] entry_schema: type: string typeVersion: 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 typeVersion: 0.0.0 description: Measurement Groups required: true constraints: [] entry_schema: type: onap.datatypes.monitoring.measurementGroups typeVersion: 0.0.0 constraints: [] metadata: {} fileBasedGP: name: fileBasedGP type: integer typeVersion: 0.0.0 description: File based granularity period required: true constraints: [] metadata: {} fileLocation: name: fileLocation type: string typeVersion: 0.0.0 description: ROP file location required: true constraints: [] metadata: {} subscriptionName: name: subscriptionName type: string typeVersion: 0.0.0 description: Name of the subscription required: true constraints: [] metadata: {} administrativeState: name: administrativeState type: string typeVersion: 0.0.0 description: State of the subscription required: true constraints: - valid_values: - LOCKED - UNLOCKED metadata: {} nfFilter: name: nfFilter type: map typeVersion: 0.0.0 description: Network function filter required: true constraints: [] entry_schema: type: onap.datatypes.monitoring.nfFilter typeVersion: 0.0.0 constraints: [] metadata: {} name: onap.datatypes.monitoring.subscription version: 0.0.0 derived_from: tosca.datatypes.Root metadata: {} org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest: version: 1.0.0 derived_from: tosca.datatypes.Root properties: restRequestId: type: onap.datatypes.ToscaConceptIdentifier typeVersion: 1.0.0 required: true description: The name and version of a REST request to be sent to a REST endpoint httpMethod: type: string required: true constraints: - valid_values: [POST, PUT, GET, DELETE] description: The REST method to use path: type: string required: true description: The path of the REST request relative to the base URL body: type: string required: false description: The body of the REST request for PUT and POST requests expectedResponse: type: integer required: true constraints: - in_range: [100, 599] description: THe expected HTTP status code for the REST request org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity: version: 1.0.0 derived_from: tosca.datatypes.Root properties: configurationEntityId: type: onap.datatypes.ToscaConceptIdentifier typeVersion: 1.0.0 required: true description: The name and version of a Configuration Entity to be handled by the HTTP Control Loop Element restSequence: type: list entry_schema: type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest typeVersion: 1.0.0 description: A sequence of REST commands to send to the REST endpoint policy_types: onap.policies.Monitoring: derived_from: tosca.policies.Root description: a base policy type for all policies that govern monitoring provisioning version: 1.0.0 name: onap.policies.Monitoring onap.policies.Sirisha: derived_from: tosca.policies.Root description: a base policy type for all policies that govern monitoring provisioning version: 1.0.0 name: onap.policies.Sirisha onap.policies.monitoring.dcae-pm-subscription-handler: properties: pmsh_policy: name: pmsh_policy type: onap.datatypes.monitoring.subscription typeVersion: 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: {} onap.policies.controlloop.operational.Common: derived_from: tosca.policies.Root version: 1.0.0 name: onap.policies.controlloop.operational.Common description: | Operational Policy for Control Loop execution. Originated in Frankfurt to support TOSCA Compliant Policy Types. This does NOT support the legacy Policy YAML policy type. 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 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.Apex: derived_from: onap.policies.controlloop.operational.Common type_version: 1.0.0 version: 1.0.0 name: onap.policies.controlloop.operational.common.Apex description: Operational policies for Apex PDP properties: engineServiceParameters: type: string description: The engine parameters like name, instanceCount, policy implementation, parameters etc. required: true eventInputParameters: type: string description: The event input parameters. required: true eventOutputParameters: type: string description: The event output parameters. required: true javaProperties: type: string description: Name/value pairs of properties to be set for APEX if needed. required: false node_types: org.onap.policy.clamp.controlloop.Participant: version: 1.0.1 derived_from: tosca.nodetypes.Root properties: provider: type: string requred: false org.onap.policy.clamp.controlloop.ControlLoopElement: version: 1.0.1 derived_from: tosca.nodetypes.Root properties: provider: type: string required: false metadata: common: true description: Specifies the organization that provides the control loop element participant_id: type: onap.datatypes.ToscaConceptIdentifier requred: true metadata: common: true participantType: type: onap.datatypes.ToscaConceptIdentifier required: true metadata: common: true description: The identity of the participant type that hosts this type of Control Loop Element startPhase: type: integer required: false constraints: - greater_or_equal: 0 metadata: common: true description: A value indicating the start phase in which this control loop element will be started, the first start phase is zero. Control Loop Elements are started in their start_phase order and stopped in reverse start phase order. Control Loop Elements with the same start phase are started and stopped simultaneously uninitializedToPassiveTimeout: type: integer required: false constraints: - greater_or_equal: 0 default: 60 metadata: common: true description: The maximum time in seconds to wait for a state chage from uninitialized to passive passiveToRunningTimeout: type: integer required: false constraints: - greater_or_equal: 0 default: 60 metadata: common: true description: The maximum time in seconds to wait for a state chage from passive to running runningToPassiveTimeout: type: integer required: false constraints: - greater_or_equal: 0 default: 60 metadata: common: true description: The maximum time in seconds to wait for a state chage from running to passive passiveToUninitializedTimeout: type: integer required: false constraints: - greater_or_equal: 0 default: 60 metadata: common: true description: The maximum time in seconds to wait for a state chage from passive to uninitialized org.onap.policy.clamp.controlloop.ControlLoop: version: 1.0.1 derived_from: tosca.nodetypes.Root properties: provider: type: string required: false metadata: common: true description: Specifies the organization that provides the control loop element elements: type: list required: true metadata: common: true entry_schema: type: onap.datatypes.ToscaConceptIdentifier description: Specifies a list of control loop element definitions that make up this control loop definition org.onap.policy.clamp.controlloop.PolicyControlLoopElement: version: 1.0.1 derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement properties: policy_type_id: type: onap.datatypes.ToscaConceptIdentifier requred: true policy_id: type: onap.datatypes.ToscaConceptIdentifier requred: false org.onap.policy.clamp.controlloop.DerivedPolicyControlLoopElement: version: 1.0.1 derived_from: org.onap.policy.clamp.controlloop.PolicyControlLoopElement properties: policy_type_id: type: onap.datatypes.ToscaConceptIdentifier requred: true policy_id: type: onap.datatypes.ToscaConceptIdentifier requred: false org.onap.policy.clamp.controlloop.DerivedDerivedPolicyControlLoopElement: version: 1.0.1 derived_from: org.onap.policy.clamp.controlloop.DerivedPolicyControlLoopElement properties: policy_type_id: type: onap.datatypes.ToscaConceptIdentifier requred: true policy_id: type: onap.datatypes.ToscaConceptIdentifier requred: false org.onap.policy.clamp.controlloop.CDSControlLoopElement: version: 1.0.1 derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement properties: cds_blueprint_id: type: onap.datatypes.ToscaConceptIdentifier requred: true org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement: version: 1.0.1 derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement properties: chart: type: string required: true configs: type: list required: false requirements: type: string requred: false templates: type: list required: false entry_schema: values: type: string requred: true org.onap.policy.clamp.controlloop.HttpControlLoopElement: version: 1.0.1 derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement properties: baseUrl: type: string required: true description: The base URL to be prepended to each path, identifies the host for the REST endpoints. httpHeaders: type: map required: false entry_schema: type: string description: HTTP headers to send on REST requests configurationEntities: type: map required: true entry_schema: type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity typeVersion: 1.0.0 description: The connfiguration entities the Control Loop Element is managing and their associated REST requests topology_template: inputs: pmsh_monitoring_policy: type: onap.datatypes.ToscaConceptIdentifier description: The ID of the PMSH monitoring policy to use default: name: MICROSERVICE_vLoadBalancerMS_v1_0_dcae-pm-subscription-handler_1_0_0test version: 1.0.0 pmsh_operational_policy: type: onap.datatypes.ToscaConceptIdentifier description: The ID of the PMSH operational policy to use default: name: operational.apex.pmcontrol version: 1.0.0 node_templates: org.onap.policy.controlloop.PolicyControlLoopParticipant: version: 2.3.1 type: org.onap.policy.clamp.controlloop.Participant type_version: 1.0.1 description: Participant for DCAE microservices properties: provider: ONAP org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement: version: 1.2.3 type: org.onap.policy.clamp.controlloop.PolicyControlLoopElement type_version: 1.0.0 description: Control loop element for the monitoring policy for Performance Management Subscription Handling properties: provider: Ericsson participant_id: name: org.onap.PM_Policy version: 1.0.0 participantType: name: org.onap.policy.controlloop.PolicyControlLoopParticipant version: 2.3.1 policy_type_id: name: onap.policies.monitoring.pm-subscription-handler version: 1.0.0 policy_id: get_input: pmsh_monitoring_policy org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement: version: 1.2.3 type: org.onap.policy.clamp.controlloop.PolicyControlLoopElement type_version: 1.0.0 description: Control loop element for the operational policy for Performance Management Subscription Handling properties: provider: Ericsson participant_id: name: org.onap.PM_Policy version: 1.0.0 participantType: name: org.onap.policy.controlloop.PolicyControlLoopParticipant version: 2.3.1 policy_type_id: name: onap.policies.operational.pm-subscription-handler version: 1.0.0 policy_id: get_input: pmsh_operational_policy org.onap.k8s.controlloop.K8SControlLoopParticipant: version: 2.3.4 type: org.onap.policy.clamp.controlloop.Participant type_version: 1.0.1 description: Participant for K8S properties: provider: ONAP org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement: # Chart from new repository version: 1.2.3 type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement type_version: 1.0.0 description: Control loop element for the K8S microservice for PMSH properties: provider: ONAP participant_id: name: K8sParticipant0 version: 1.0.0 participantType: name: org.onap.k8s.controlloop.K8SControlLoopParticipant version: 2.3.4 chart: chartId: name: dcae-pmsh version: 8.0.0 namespace: onap releaseName: pmshms repository: repoName: chartmuseum protocol: http address: chart-museum port: 80 userName: onapinitializer password: demo123456! overrideParams: global.masterPassword: test org.onap.domain.database.Local_K8SMicroserviceControlLoopElement: # Chart installation without passing repository info version: 1.2.3 type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement type_version: 1.0.0 description: Control loop element for the K8S microservice for local chart properties: provider: ONAP participant_id: name: K8sParticipant0 version: 1.0.0 participantType: name: org.onap.k8s.controlloop.K8SControlLoopParticipant version: 2.3.4 chart: chartId: name: nginx-ingress version: 0.9.1 releaseName: nginxms namespace: test org.onap.controlloop.HttpControlLoopParticipant: version: 2.3.4 type: org.onap.policy.clamp.controlloop.Participant type_version: 1.0.1 description: Participant for Http requests properties: provider: ONAP org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement: # Consul http config for PMSH. version: 1.2.3 type: org.onap.policy.clamp.controlloop.HttpControlLoopElement type_version: 1.0.1 description: Control loop element for the http requests of PMSH microservice properties: provider: ONAP participant_id: name: HttpParticipant0 version: 1.0.0 participantType: name: org.onap.k8s.controlloop.HttpControlLoopParticipant version: 2.3.4 uninitializedToPassiveTimeout: 180 startPhase: 1 baseUrl: http://consul-server-ui:8500 httpHeaders: Content-Type: application/json configurationEntities: - configurationEntityId: name: entity1 version: 1.0.1 restSequence: - restRequestId: name: request1 version: 1.0.1 httpMethod: PUT path: v1/kv/dcae-pmsh2 body: '{ "control_loop_name":"pmsh-control-loop", "operational_policy_name":"pmsh-operational-policy", "aaf_password":"demo123456!", "aaf_identity":"dcae@dcae.onap.org", "cert_path":"/opt/app/pmsh/etc/certs/cert.pem", "key_path":"/opt/app/pmsh/etc/certs/key.pem", "ca_cert_path":"/opt/app/pmsh/etc/certs/cacert.pem", "enable_tls":"true", "pmsh_policy":{ "subscription":{ "subscriptionName":"ExtraPM-All-gNB-R2B", "administrativeState":"UNLOCKED", "fileBasedGP":15, "fileLocation":"\/pm\/pm.xml", "nfFilter":{ "nfNames":[ "^pnf.*", "^vnf.*" ], "modelInvariantIDs":[ ], "modelVersionIDs":[ ], "modelNames":[ ] }, "measurementGroups":[ { "measurementGroup":{ "measurementTypes":[ { "measurementType":"countera" }, { "measurementType":"counterb" } ], "managedObjectDNsBasic":[ { "DN":"dna" }, { "DN":"dnb" } ] } }, { "measurementGroup":{ "measurementTypes":[ { "measurementType":"counterc" }, { "measurementType":"counterd" } ], "managedObjectDNsBasic":[ { "DN":"dnc" }, { "DN":"dnd" } ] } } ] } }, "streams_subscribes":{ "aai_subscriber":{ "type":"message_router", "dmaap_info":{ "topic_url":"https://10.152.183.151:3905/events/AAI_EVENT", "client_role":"org.onap.dcae.aaiSub", "location":"san-francisco", "client_id":"1575976809466" } }, "policy_pm_subscriber":{ "type":"message_router", "dmaap_info":{ "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS", "client_role":"org.onap.dcae.pmSubscriber", "location":"san-francisco", "client_id":"1575876809456" } } }, "streams_publishes":{ "policy_pm_publisher":{ "type":"message_router", "dmaap_info":{ "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS", "client_role":"org.onap.dcae.pmPublisher", "location":"san-francisco", "client_id":"1475976809466" } }, "other_publisher":{ "type":"message_router", "dmaap_info":{ "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.SOME_OTHER_TOPIC", "client_role":"org.onap.dcae.pmControlPub", "location":"san-francisco", "client_id":"1875976809466" } } } }' expectedResponse: 200 org.onap.domain.sample.GenericK8s_ControlLoopDefinition: version: 1.2.3 type: org.onap.policy.clamp.controlloop.ControlLoop type_version: 1.0.0 description: Control loop for Hello World properties: provider: ONAP elements: - name: org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement version: 1.2.3 - name: org.onap.domain.database.Local_K8SMicroserviceControlLoopElement version: 1.2.3 - name: org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement version: 1.2.3 - name: org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement version: 1.2.3 - name: org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement version: 1.2.3 policies: - MICROSERVICE_vLoadBalancerMS_v1_0_dcae-pm-subscription-handler_1_0_0test: type: onap.policies.monitoring.dcae-pm-subscription-handler type_version: 1.0.0 name: MICROSERVICE_vLoadBalancerMS_v1_0_dcae-pm-subscription-handler_1_0_0test version: 1.0.0 metadata: policy-id: MICROSERVICE_vLoadBalancerMS_v1_0_dcae-pm-subscription-handler_1_0_0test policy-version: 1.0.0 properties: pmsh_policy: fileBasedGP: 15 fileLocation: /pm/pm.xml subscriptionName: subscriptiona administrativeState: UNLOCKED nfFilter: onap.datatypes.monitoring.nfFilter: modelVersionIDs: - e80a6ae3-cafd-4d24-850d-e14c084a5ca9 modelInvariantIDs: - 5845y423-g654-6fju-po78-8n53154532k6 - 7129e420-d396-4efb-af02-6b83499b12f8 modelNames: [] nfNames: - '"^pnf1.*"' measurementGroups: - measurementGroup: onap.datatypes.monitoring.measurementGroup: measurementTypes: - measurementType: onap.datatypes.monitoring.measurementType: measurementType: countera - measurementType: onap.datatypes.monitoring.measurementType: measurementType: counterb managedObjectDNsBasic: - managedObjectDNsBasic: onap.datatypes.monitoring.managedObjectDNsBasic: DN: dna - managedObjectDNsBasic: onap.datatypes.monitoring.managedObjectDNsBasic: DN: dnb - measurementGroup: onap.datatypes.monitoring.measurementGroup: measurementTypes: - measurementType: onap.datatypes.monitoring.measurementType: measurementType: counterc - measurementType: onap.datatypes.monitoring.measurementType: measurementType: counterd managedObjectDNsBasic: - managedObjectDNsBasic: onap.datatypes.monitoring.managedObjectDNsBasic: DN: dnc - managedObjectDNsBasic: onap.datatypes.monitoring.managedObjectDNsBasic: DN: dnd