Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languageyml
titleLoop Definition
linenumberstrue
collapsetrue
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
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
        requred: false
      participant_id:
        type: onap.datatypes.ToscaConceptIdentifier
        requred: true
  org.onap.policy.clamp.controlloop.ControlLoop:
    version: 1.0.1
    derived_from: tosca.nodetypes.Root
    properties:
      provider:
        type: string
        requred: false
      elements:
        type: list
        required: true
        entry_schema:
          type: onap.datatypes.ToscaConceptIdentifier
  org.onap.policy.clamp.controlloop.DCAEMicroserviceControlLoopElement:
    version: 1.0.1
    derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement
    properties:
      dcae_blueprint_id:
        type: onap.datatypes.ToscaConceptIdentifier
        requred: true
  org.onap.policy.clamp.controlloop.PolicyTypeControlLoopElement:
    version: 1.0.1
    derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement
    properties:
      policy_type_id:
        type: onap.datatypes.ToscaConceptIdentifier
        requred: true
  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
topology_template:
  node_templates:
    org.onap.dcae.controlloop.DCAEMicroserviceControlLoopParticipant:
      version: 2.3.4
      type: org.onap.policy.clamp.controlloop.Participant
      type_version: 1.0.1
      description: Participant for DCAE microservices
      properties:
        provider: ONAP
    org.onap.policy.controlloop.MonitoringPolicyControlLoopParticipant:
      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.policy.controlloop.OperationalPolicyControlLoopParticipant:
      version: 3.2.1
      type: org.onap.policy.clamp.controlloop.Participant
      type_version: 1.0.1
      description: Participant for DCAE microservices
      properties:
        provider: ONAP
    org.onap.ccsdk.cds.controlloop.CdsControlLoopParticipant:
      version: 2.2.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_DCAEMicroservice:
      version: 1.2.3
      type: org.onap.policy.clamp.controlloop.DCAEMicroserviceControlLoopElement
      type_version: 1.0.0
      description: Control loop element for the DCAE microservice for Performance Management Subscription Handling
      properties:
        provider: Ericsson
        participant_id:
          name: org.onap.dcae.controlloop.DCAEMicroserviceControlLoopParticipant
          version: 2.3.4
        dcae_blueprint_id:
          name: org.onap.dcae.blueprints.PMSHBlueprint
          version: 1.0.0
    org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement:
      version: 1.2.3
      type: org.onap.policy.clamp.controlloop.PolicyTypeControlLoopElement
      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.policy.controlloop.PolicyControlLoopParticipant
          version: 2.3.1
        policy_type_id:
          name: onap.policies.monitoring.pm-subscription-handler
          version: 1.0.0
    org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement:
      version: 1.2.3
      type: org.onap.policy.clamp.controlloop.PolicyTypeControlLoopElement
      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.policy.controlloop.PolicyControlLoopParticipant
          version: 2.3.1
        policy_type_id:
          name: onap.policies.operational.pm-subscription-handler
          version: 1.0.0
    org.onap.domain.pmsh.PMSH_CDS_ControlLoopElement:
      version: 1.2.3
      type: org.onap.policy.clamp.controlloop.ControlLoopElement
      type_version: 1.0.0
      description: Control loop element for CDS for Performance Management Subscription Handling
      properties:
        provider: Ericsson
        participant_Id:
          name: org.onap.ccsdk.cds.controlloop.CdsControlLoopParticipant
          version: 3.2.1
        cds_blueprint_id:
          name: org.onap.ccsdk.cds.PMSHCdsBlueprint
          version: 1.0.0
    org.onap.domain.pmsh.PMSHControlLoopDefinition:
      version: 1.2.3
      type: org.onap.policy.clamp.controlloop.ControlLoop
      type_version: 1.0.0
      description: Control loop for Performance Management Subscription Handling
      properties:
        provider: Ericsson
        elements:
        - name: org.onap.domain.pmsh.PMSH_DCAEMicroservice
          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
        - name: org.onap.domain.pmsh.PMSH_CDS_ControlLoopElement
          version: 1.2.3

2.1.3 Example of two Control Loop instances

