catalog-be/src/main/resources/import/tosca/models/init/acm/imports/acm.yaml

   1 tosca_definitions_version: tosca_simple_yaml_1_3
   2 description: AutomationComposition types definitions version 1.0.0
   3
   4 data_types:
   5   onap.datatypes.ToscaConceptIdentifier:
   6     derived_from: tosca.datatypes.Root
   7     properties:
   8       name:
   9         type: string
  10         required: true
  11       version:
  12         type: string
  13         required: true
  14   onap.datatype.acm.Target:
  15     derived_from: tosca.datatypes.Root
  16     description: Definition for a entity in A&AI to perform a acm operation on
  17     properties:
  18       targetType:
  19         type: string
  20         description: Category for the target type
  21         required: true
  22         constraints:
  23           - valid_values:
  24               - VNF
  25               - VM
  26               - VFMODULE
  27               - PNF
  28       entityIds:
  29         type: map
  30         description: Map of values that identify the resource. If none are provided, it is
  31           assumed that the entity that generated the ONSET event will be the target.
  32         required: false
  33         metadata:
  34           clamp_possible_values: 'ClampExecution:CSAR_RESOURCES'
  35         entry_schema:
  36           type: string
  37   onap.datatype.acm.Actor:
  38     derived_from: tosca.datatypes.Root
  39     description: An actor/operation/target definition
  40     properties:
  41       actor:
  42         type: string
  43         description: The actor performing the operation.
  44         required: true
  45         metadata:
  46           clamp_possible_values: 'Dictionary:DefaultActors,ClampExecution:CDS/actor'
  47       operation:
  48         type: string
  49         description: The operation the actor is performing.
  50         metadata:
  51           clamp_possible_values: 'Dictionary:DefaultOperations,ClampExecution:CDS/operation'
  52         required: true
  53       target:
  54         type: onap.datatype.acm.Target
  55         description: The resource the operation should be performed on.
  56         required: true
  57       payload:
  58         type: map
  59         description: Name/value pairs of payload information passed by Policy to the actor
  60         required: false
  61         metadata:
  62           clamp_possible_values: 'ClampExecution:CDS/payload'
  63         entry_schema:
  64           type: string
  65   onap.datatype.acm.Operation:
  66     derived_from: tosca.datatypes.Root
  67     description: An operation supported by an actor
  68     properties:
  69       id:
  70         type: string
  71         description: Unique identifier for the operation
  72         required: true
  73       description:
  74         type: string
  75         description: A user-friendly description of the intent for the operation
  76         required: false
  77       operation:
  78         type: onap.datatype.acm.Actor
  79         description: The definition of the operation to be performed.
  80         required: true
  81       timeout:
  82         type: integer
  83         description: The amount of time for the actor to perform the operation.
  84         required: true
  85       retries:
  86         type: integer
  87         description: The number of retries the actor should attempt to perform the
  88           operation.
  89         required: true
  90         default: 0
  91       success:
  92         type: string
  93         description: Points to the operation to invoke on success. A value of
  94           "final_success" indicates and end to the operation.
  95         required: false
  96         default: final_success
  97       failure:
  98         type: string
  99         description: Points to the operation to invoke on Actor operation failure.
 100         required: false
 101         default: final_failure
 102       failure_timeout:
 103         type: string
 104         description: Points to the operation to invoke when the time out for the operation
 105           occurs.
 106         required: false
 107         default: final_failure_timeout
 108       failure_retries:
 109         type: string
 110         description: Points to the operation to invoke when the current operation has
 111           exceeded its max retries.
 112         required: false
 113         default: final_failure_retries
 114       failure_exception:
 115         type: string
 116         description: Points to the operation to invoke when the current operation causes an
 117           exception.
 118         required: false
 119         default: final_failure_exception
 120       failure_guard:
 121         type: string
 122         description: Points to the operation to invoke when the current operation is
 123           blocked due to guard policy enforcement.
 124         required: false
 125         default: final_failure_guard
 126   onap.datatypes.monitoring.managedObjectDNsBasic:
 127     properties:
 128       DN:
 129         name: DN
 130         type: string
 131         typeVersion: 0.0.0
 132         description: Managed object distinguished name
 133         required: true
 134     name: onap.datatypes.monitoring.managedObjectDNsBasic
 135     version: 0.0.0
 136     derived_from: tosca.datatypes.Root
 137   onap.datatypes.monitoring.managedObjectDNsBasics:
 138     properties:
 139       managedObjectDNsBasic:
 140         name: managedObjectDNsBasic
 141         type: map
 142         typeVersion: 0.0.0
 143         description: Managed object distinguished name object
 144         required: true
 145         entry_schema:
 146           type: onap.datatypes.monitoring.managedObjectDNsBasic
 147           typeVersion: 0.0.0
 148     name: onap.datatypes.monitoring.managedObjectDNsBasics
 149     version: 0.0.0
 150     derived_from: tosca.datatypes.Root
 151   onap.datatypes.monitoring.measurementGroup:
 152     properties:
 153       measurementTypes:
 154         name: measurementTypes
 155         type: list
 156         typeVersion: 0.0.0
 157         description: List of measurement types
 158         required: true
 159         entry_schema:
 160           type: onap.datatypes.monitoring.measurementTypes
 161           typeVersion: 0.0.0
 162       managedObjectDNsBasic:
 163         name: managedObjectDNsBasic
 164         type: list
 165         typeVersion: 0.0.0
 166         description: List of managed object distinguished names
 167         required: true
 168         entry_schema:
 169           type: onap.datatypes.monitoring.managedObjectDNsBasics
 170           typeVersion: 0.0.0
 171     name: onap.datatypes.monitoring.measurementGroup
 172     version: 0.0.0
 173     derived_from: tosca.datatypes.Root
 174   onap.datatypes.monitoring.measurementGroups:
 175     properties:
 176       measurementGroup:
 177         name: measurementGroup
 178         type: map
 179         typeVersion: 0.0.0
 180         description: Measurement Group
 181         required: true
 182         entry_schema:
 183           type: onap.datatypes.monitoring.measurementGroup
 184           typeVersion: 0.0.0
 185     name: onap.datatypes.monitoring.measurementGroups
 186     version: 0.0.0
 187     derived_from: tosca.datatypes.Root
 188   onap.datatypes.monitoring.measurementType:
 189     properties:
 190       measurementType:
 191         name: measurementType
 192         type: string
 193         typeVersion: 0.0.0
 194         description: Measurement type
 195         required: true
 196     name: onap.datatypes.monitoring.measurementType
 197     version: 0.0.0
 198     derived_from: tosca.datatypes.Root
 199   onap.datatypes.monitoring.measurementTypes:
 200     properties:
 201       measurementType:
 202         name: measurementType
 203         type: map
 204         typeVersion: 0.0.0
 205         description: Measurement type object
 206         required: true
 207         entry_schema:
 208           type: onap.datatypes.monitoring.measurementType
 209           typeVersion: 0.0.0
 210     name: onap.datatypes.monitoring.measurementTypes
 211     version: 0.0.0
 212     derived_from: tosca.datatypes.Root
 213   onap.datatypes.monitoring.nfFilter:
 214     properties:
 215       modelNames:
 216         name: modelNames
 217         type: list
 218         typeVersion: 0.0.0
 219         description: List of model names
 220         required: true
 221         entry_schema:
 222           type: string
 223           typeVersion: 0.0.0
 224       modelInvariantIDs:
 225         name: modelInvariantIDs
 226         type: list
 227         typeVersion: 0.0.0
 228         description: List of model invariant IDs
 229         required: true
 230         entry_schema:
 231           type: string
 232           typeVersion: 0.0.0
 233       modelVersionIDs:
 234         name: modelVersionIDs
 235         type: list
 236         typeVersion: 0.0.0
 237         description: List of model version IDs
 238         required: true
 239         entry_schema:
 240           type: string
 241           typeVersion: 0.0.0
 242       nfNames:
 243         name: nfNames
 244         type: list
 245         typeVersion: 0.0.0
 246         description: List of network functions
 247         required: true
 248         entry_schema:
 249           type: string
 250           typeVersion: 0.0.0
 251     name: onap.datatypes.monitoring.nfFilter
 252     version: 0.0.0
 253     derived_from: tosca.datatypes.Root
 254   onap.datatypes.monitoring.subscription:
 255     properties:
 256       measurementGroups:
 257         name: measurementGroups
 258         type: list
 259         typeVersion: 0.0.0
 260         description: Measurement Groups
 261         required: true
 262         entry_schema:
 263           type: onap.datatypes.monitoring.measurementGroups
 264           typeVersion: 0.0.0
 265       fileBasedGP:
 266         name: fileBasedGP
 267         type: integer
 268         typeVersion: 0.0.0
 269         description: File based granularity period
 270         required: true
 271       fileLocation:
 272         name: fileLocation
 273         type: string
 274         typeVersion: 0.0.0
 275         description: ROP file location
 276         required: true
 277       subscriptionName:
 278         name: subscriptionName
 279         type: string
 280         typeVersion: 0.0.0
 281         description: Name of the subscription
 282         required: true
 283       administrativeState:
 284         name: administrativeState
 285         type: string
 286         typeVersion: 0.0.0
 287         description: State of the subscription
 288         required: true
 289         constraints:
 290           - valid_values:
 291               - LOCKED
 292               - UNLOCKED
 293       nfFilter:
 294         name: nfFilter
 295         type: map
 296         typeVersion: 0.0.0
 297         description: Network function filter
 298         required: true
 299         entry_schema:
 300           type: onap.datatypes.monitoring.nfFilter
 301           typeVersion: 0.0.0
 302     name: onap.datatypes.monitoring.subscription
 303     version: 0.0.0
 304     derived_from: tosca.datatypes.Root
 305   org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest:
 306     version: 1.0.0
 307     derived_from: tosca.datatypes.Root
 308     properties:
 309       restRequestId:
 310         type: onap.datatypes.ToscaConceptIdentifier
 311         typeVersion: 1.0.0
 312         required: true
 313         description: The name and version of a REST request to be sent to a REST endpoint
 314       httpMethod:
 315         type: string
 316         required: true
 317         constraints:
 318           - valid_values:
 319               - POST
 320               - PUT
 321               - GET
 322               - DELETE
 323         description: The REST method to use
 324       path:
 325         type: string
 326         required: true
 327         description: The path of the REST request relative to the base URL
 328       body:
 329         type: string
 330         required: false
 331         description: The body of the REST request for PUT and POST requests
 332       expectedResponse:
 333         type: integer
 334         required: true
 335         description: THe expected HTTP status code for the REST request
 336     org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity:
 337       version: 1.0.0
 338       derived_from: tosca.datatypes.Root
 339       properties:
 340         configurationEntityId:
 341           type: onap.datatypes.ToscaConceptIdentifier
 342           typeVersion: 1.0.0
 343           required: true
 344           description: The name and version of a Configuration Entity to be handled by the
 345             HTTP Automation Composition Element
 346         restSequence:
 347           type: list
 348           entry_schema:
 349             type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest
 350             typeVersion: 1.0.0
 351           description: A sequence of REST commands to send to the REST endpoint
 352 policy_types:
 353   onap.policies.Monitoring:
 354     derived_from: tosca.policies.Root
 355     description: a base policy type for all policies that govern monitoring provisioning
 356     version: 1.0.0
 357     name: onap.policies.Monitoring
 358   onap.policies.monitoring.dcae-pm-subscription-handler:
 359     properties:
 360       pmsh_policy:
 361         name: pmsh_policy
 362         type: onap.datatypes.monitoring.subscription
 363         typeVersion: 0.0.0
 364         description: PMSH Policy JSON
 365         required: false
 366     name: onap.policies.monitoring.dcae-pm-subscription-handler
 367     version: 1.0.0
 368     derived_from: onap.policies.Monitoring
 369   onap.policies.acm.operational.Common:
 370     derived_from: tosca.policies.Root
 371     version: 1.0.0
 372     name: onap.policies.acm.operational.Common
 373     description: Operational Policy for Automation Composition execution. Originated in Frankfurt to
 374       support TOSCA Compliant Policy Types. This does NOT support the legacy Policy YAML policy type.
 375     properties:
 376       id:
 377         type: string
 378         description: The unique acm id.
 379         required: true
 380       timeout:
 381         type: integer
 382         description: Overall timeout for executing all the operations. This timeout should
 383           equal or exceed the total timeout for each operation listed.
 384         required: true
 385       abatement:
 386         type: boolean
 387         description: Whether an abatement event message will be expected for the automation
 388           composition from DCAE.
 389         required: true
 390         default: false
 391       trigger:
 392         type: string
 393         description: Initial operation to execute upon receiving an Onset event message for
 394           the Automation Composition.
 395         required: true
 396       operations:
 397         type: list
 398         description: List of operations to be performed when Automation Composition is triggered.
 399         required: true
 400         entry_schema:
 401           type: onap.datatype.acm.Operation
 402   onap.policies.acm.operational.common.Apex:
 403     derived_from: onap.policies.acm.operational.Common
 404     type_version: 1.0.0
 405     version: 1.0.0
 406     name: onap.policies.acm.operational.common.Apex
 407     description: Operational policies for Apex PDP
 408     properties:
 409       engineServiceParameters:
 410         type: string
 411         description: The engine parameters like name, instanceCount, policy implementation,
 412           parameters etc.
 413         required: true
 414       eventInputParameters:
 415         type: string
 416         description: The event input parameters.
 417         required: true
 418       eventOutputParameters:
 419         type: string
 420         description: The event output parameters.
 421         required: true
 422       javaProperties:
 423         type: string
 424         description: Name/value pairs of properties to be set for APEX if needed.
 425         required: false
 426 node_types:
 427   org.onap.policy.clamp.acm.Participant:
 428     version: 1.0.1
 429     derived_from: tosca.nodetypes.Root
 430     properties:
 431       provider:
 432         type: string
 433         required: false
 434   org.onap.policy.clamp.acm.AutomationCompositionElement:
 435     version: 1.0.1
 436     derived_from: tosca.nodetypes.Root
 437     properties:
 438       provider:
 439         type: string
 440         required: false
 441         metadata:
 442           common: 'true'
 443         description: Specifies the organization that provides the acm element
 444       participant_id:
 445         type: onap.datatypes.ToscaConceptIdentifier
 446         required: true
 447         metadata:
 448           common: 'true'
 449       participantType:
 450         type: onap.datatypes.ToscaConceptIdentifier
 451         required: true
 452         metadata:
 453           common: 'true'
 454         description: The identity of the participant type that hosts this type of Automation
 455           Composition Element
 456       startPhase:
 457         type: integer
 458         required: false
 459         constraints:
 460           - greater_or_equal: 0
 461         metadata:
 462           common: 'true'
 463         description: A value indicating the start phase in which this acm element
 464           will be started, the first start phase is zero. Automation Composition Elements
 465           are started in their start_phase order and stopped in reverse start
 466           phase order. Automation Composition Elements with the same start phase are
 467           started and stopped simultaneously
 468       uninitializedToPassiveTimeout:
 469         type: integer
 470         required: false
 471         constraints:
 472           - greater_or_equal: 0
 473         default: 60
 474         metadata:
 475           common: 'true'
 476         description: The maximum time in seconds to wait for a state chage from
 477           uninitialized to passive
 478       passiveToRunningTimeout:
 479         type: integer
 480         required: false
 481         constraints:
 482           - greater_or_equal: 0
 483         default: 60
 484         metadata:
 485           common: 'true'
 486         description: The maximum time in seconds to wait for a state chage from passive to
 487           running
 488       runningToPassiveTimeout:
 489         type: integer
 490         required: false
 491         constraints:
 492           - greater_or_equal: 0
 493         default: 60
 494         metadata:
 495           common: 'true'
 496         description: The maximum time in seconds to wait for a state chage from running to
 497           passive
 498       passiveToUninitializedTimeout:
 499         type: integer
 500         required: false
 501         constraints:
 502           - greater_or_equal: 0
 503         default: 60
 504         metadata:
 505           common: 'true'
 506         description: The maximum time in seconds to wait for a state chage from passive to
 507           uninitialized
 508   org.onap.policy.clamp.acm.AutomationComposition:
 509     version: 1.0.1
 510     derived_from: tosca.nodetypes.Root
 511     properties:
 512       provider:
 513         type: string
 514         required: false
 515         metadata:
 516           common: 'true'
 517         description: Specifies the organization that provides the acm element
 518       elements:
 519         type: list
 520         required: true
 521         metadata:
 522           common: 'true'
 523         entry_schema:
 524           type: onap.datatypes.ToscaConceptIdentifier
 525         description: Specifies a list of acm element definitions that make up this
 526           acm definition
 527   org.onap.policy.clamp.acm.PolicyAutomationCompositionElement:
 528     version: 1.0.1
 529     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
 530     properties:
 531       policy_type_id:
 532         type: onap.datatypes.ToscaConceptIdentifier
 533         required: true
 534       policy_id:
 535         type: onap.datatypes.ToscaConceptIdentifier
 536         required: false
 537   org.onap.policy.clamp.acm.CDSAutomationCompositionElement:
 538     version: 1.0.1
 539     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
 540     properties:
 541       cds_blueprint_id:
 542         type: onap.datatypes.ToscaConceptIdentifier
 543         required: true
 544   org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement:
 545     version: 1.0.1
 546     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
 547     properties:
 548       chart:
 549         type: string
 550         required: true
 551       configs:
 552         type: list
 553         required: false
 554       requirements:
 555         type: string
 556         required: false
 557       templates:
 558         type: list
 559         required: false
 560         entry_schema: null
 561       values:
 562         type: string
 563         required: true
 564   org.onap.policy.clamp.acm.HttpAutomationCompositionElement:
 565     version: 1.0.1
 566     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
 567     properties:
 568       baseUrl:
 569         type: string
 570         required: true
 571         description: The base URL to be prepended to each path, identifies the host for the
 572           REST endpoints.
 573       httpHeaders:
 574         type: map
 575         required: false
 576         entry_schema:
 577           type: string
 578         description: HTTP headers to send on REST requests
 579       configurationEntities:
 580         type: map
 581         required: true
 582         entry_schema:
 583           type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity
 584           typeVersion: 1.0.0
 585         description: The connfiguration entities the Automation Composition Element is managing and
 586           their associated REST requests
 587   tosca.dataTypes.tmf.milestoneJeopardyData:
 588     derived_from: tosca.datatypes.Root
 589     properties:
 590       name:
 591         type: string
 592         required: true
 593       message:
 594         type: string
 595         required: true
 596       eventType:
 597         type: string
 598         required: true
 599         valid_values: [milestone, jeopardy]
 600       jeopardyType:
 601         type: string
 602         required: false
 603         valid_values: [normal, critical, hazard]