1 tosca_definitions_version: tosca_simple_yaml_1_3
2 description: AutomationComposition types definitions version 1.0.0
5 onap.datatypes.ToscaConceptIdentifier:
6 derived_from: tosca.datatypes.Root
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
20 description: Category for the target type
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.
34 clamp_possible_values: 'ClampExecution:CSAR_RESOURCES'
37 onap.datatype.acm.Actor:
38 derived_from: tosca.datatypes.Root
39 description: An actor/operation/target definition
43 description: The actor performing the operation.
46 clamp_possible_values: 'Dictionary:DefaultActors,ClampExecution:CDS/actor'
49 description: The operation the actor is performing.
51 clamp_possible_values: 'Dictionary:DefaultOperations,ClampExecution:CDS/operation'
54 type: onap.datatype.acm.Target
55 description: The resource the operation should be performed on.
59 description: Name/value pairs of payload information passed by Policy to the actor
62 clamp_possible_values: 'ClampExecution:CDS/payload'
65 onap.datatype.acm.Operation:
66 derived_from: tosca.datatypes.Root
67 description: An operation supported by an actor
71 description: Unique identifier for the operation
75 description: A user-friendly description of the intent for the operation
78 type: onap.datatype.acm.Actor
79 description: The definition of the operation to be performed.
83 description: The amount of time for the actor to perform the operation.
87 description: The number of retries the actor should attempt to perform the
93 description: Points to the operation to invoke on success. A value of
94 "final_success" indicates and end to the operation.
96 default: final_success
99 description: Points to the operation to invoke on Actor operation failure.
101 default: final_failure
104 description: Points to the operation to invoke when the time out for the operation
107 default: final_failure_timeout
110 description: Points to the operation to invoke when the current operation has
111 exceeded its max retries.
113 default: final_failure_retries
116 description: Points to the operation to invoke when the current operation causes an
119 default: final_failure_exception
122 description: Points to the operation to invoke when the current operation is
123 blocked due to guard policy enforcement.
125 default: final_failure_guard
126 onap.datatypes.monitoring.managedObjectDNsBasic:
132 description: Managed object distinguished name
134 name: onap.datatypes.monitoring.managedObjectDNsBasic
136 derived_from: tosca.datatypes.Root
137 onap.datatypes.monitoring.managedObjectDNsBasics:
139 managedObjectDNsBasic:
140 name: managedObjectDNsBasic
143 description: Managed object distinguished name object
146 type: onap.datatypes.monitoring.managedObjectDNsBasic
148 name: onap.datatypes.monitoring.managedObjectDNsBasics
150 derived_from: tosca.datatypes.Root
151 onap.datatypes.monitoring.measurementGroup:
154 name: measurementTypes
157 description: List of measurement types
160 type: onap.datatypes.monitoring.measurementTypes
162 managedObjectDNsBasic:
163 name: managedObjectDNsBasic
166 description: List of managed object distinguished names
169 type: onap.datatypes.monitoring.managedObjectDNsBasics
171 name: onap.datatypes.monitoring.measurementGroup
173 derived_from: tosca.datatypes.Root
174 onap.datatypes.monitoring.measurementGroups:
177 name: measurementGroup
180 description: Measurement Group
183 type: onap.datatypes.monitoring.measurementGroup
185 name: onap.datatypes.monitoring.measurementGroups
187 derived_from: tosca.datatypes.Root
188 onap.datatypes.monitoring.measurementType:
191 name: measurementType
194 description: Measurement type
196 name: onap.datatypes.monitoring.measurementType
198 derived_from: tosca.datatypes.Root
199 onap.datatypes.monitoring.measurementTypes:
202 name: measurementType
205 description: Measurement type object
208 type: onap.datatypes.monitoring.measurementType
210 name: onap.datatypes.monitoring.measurementTypes
212 derived_from: tosca.datatypes.Root
213 onap.datatypes.monitoring.nfFilter:
219 description: List of model names
225 name: modelInvariantIDs
228 description: List of model invariant IDs
234 name: modelVersionIDs
237 description: List of model version IDs
246 description: List of network functions
251 name: onap.datatypes.monitoring.nfFilter
253 derived_from: tosca.datatypes.Root
254 onap.datatypes.monitoring.subscription:
257 name: measurementGroups
260 description: Measurement Groups
263 type: onap.datatypes.monitoring.measurementGroups
269 description: File based granularity period
275 description: ROP file location
278 name: subscriptionName
281 description: Name of the subscription
284 name: administrativeState
287 description: State of the subscription
297 description: Network function filter
300 type: onap.datatypes.monitoring.nfFilter
302 name: onap.datatypes.monitoring.subscription
304 derived_from: tosca.datatypes.Root
305 org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest:
307 derived_from: tosca.datatypes.Root
310 type: onap.datatypes.ToscaConceptIdentifier
313 description: The name and version of a REST request to be sent to a REST endpoint
323 description: The REST method to use
327 description: The path of the REST request relative to the base URL
331 description: The body of the REST request for PUT and POST requests
335 description: THe expected HTTP status code for the REST request
336 org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity:
338 derived_from: tosca.datatypes.Root
340 configurationEntityId:
341 type: onap.datatypes.ToscaConceptIdentifier
344 description: The name and version of a Configuration Entity to be handled by the
345 HTTP Automation Composition Element
349 type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest
351 description: A sequence of REST commands to send to the REST endpoint
353 onap.policies.Monitoring:
354 derived_from: tosca.policies.Root
355 description: a base policy type for all policies that govern monitoring provisioning
357 name: onap.policies.Monitoring
358 onap.policies.monitoring.dcae-pm-subscription-handler:
362 type: onap.datatypes.monitoring.subscription
364 description: PMSH Policy JSON
366 name: onap.policies.monitoring.dcae-pm-subscription-handler
368 derived_from: onap.policies.Monitoring
369 onap.policies.acm.operational.Common:
370 derived_from: tosca.policies.Root
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.
378 description: The unique acm id.
382 description: Overall timeout for executing all the operations. This timeout should
383 equal or exceed the total timeout for each operation listed.
387 description: Whether an abatement event message will be expected for the automation
388 composition from DCAE.
393 description: Initial operation to execute upon receiving an Onset event message for
394 the Automation Composition.
398 description: List of operations to be performed when Automation Composition is triggered.
401 type: onap.datatype.acm.Operation
402 onap.policies.acm.operational.common.Apex:
403 derived_from: onap.policies.acm.operational.Common
406 name: onap.policies.acm.operational.common.Apex
407 description: Operational policies for Apex PDP
409 engineServiceParameters:
411 description: The engine parameters like name, instanceCount, policy implementation,
414 eventInputParameters:
416 description: The event input parameters.
418 eventOutputParameters:
420 description: The event output parameters.
424 description: Name/value pairs of properties to be set for APEX if needed.
427 org.onap.policy.clamp.acm.Participant:
429 derived_from: tosca.nodetypes.Root
434 org.onap.policy.clamp.acm.AutomationCompositionElement:
436 derived_from: tosca.nodetypes.Root
443 description: Specifies the organization that provides the acm element
445 type: onap.datatypes.ToscaConceptIdentifier
450 type: onap.datatypes.ToscaConceptIdentifier
454 description: The identity of the participant type that hosts this type of Automation
460 - greater_or_equal: 0
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:
472 - greater_or_equal: 0
476 description: The maximum time in seconds to wait for a state chage from
477 uninitialized to passive
478 passiveToRunningTimeout:
482 - greater_or_equal: 0
486 description: The maximum time in seconds to wait for a state chage from passive to
488 runningToPassiveTimeout:
492 - greater_or_equal: 0
496 description: The maximum time in seconds to wait for a state chage from running to
498 passiveToUninitializedTimeout:
502 - greater_or_equal: 0
506 description: The maximum time in seconds to wait for a state chage from passive to
508 org.onap.policy.clamp.acm.AutomationComposition:
510 derived_from: tosca.nodetypes.Root
517 description: Specifies the organization that provides the acm element
524 type: onap.datatypes.ToscaConceptIdentifier
525 description: Specifies a list of acm element definitions that make up this
527 org.onap.policy.clamp.acm.PolicyAutomationCompositionElement:
529 derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
532 type: onap.datatypes.ToscaConceptIdentifier
535 type: onap.datatypes.ToscaConceptIdentifier
537 org.onap.policy.clamp.acm.CDSAutomationCompositionElement:
539 derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
542 type: onap.datatypes.ToscaConceptIdentifier
544 org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement:
546 derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
564 org.onap.policy.clamp.acm.HttpAutomationCompositionElement:
566 derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
571 description: The base URL to be prepended to each path, identifies the host for the
578 description: HTTP headers to send on REST requests
579 configurationEntities:
583 type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity
585 description: The connfiguration entities the Automation Composition Element is managing and
586 their associated REST requests