Code Block
languageyml
titleExample Control Loop Instances
linenumberstrue
collapsetrue
tosca_definitions_version: tosca_simple_yaml_1_3
capability_types:
  org.onap.EventProducer:
{
    "controlLoops": [
   properties:     {
 carrier_protocol_type:         type: string "name": "PMSHInstance0",
      required: true     "version": "1.0.1",
  constraints:         - valid_values: "definition": {
          - DMAAP_message_router     "name": "org.onap.domain.pmsh.PMSHControlLoopDefinition",
    - SOMETHING_ELSE           - REST"version": "1.0.0"
      data_format:      },
  type: string         required"state": true
"UNINITIALISED",
       constraints:     "orderedState": "UNINITIALISED",
  - valid_values:         "description": "PMSH -control JSONloop instance 0",
        - YAML   "elements": [
      - JMS       event_format:  {
      type: string         required: true   "id": "709c62b3-8918-41b9-a747-d21eb79c6c20",
  event_format_version:         type: string         required"definition": false{
      config_keys:         type: list         required: false"name": "org.onap.domain.pmsh.PMSH_DCAEMicroservice",
        entry_schema:           type: string    "version": "1.2.3"
     constraints:           - valid_values:   },
         - all valid values should be added here    "participantId": {
       - if not specified, events of any config key may be generated             - 'examples for config_key: ves-measurement, ves-syslog, tca_handle_out,"name": "DCAEParticipant0",
                   etc.'     "version": "1.0.0.1"
      derived_from: tosca.capabilities.Root   org.onap.EventConsumer:     properties:     },
 responding_capability:         type: string         required"state": false"UNINITIALISED",
      carrier_protocol_type:         type: string    "orderedState": "UNINITIALISED",
   required: true         constraints:       "description": "DCAE - valid_values:
       Control Loop Element for the PMSH instance 0 control loop"
  -  DMAAP_message_router           - SOMETHING_ELSE},
          - REST     {
 data_format:         type: string         required"id": true"709c62b3-8918-41b9-a747-d21eb79c6c21",
        constraints:         - valid_values:  "definition": {
       - JSON           - YAML    "name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement",
     - JMS           - all valid values should be added here
"version": "1.2.3"
     event_format:         type: string     },
   description: 'examples for event_format: Ves_specification, LinkUp, VnfConfigured,           etc.'
"participantId": {
       required: true       event_format_version:         type: string"name": "PolicyParticipant0",
                     description: 'examples for event_format_"version": 5"1.28.4, 7.30.1, etc.'0.0"
              required: false     },
 config_keys:         type: list         required"state": false"UNINITIALISED",
         entry_schema:           type"orderedState": string"UNINITIALISED",
          constraints:           - valid_values:
            - all valid values should be added here"description": "Monitoring Policy Control Loop Element for the PMSH instance 0 control loop"
                },
      - if not specified, events of any config key may be{
generated             - 'examples for config_key: ves-measurement, ves-syslog, tca_handle_out,
              etc.'
    version: 0.0.1
    derived_from: tosca.capabilities.Root
node_types:
  org.onap.DynamicConfig:
    properties:
      application_name:
        type: string
        description: Value used to tie the config to an application ? should we be
          using a relationship here instead?
        required: true
      application_version:
        type: string
        required: true
      application_provider:
        type: string
        required: false
      data_types:
        type: object
        required: false
      schema:
        type: object
        required: false
    version: 0.0.1
    derived_from: tosca.nodes.Root
  org.onap.APP:
    properties:
      application_name:
        type: string
        description: Human readable name for the application Product
        required: false
      provider:
        type: string
        description: Provider of the application and of the descriptor
        required: true
      application_version:
        type: string
        description: Software version of the application
        required: true
      blueprint_id:
        type: string
        description: A reference to the app blueprint
        required: false
      monitoring_policy:
        type: string
        description: A reference to the monitoring policy
        required: false
    requirements:
    - receive:
        capability: org.onap.EventProducer
        relationship: org.onap.PropagateEvent
        occurrences:
        - 0.0
        - UNBOUNDED
    - send:
        capability: org.onap.EventConsumer
        relationship: org.onap.PropagateEvent
        occurrences:
        - 0.0
        - UNBOUNDED
    version: 0.0.1
    derived_from: tosca.nodes.Root
  org.onap.EventRelay:
    properties:
      event_format:
        type: string
        description: 'examples for event_format: Ves_specification, etc.'
        required: true
      event_format_version:
        type: string
        description: 'examples for event_format_version: 5.28.4, 7.30.1, etc.'
        required: true
      config_keys:
        type: list
        required: false
        entry_schema:
          type: string
          constraints:
          - valid_values:
            - all valid values should be added here
            - if not specified, events of any config key is relayed
            - 'examples for config_key: ves-measurement, ves-syslog, tca_handle_out,
              etc.'
      supported_carrier_protocols:
        type: map
        description: 'A map describing supported carrier protocols and translations.
          The tuples define what protocol combinations are supported on the producer
          and consumer side: e.g. { REST: REST, DMAAP: REST, DMAAP: DMAAP}'
        required: true
        key_schema:
          type: string
          constraints:
          - valid_values:
            - DMAAP_message_router
            - SOMETHING_ELSE
            - REST
            - all valid values should be added here
        entry_schema:
          type: string
          constraints:
          - valid_values:
            - DMAAP_message_router
            - SOMETHING_ELSE
            - REST
            - all valid values should be added here
      supported_data_formats:
        type: map
        description: 'Is a map describing supported data formats and translation.
          The tuples define what protocol combinations are supported on the producer
          and consumer side: e.g. { JSON: JSON, JMS: JSON, YAML:YAML }'
        required: true
        key_schema:
          type: string
          constraints:
          - valid_values:
            - JSON
            - JMS
            - YAML
            - etc
            - all valid values should be added here
        entry_schema:
          type: string
          constraints:
          - valid_values:
            - JSON
            - JMS
            - YAML
            - etc
            - all valid values should be added here
    requirements:
    - receive:
        capability: org.onap.EventProducer
        relationship: org.onap.PropagateEvent
        occurrences:
        - 0.0
        - UNBOUNDED
    - send:
        capability: org.onap.EventConsumer
        relationship: org.onap.PropagateEvent
        occurrences:
        - 0.0
        - UNBOUNDED
    version: 0.0.1
    derived_from: tosca.nodes.Root
relationship_types:
  org.onap.PropagateEvent:
    properties:
      config_keys:
        type: list
        description: The relationship type used on requirements to org.onap.EventProducer
          and org.onap.EventConsumer capabilities. Filters events by specific config_keys
          to be transferred by this relationship. That is, any event with a specific
          config_key found in the list is transferred. If list is not defined or is
          empty, events with all config_keys are transferred.
        required: false
        entry_schema:
          type: string
    version: 0.0.1
    derived_from: tosca.relationships.Root
topology_template:
  inputs:
    pm_subscription_topic:
      type: string
    pm_subscription_response_topic:
      type: string
    pm_subscription_handler_blueprint_id:
      type: string
    pm_subscription_operational_policy_id:
      type: string
    pm_subscription_cds_blueprint_id:
      type: string
    enable_tls:
      type: string
  node_templates:
    org.onap.PM_Subscription_Handler:
      type: org.onap.APP
      properties:
        application_name: PM Subscription Handler
        provider: Ericsson
        application_version: 1.0.0
        artifact_id:
          get_input: pm_subscription_handler_blueprint_id
          description: Is this a reference to the DCAE Cloudify Blueprint that is   "id": "709c62b3-8918-41b9-a747-d21eb79c6c22",
                    already stored(or will be stored before CL configuration & instatiation)"definition": {
                    in DCAE Inventory?         artifact_config:
          enable_tls:
            get_input: enable_tls
          pmsh_publish_topic_name:"name": "org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement",
            get_input: pm_subscription_topic       capabilities:    "version": "1.2.3"
   pm-subscription-event-publisher:           properties:      },
      carrier_protocol_type: DMAAP_message_router             data_format"participantId": JSON{
            event_format: pm-subscription-event-format           "name":  event_format_version: 1.0.0"PolicyParticipant0",
            attributes:             type"version": org"1.onap0.EventProducer0"
          occurrences:          },
- 0.0           - UNBOUNDED       "state":  pm-subscription-event-receiver:"UNINITIALISED",
           properties:         "orderedState": "UNINITIALISED",
  carrier_protocol_type: DMAAP_message_router             data_format: JSON   "description": "Operational Policy Control Loop Element for the PMSH instance event_format: pm-subscription-event-response-format
0 control loop"
           event_format_version: 1.0.0    },
        relationships:        {
    - type: tosca.relationships.DependsOn             - description"id": any ideas on a better realtionship ? or is it better to"709c62b3-8918-41b9-a747-d21eb79c6c23",
                    "definition": {
     just use the root realtionship ?             - target"name": "org.onap.PM_Monitoring_Policy
domain.pmsh.PMSH_CDS_ControlLoopElement",
         attributes:             type: org.onap.EventConsumer           occurrences"version": "1.2.3"
         - 0.0           -},
UNBOUNDED     org.onap.PM_Monitoring_Policy:       type: org.onap.DynamicConfig       properties"participantId": {
       application_name: PM Subscription Handler         application_version: 1.0.0    "name": "CDSParticipant0",
   provider: Ericsson         data_types:           measurementType:"version": "1.0.0"
            type:  string      },
    DN:             type: string  "state": "UNINITIALISED",
       nfFilter:             properties"orderedState": "UNINITIALISED",
             nfNames:       "description": "CDS Control Loop Element for the PMSH instance  type: list0 control loop"
                }
 entry_schema: string          ]
    modelInvariantIDs:    },
        {
   type: list        "name": "PMSHInstance1",
       entry_schema:     "version": "1.0.1",
            type"definition": string{
                modelVersionIDs:"name": "org.onap.domain.pmsh.PMSHControlLoopDefinition",
                type"version": list"1.0.0"
            },
     entry_schema:       "state": "UNINITIALISED",
            type: string"orderedState": "UNINITIALISED",
            measurementGroup"description": "PMSH control loop instance 1",
       properties:     "elements": [
          masurementTypes:      {
          type: list         "id": "709c62b3-8918-41b9-a747-e21eb79c6c24",
      entry_schema:              "definition": {
   type: measurementType               managedObjectDNsBasic:     "name": "org.onap.domain.pmsh.PMSH_DCAEMicroservice",
          type: list             "version": "1.2.3"
  entry_schema:                   type:},
DN         schema:           subscription"participantId": {
           subscriptionName:               type"name": string"DCAEParticipant0",
              required: true             administrativeState"version": "1.0.0"
             type: string      },
        required: true             filebasedGP"state": "UNINITIALISED",
             type: integer      "orderedState": "UNINITIALISED",
       required: true             fileLocation"description": "DCAE              type: string
  Control Loop Element for the PMSH instance 1 control loop"
           required: true    },
        nfFilter:        {
      type: nfFilter             measurementGroups"id": "709c62b3-8918-41b9-a747-e21eb79c6c25",
             type: list      "definition": {
       entry_schema:                 type: measurementGroup"name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement",
      description: Should I be showing a dependency between PM Subscription Handler         and the PM Monitoring Policy"version": "1.2.3"
        org.onap.PM_Policy:       type: org.onap.APP    },
  properties:         application_name: PM Subscription Operational Policy     "participantId": {
  provider: Ericsson         application_version: 1.0.0         artifact_id:   "name": "PolicyParticipant0",
      get_input: pm_subscription_operational_policy_id         artifact_config: NOT_DEFINED       requirements"version": "1.0.0"
     - receive_0:           capability: pm-subscription-event-publisher  },
        node: org.onap.PM_Subscription_Handler           relationship"state": NOT_DEFINED"UNINITIALISED",
          properties:          "orderedState": "UNINITIALISED",
 config_keys:             - topic_name:     "description": "Monitoring Policy Control Loop Element for the PMSH instance 1 control loop"
  get_input: pm_subscription_topic       - send_0:     },
     capability: cds-rest-receive          {
node: org.onap.CDS       - receive_1:           capability"id": cds-rest-response"709c62b3-8918-41b9-a747-e21eb79c6c26",
           node: org.onap.CDS       - send_1 "definition": {
         capability: pm-subscription-event-receiver               node"name": "org.onap.PM_Subscription_Handlerdomain.pmsh.PMSH_OperationalPolicyControlLoopElement",
            relationship: NOT_DEFINED           properties"version": "1.2.3"
           config_keys:         },
   - topic_name:                 get_input: pm_subscription_response_topic"participantId": {
      capabilities:         pm-subscription-response-event-publisher:           properties"name":  "PolicyParticipant0",
          type: org.onap.EventProducer             carrier_protocol_type: DMAAP_message_router"version": "1.0.0"
             data_format: JSON      },
      event_format: pm-subscription-event-response-format             event_format_version: 1.0.0"state": "UNINITIALISED",
          occurrences:           - 0.0
"orderedState": "UNINITIALISED",
         - UNBOUNDED     org.onap.PM_CDS_Blueprint:       type"description": org.onap.APP
      properties:
   "Operational Policy Control Loop Element for the PMSH instance 1 control loop"
    application_name: PM Subscription CDS Blueprint        },
provider: Ericsson         application_version: 1.0.0       {
 artifact_id:           get_input: pm_subscription_cds_blueprint_id       capabilities:"id": "709c62b3-8918-41b9-a747-e21eb79c6c27",
         cds-rest-receive:           properties"definition": {
           type: org.onap.EventConsumer             protocol_type: REST"name": "org.onap.domain.pmsh.PMSH_CDS_ControlLoopElement",
             data_format: JSON          "version": "1.2.3"
 event_format: cds_action_format             event_format_version: 1.0.0    },
        responding_capability: cds-rest-response           occurrences"participantId": {
         - 0.0           - UNBOUNDED         cds-rest-response:"name": "CDSParticipant0",
           properties:             type"version": org"1.onap0.EventProducer0"
             protocol_type: REST      },
      data_format: JSON             event_format: cds_action_response_format"state": "UNINITIALISED",
            event_format_version: 1.0.0       "orderedState": "UNINITIALISED",
  occurrences:            - 0.0     org.onap.controlloop0"description": "CDS Control Loop Element for the type: org.onap.APP
  PMSH instance 1 control loop"
   properties:         application_name: Test Control Loop }
       provider: Ericsson    ]
    application_version: 1.0.0   }
     status: NOT_DEPLOYED
]
}


2.2: Modelling from TOSCA to Commissioned Data in Run Time Inventory

...