docs/clamp/acm/design-impl/participants/tosca/tosca-http-participant.yml

   1 tosca_definitions_version: tosca_simple_yaml_1_3
   2 data_types:
   3   onap.datatypes.ToscaConceptIdentifier:
   4     derived_from: tosca.datatypes.Root
   5     properties:
   6       name:
   7         type: string
   8         required: true
   9       version:
  10         type: string
  11         required: true
  12
  13   org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest:
  14     version: 1.0.0
  15     derived_from: tosca.datatypes.Root
  16     properties:
  17       restRequestId:
  18         type: onap.datatypes.ToscaConceptIdentifier
  19         required: true
  20         description: The name and version of a REST request to be sent to a REST endpoint
  21       httpMethod:
  22         type: string
  23         required: true
  24         constraints:
  25           - valid_values:
  26               - POST
  27               - PUT
  28               - GET
  29               - DELETE
  30         description: The REST method to use
  31       path:
  32         type: string
  33         required: true
  34         description: The path of the REST request relative to the base URL
  35       body:
  36         type: string
  37         required: false
  38         description: The body of the REST request for PUT and POST requests
  39       expectedResponse:
  40         type: integer
  41         required: true
  42         constraints: []
  43         description: THe expected HTTP status code for the REST request
  44   org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity:
  45     version: 1.0.0
  46     derived_from: tosca.datatypes.Root
  47     properties:
  48       configurationEntityId:
  49         type: onap.datatypes.ToscaConceptIdentifier
  50         required: true
  51         description: The name and version of a Configuration Entity to be handled
  52           by the HTTP Automation Composition Element
  53       restSequence:
  54         type: list
  55         entry_schema:
  56           type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest
  57           type_version: 1.0.0
  58         description: A sequence of REST commands to send to the REST endpoint
  59
  60 node_types:
  61   org.onap.policy.clamp.acm.Participant:
  62     version: 1.0.1
  63     derived_from: tosca.nodetypes.Root
  64     properties:
  65       provider:
  66         type: string
  67         required: false
  68   org.onap.policy.clamp.acm.AutomationCompositionElement:
  69     version: 1.0.1
  70     derived_from: tosca.nodetypes.Root
  71     properties:
  72       provider:
  73         type: string
  74         required: false
  75         metadata:
  76           common: true
  77         description: Specifies the organization that provides the automation composition element
  78       startPhase:
  79         type: integer
  80         required: false
  81         constraints:
  82           - greater_or_equal: 0
  83         metadata:
  84           common: true
  85         description: A value indicating the start phase in which this automation composition element will be started, the
  86           first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped
  87           in reverse start phase order. Automation Composition Elements with the same start phase are started and
  88           stopped simultaneously
  89       uninitializedToPassiveTimeout:
  90         type: integer
  91         required: false
  92         constraints:
  93           - greater_or_equal: 0
  94         default: 60
  95         metadata:
  96           common: true
  97         description: The maximum time in seconds to wait for a state chage from uninitialized to passive
  98       passiveToRunningTimeout:
  99         type: integer
 100         required: false
 101         constraints:
 102           - greater_or_equal: 0
 103         default: 60
 104         metadata:
 105           common: true
 106         description: The maximum time in seconds to wait for a state chage from passive to running
 107       runningToPassiveTimeout:
 108         type: integer
 109         required: false
 110         constraints:
 111           - greater_or_equal: 0
 112         default: 60
 113         metadata:
 114           common: true
 115         description: The maximum time in seconds to wait for a state chage from running to passive
 116       passiveToUninitializedTimeout:
 117         type: integer
 118         required: false
 119         constraints:
 120           - greater_or_equal: 0
 121         default: 60
 122         metadata:
 123           common: true
 124         description: The maximum time in seconds to wait for a state chage from passive to uninitialized
 125   org.onap.policy.clamp.acm.AutomationComposition:
 126     version: 1.0.1
 127     derived_from: tosca.nodetypes.Root
 128     properties:
 129       provider:
 130         type: string
 131         required: false
 132         metadata:
 133           common: true
 134         description: Specifies the organization that provides the automation composition element
 135       elements:
 136         type: list
 137         required: true
 138         metadata:
 139           common: true
 140         entry_schema:
 141           type: onap.datatypes.ToscaConceptIdentifier
 142         description: Specifies a list of automation composition element definitions that make up this automation composition definition
 143   org.onap.policy.clamp.acm.HttpAutomationCompositionElement:
 144     version: 1.0.0
 145     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
 146     properties:
 147       baseUrl:
 148         type: string
 149         required: true
 150         description: The base URL to be prepended to each path, identifies the host for the REST endpoints.
 151       httpHeaders:
 152         type: map
 153         required: false
 154         entry_schema:
 155           type: string
 156         description: HTTP headers to send on REST requests
 157       configurationEntities:
 158         type: map
 159         required: true
 160         entry_schema:
 161           type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity
 162           type_version: 1.0.0
 163         description: The connfiguration entities the Automation Composition Element is managing and their associated REST requests
 164
 165 topology_template:
 166   node_templates:
 167     org.onap.policy.clamp.acm.HttpParticipant:
 168       version: 2.3.4
 169       type: org.onap.policy.clamp.acm.Participant
 170       type_version: 1.0.1
 171       description: Participant for Http requests
 172       properties:
 173         provider: ONAP
 174     onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement:
 175       # Http config for AC Element Starter.
 176       version: 1.2.3
 177       type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement
 178       type_version: 1.0.0
 179       description: Automation composition element for the http requests of AC Element Starter microservice
 180       properties:
 181         provider: ONAP
 182         uninitializedToPassiveTimeout: 300
 183         startPhase: 1
 184
 185     onap.policy.clamp.ac.element.AutomationCompositionDefinition:
 186       version: 1.2.3
 187       type: org.onap.policy.clamp.acm.AutomationComposition
 188       type_version: 1.0.1
 189       description: Automation composition for Demo
 190       properties:
 191         provider: ONAP
 192         elements:
 193           - name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement
 194             version: 1.2.3