From e206a1075b6c3620d6484b60e9326fcc56d03c77 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 7 Oct 2021 19:00:18 +0100 Subject: Restructure CLAMP documentation tree Restructured and refactored the CLAMP documentation - Introduced a hierarchical structure to the documentaiton - Added a tree for builtin and TOSCA CLAMP - Cleaned up formatting - Added documentation for participants - Added placeholders for missing particioant, control loop runtime, and control loop GUI documentation - Fixed some hanging references Issue-ID: POLICY-3363 Change-Id: I3933be08af3984f2bb4e08707a8c5b5b454f540c Signed-off-by: liamfallon --- .../controlloop/api-protocol/api-protocol.rst | 15 + .../controlloop-participant-protocol.rst | 472 +++++++++++++++++ .../api-protocol/controlloop-rest-apis.rst | 130 +++++ .../swagger/controlloop-comissioning.json | 473 +++++++++++++++++ .../swagger/controlloop-instantiation.json | 584 +++++++++++++++++++++ .../swagger/controlloop-monitoring.json | 521 ++++++++++++++++++ .../api-protocol/swagger/k8sparticipant.json | 392 ++++++++++++++ .../api-protocol/swagger/participant-sim.json | 478 +++++++++++++++++ .../api-protocol/system-level-dialogues.rst | 198 +++++++ .../clamp/controlloop/controlloop-architecture.rst | 468 +++++++++++++++++ .../controlloop-participant-protocol.rst | 472 ----------------- docs/clamp/controlloop/controlloop-rest-apis.rst | 130 ----- docs/clamp/controlloop/controlloop.rst | 471 +---------------- docs/clamp/controlloop/defining-controlloops.rst | 2 +- .../design-impl/clamp-controlloop-runtime.rst | 8 + .../design-impl/clamp-gui-controlloop.rst | 8 + docs/clamp/controlloop/design-impl/design-impl.rst | 15 + .../design-impl/participants/http-participant.rst | 103 ++++ .../design-impl/participants/k8s-participant.rst | 8 + .../participants/participant-intermediary.rst | 13 + .../participants/participant-simulator.rst | 8 + .../design-impl/participants/participants.rst | 39 ++ .../participants/policy-framework-participant.rst | 8 + docs/clamp/controlloop/images/04-overview.png | Bin 179618 -> 149228 bytes .../images/participants/http-participant.png | Bin 0 -> 82121 bytes .../images/participants/participants.png | Bin 0 -> 77886 bytes .../swagger/controlloop-comissioning.json | 473 ----------------- .../swagger/controlloop-instantiation.json | 584 --------------------- .../swagger/controlloop-monitoring.json | 521 ------------------ docs/clamp/controlloop/swagger/k8sparticipant.json | 392 -------------- .../clamp/controlloop/swagger/participant-sim.json | 478 ----------------- docs/clamp/controlloop/system-level-dialogues.rst | 198 ------- 32 files changed, 3950 insertions(+), 3712 deletions(-) create mode 100644 docs/clamp/controlloop/api-protocol/api-protocol.rst create mode 100644 docs/clamp/controlloop/api-protocol/controlloop-participant-protocol.rst create mode 100644 docs/clamp/controlloop/api-protocol/controlloop-rest-apis.rst create mode 100644 docs/clamp/controlloop/api-protocol/swagger/controlloop-comissioning.json create mode 100644 docs/clamp/controlloop/api-protocol/swagger/controlloop-instantiation.json create mode 100644 docs/clamp/controlloop/api-protocol/swagger/controlloop-monitoring.json create mode 100644 docs/clamp/controlloop/api-protocol/swagger/k8sparticipant.json create mode 100644 docs/clamp/controlloop/api-protocol/swagger/participant-sim.json create mode 100644 docs/clamp/controlloop/api-protocol/system-level-dialogues.rst create mode 100644 docs/clamp/controlloop/controlloop-architecture.rst delete mode 100644 docs/clamp/controlloop/controlloop-participant-protocol.rst delete mode 100644 docs/clamp/controlloop/controlloop-rest-apis.rst create mode 100644 docs/clamp/controlloop/design-impl/clamp-controlloop-runtime.rst create mode 100644 docs/clamp/controlloop/design-impl/clamp-gui-controlloop.rst create mode 100644 docs/clamp/controlloop/design-impl/design-impl.rst create mode 100644 docs/clamp/controlloop/design-impl/participants/http-participant.rst create mode 100644 docs/clamp/controlloop/design-impl/participants/k8s-participant.rst create mode 100644 docs/clamp/controlloop/design-impl/participants/participant-intermediary.rst create mode 100644 docs/clamp/controlloop/design-impl/participants/participant-simulator.rst create mode 100644 docs/clamp/controlloop/design-impl/participants/participants.rst create mode 100644 docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst create mode 100644 docs/clamp/controlloop/images/participants/http-participant.png create mode 100644 docs/clamp/controlloop/images/participants/participants.png delete mode 100644 docs/clamp/controlloop/swagger/controlloop-comissioning.json delete mode 100644 docs/clamp/controlloop/swagger/controlloop-instantiation.json delete mode 100644 docs/clamp/controlloop/swagger/controlloop-monitoring.json delete mode 100644 docs/clamp/controlloop/swagger/k8sparticipant.json delete mode 100644 docs/clamp/controlloop/swagger/participant-sim.json delete mode 100644 docs/clamp/controlloop/system-level-dialogues.rst (limited to 'docs/clamp/controlloop') diff --git a/docs/clamp/controlloop/api-protocol/api-protocol.rst b/docs/clamp/controlloop/api-protocol/api-protocol.rst new file mode 100644 index 00000000..2d509921 --- /dev/null +++ b/docs/clamp/controlloop/api-protocol/api-protocol.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop-api-protocol: + +CLAMP TOSCA Control Loop APIs and Protocols +########################################### + +The sections below describe the APIs and Protocols used in TOSCA Control Loops. + +.. toctree:: + :maxdepth: 1 + + system-level-dialogues + controlloop-participant-protocol + controlloop-rest-apis diff --git a/docs/clamp/controlloop/api-protocol/controlloop-participant-protocol.rst b/docs/clamp/controlloop/api-protocol/controlloop-participant-protocol.rst new file mode 100644 index 00000000..2fa5336f --- /dev/null +++ b/docs/clamp/controlloop/api-protocol/controlloop-participant-protocol.rst @@ -0,0 +1,472 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _controlloop-participant-protocol-label: + +The CLAMP Control Loop Participant Protocol +########################################### + +The CLAMP Control Loop Participant protocol is an asynchronous protocol that is used by the +CLAMP runtime to coordinate life cycle management of Control Loop instances. The protocol +supports the functions described in the sections below. + + +Protocol Dialogues +================== + +The protocol supports the dialogues described below. + +Participant Registration and De-Registration +-------------------------------------------- + +Registration when a participant comes up and update of participant with control loop type +information and common parameter values for its control loop types. + +.. image:: ../images/clamp-cl-participants/participant-registering.png + + +De-registration is executed as a participant goes down. + +.. image:: ../images/clamp-cl-participants/participant-deregistration.png + + +Control Loop Priming and De-Priming +----------------------------------- + +When a control loop is primed, the portion of the Control Loop Type Definition and Common +Property values for the participants of each participant type mentioned in the Control Loop +Definition are sent to the participants. + +.. image:: ../images/clamp-cl-participants/controlloop-priming.png + +When a control loop is de-primed, the portion of the Control Loop Type Definition and Common +Property values for the participants of each participant type mentioned in the Control Loop +Definition are deleted on participants. + +.. image:: ../images/clamp-cl-participants/controlloop-depriming.png + + +Control Loop Update +------------------- + +Control Loop Update handles creation, change, and deletion of control loops on participants. +Change of control loops uses a semantic versioning approach and follow the semantics described +on the page `4.1 Management of Control Loop Instance Configurations `. + +.. image:: ../images/clamp-cl-participants/controlloop-update.png + +The handling of a ControlLoopUpdate message in each participant is as shown below. + +.. image:: ../images/clamp-cl-participants/controlloop-update-msg.png + +Control Loop State Change +------------------------- + +This dialogue is used to change the state of Control Loops and their Control Loop Elements. The +CLAMP Runtime sends a Control Loop State Change message on the control loop to all participants. +Participants that have Control Loop Elements in that Control Loop attempt an update on the state +of the control loop elements they have for that control loop, and report the result back. + +The *startPhase* in the `Definition of TOSCA fundamental Control Loop Types +`_ +is particularly important in control loop state changes because sometime the user wishes to control +the order in which the state changes in Control Loop Elements in a control loop. In state changes +from *UNITITIALISED* → *PASSIVE* and from *PASSIVE* → *RUNNING*, control loop elements are started in +increasing order of their *startPhase*. In state changes from *RUNNING* → *PASSIVE* and from *PASSIVE* +→ *UNITITIALISED*, control loop elements are started in decreasing order of their *startPhase*. + +The CLAMP runtime controls the state change process described in the diagram below. The CLAMP runtime +sends a Control Loop State Change message on DMaaP to all participants in a particular Start Phase so, +in each state change multiple Control Loop State Change messages are sent, one for each Start Phase in +the control loop. If more than one Control Loop Element has the same Start Phase, those Control Loop +Elements receive the same Control Loop State Change message from DMaaP and start in parallel. + +The Participant reads each State Change Message it sees on DMaaP. If the Start Phase on the Control +Loop State Change message matches the Start Phase of the Control Loop Element, the participant processes +the State Change message. Otherwise the participant ignores the message. + +.. image:: ../images/clamp-cl-participants/controlloop-state-change.png + +The handling of a ControlLoopStateChange message in each participant is as shown below. + +.. image:: ../images/clamp-cl-participants/controlloop-state-change-msg.png + +Control Loop Monitoring and Reporting +------------------------------------- + +This dialogue is used as a heartbeat mechanism for participants, to monitor the status of Control Loop +Elements, and to gather statistics on control loops. The ParticipantStatus message is sent periodically +by each participant. The reporting interval for sending the message is configurable. + +.. image:: ../images/clamp-cl-participants/controlloop-monitoring.png + + +Messages +======== + +The CLAMP Control Loop Participant Protocol uses the following messages. The descriptions below give +an overview of each message. For the precise definition of the messages, see the `CLAMP code at Github +`_ +. All messages are carried on DMaaP. + + +.. list-table:: + :widths: 15 10 10 15 15 35 + :header-rows: 1 + + * - Message + - Source + - Target + - Purpose + - Important Fields + - Field Descriptions + * - ParticipantRegister + - Participant + - CLAMP Runtime + - Participant registers with the CLAMP runtime + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - ParticipantRegisterAck + - CLAMP Runtime + - Participant + - Acknowledgement of Participant Registration + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ParticipantUpdate + - CLAMP Runtime + - Participant + - CLAMP Runtime sends Control Loop Element Definitions and Common Parameter Values to Participants + - ParticipantDefinitionUpdateMap + - Map with Participant ID as its key, each value on the map is a ControlLoopElementDefintionMap + * - + - + - + - + - ControlLoopElementDefintionMap + - List of ControlLoopElementDefinition values for a particular participant, keyed by its Control + Loop Element Definition ID + * - + - + - + - + - ControlLoopElementDefinition + - A ControlLoopElementToscaServiceTemplate containing the definition of the Control Loop Element + and a CommonPropertiesMap with the values of the common property values for Control Loop Elements + of this type + * - + - + - + - + - ControlLoopElementToscaServiceTemplate + - The definition of the Control Loop Element in TOSCA + * - + - + - + - + - CommonPropertiesMap + - A map indexed by the property name. Each map entry is the serialized value of + the property, which can be deserialized into an instance of the type of the property. + * - ParticipantUpdateAck + - Participant + - CLAMP Runtime + - Acknowledgement of Participant Update + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ParticipantDeregister + - Participant + - CLAMP Runtime + - Participant deregisters with the CLAMP runtime + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - ParticipantDeregisterAck + - CLAMP Runtime + - Participant + - Acknowledgement of Participant Deegistration + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ControlLoopUpdate + - CLAMP Runtime + - Participant + - CLAMP Runtime sends Control Loop Element instances and Instance Specific Parameter Values for + a Control Loop Instance to Participants + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - ParticipantUpdateMap + - Map with Participant ID as its key, each value on the map is a ControlLoopElementList + * - + - + - + - + - ControlLoopElementList + - List of ControlLoopElement values for the Control Loop + * - + - + - + - + - ControlLoopElement + - A ControlLoopElement, which contains among other things a PropertiesMap with the values of the + property values for this Control Loop Element instance and a ToscaServiceTemplateFragment with + extra concept definitions and instances that a participant may need. + * - + - + - + - + - PropertiesMap + - A map indexed by the property name. Each map entry is the serialized value of + the property, which can be deserialized into an instance of the type of the property. + * - + - + - + - + - ToscaServiceTemplateFragment + - A well-formed TOSCA service template containing extra concept definitions and instances that a + participant may need. For example, the Policy Participant may need policy type definitions or + policy instances to be provided if they are not already stored in the Policy Framework. + * - ControlLoopUpdateAck + - Participant + - CLAMP Runtime + - Acknowledgement of Control Loop Update + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - ControlLoopResult + - Holds a Result and Message for the overall operation on the participant and a map of Result + and Message fields for each Control Loop Element of the control loop on this participant + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ControlLoopStateChange + - CLAMP Runtime + - Participant + - CLAMP Runtime asks Participants to change the state of a Control Loop + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - currentState + - The current state of the Control Loop + * - + - + - + - + - orderedState + - The state that the Control Loop should transition to + * - + - + - + - + - startPhase + - The start phase to which this ControLoopStateChange message applies + * - ControlLoopStateChangeAck + - Participant + - CLAMP Runtime + - Acknowledgement of Control Loop State Change + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - startPhase + - The start phase to which this ControLoopStateChangeAck message applies + * - + - + - + - + - ControlLoopResult + - Holds a Result and Message for the overall operation on the participant and a map of Result and + Message fields for each Control Loop Element of the control loop on this participant + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ParticipantStatusReq + - CLAMP Runtime + - Participant + - Request that the specified participants return a ParticipantStatus message immediately + - ParticipantId + - The ID of this participant, if not specified, all participants respond. + * - ParticipantStatus + - Participant + - CLAMP Runtime + - Periodic or on-demand report for heartbeat, Participant Status, Control Loop Status, and Control + Loop Statistics + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop + Type Definitions + * - + - + - + - + - ParticipantDefinitionUpdateMap (returned in repsonse to ParticipantStatusReq only) + - See ParticipantUpdate message above for definition of this field + * - + - + - + - + - ParticipantStatus + - The current status of the participant for monitoring + * - + - + - + - + - ParticipantStatistics + - Statistics on the participant such as up time, or messages processed. Can include participant + specific data in a string blob that is opaque to CLAMP + * - + - + - + - + - ControlLoopInfoMap + - A map of ControlLoopInfo types indexed by ControlLoopId, one entry for each control loop + running on the participant + * - + - + - + - + - ControlLoopInfo + - The ControlLoopStatus and ControlLoopStatistics for a given control loop + * - + - + - + - + - ControlLoopStatus + - The current status of the control loop for monitoring + * - + - + - + - + - ControlLoopStatistics + - Statistics on the control loop such as up time, or messages processed. Can include participant + specific data in a string blob that is opaque to CLAMP + + +End of Document diff --git a/docs/clamp/controlloop/api-protocol/controlloop-rest-apis.rst b/docs/clamp/controlloop/api-protocol/controlloop-rest-apis.rst new file mode 100644 index 00000000..cef2c2fb --- /dev/null +++ b/docs/clamp/controlloop/api-protocol/controlloop-rest-apis.rst @@ -0,0 +1,130 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _controlloop-rest-apis-label: + +REST APIs for CLAMP Control Loops +################################# + + +Commissioning API +================= + +This API is a CRUD API that allows Control Loop Type definitions created in a design +environment to be commissioned on the CLAMP runtime. It has endpoints that allow Control +Loop Types to be created, read, updated, and deleted. + +The body of the create and update end points is a TOSCA Service/Topology template that +defines the new or changed Control Loop Type. The update and delete endpoints take a +reference to the Control Loop Type. The incoming TOSCA is verified and checked for +referential integrity. On delete requests, a check is made to ensure that no Control +Loop Instances exist for the Control Loop Type to be deleted. + +:download:`Download Policy Control Loop Commissioning API Swagger ` + +.. swaggerv2doc:: swagger/controlloop-comissioning.json + + +Instantiation API +================= + +The instantiation API has two functions: + +#. Creation, Reading, Update, and Deletion of Control Loop Instances. +#. Instantiation and lifecycle management of Control Loop Instances on participants + +The Instantiation API is used by the CLAMP GUI. + +Instantiation Control Loop Instance CRUD +---------------------------------------- + +This sub API allows for the creation, read, update, and deletion of Control Loop Instances. +The endpoints for create and update take a JSON body that describes the Control Loop Instance. +The endpoints for read and delete take a Control Loop Instance ID to determine which Control +Loop Instance to act on. For the delete endpoint, a check is made to ensure that the Control +Loop Instance is not instantiated on participants. + +A call to the update endpoint for a Control Loop Instance follow the semantics described here: +`4.1 Management of Control Loop Instance Configurations `. + +:download:`Download Policy Control Loop Instantiation API Swagger ` + +.. swaggerv2doc:: swagger/controlloop-instantiation.json + + +Instantiation Control Loop Instance Lifecycle Management +-------------------------------------------------------- + +This sub API is used to manage the life cycle of Control Loop Instances. A Control Loop Instance +can be in the states described here: `2.1 Control Loop Instance States `. +Managing the life cycle of a Control Loop Instance amounts to steering the Control Loop through +its states. + +The sub API allows upgrades and downgrades of Control Loop Instances to be pushed to participants +following the semantics described here: `4.1 Management of Control Loop Instance Configurations +`. When the API is used to update the participants on a Control +Loop Instance, the new/upgraded/downgraded definition of the Control Loop is pushed to the +participants. Note that the API asks the participants in a Control Loop Instance to perform the +update, it is the responsibility of the participants to execute the update and report the result +using the protocols described here: `CLAMP Participants <#>`_. The progress and result of an update +can be monitored using the `Monitoring API `. + +The sub API also allows a state change of a Control Loop Instance to be ordered. The required state +of the Control Loop Instance is pushed to participants in a Control Loop Instance using the API. +Note that the API asks the participants in a Control Loop Instance to perform the state change, it +is the responsibility of the participants to execute the state change and report the result using +the protocols described here: CLAMP Participants. The progress and result of a state change can be +monitored using the `Monitoring API `. + +.. warning:: + The Swagger for the Instantiation Lifecycle Management API will appear here. + +.. _monitoring-api: + +Monitoring API +============== + +The Monitoring API allows the state and statistics of Participants, Control Loop Instances and their Control Loop Elements to be monitored. This API is used by the CLAMP GUI. The API provides filtering so that specific Participants and Control Loop Instances can be retrieved. In addition, the quantity of statistical information to be returned can be scoped. + +:download:`Download Policy Control Loop Monitoring API Swagger ` + +.. swaggerv2doc:: swagger/controlloop-monitoring.json + +Pass Through API +================ + +This API allows information to be passed to Control Loop Elements in a control loop. + +.. warning:: + The requirements on this API are still under discussion. + +.. warning:: + The Swagger for the Pass Through API will appear here. + + +Participant Standalone API +========================== + +This API allows a Participant to run in standalone mode and to run standalone Control Loop Elements. + +Kubernetes participant can also be deployed as a standalone application and provides REST end points +for onboarding helm charts to its local chart storage, installing and uninstalling of helm charts to +a kubernetes cluster. It also allows to configure a remote repository in kubernetes participant for +installing helm charts. User can onboard a helm chart along with the overrides yaml file, the chart +gets stored in to the local chart directory of kubernetes participant. The onboarded charts can be +installed, uninstalled. The GET API fetches all the available helm charts from the chart storage. + +:download:`Download Policy Control Loop Participant Standalone API Swagger ` + +.. swaggerv2doc:: swagger/k8sparticipant.json + + +Participant Simulator API +========================= + +This API allows a Participant Simulator to be started and run for test purposes. + +:download:`Download Policy Participant Simulator API Swagger ` + +.. swaggerv2doc:: swagger/participant-sim.json + +End of Document diff --git a/docs/clamp/controlloop/api-protocol/swagger/controlloop-comissioning.json b/docs/clamp/controlloop/api-protocol/swagger/controlloop-comissioning.json new file mode 100644 index 00000000..8fa09368 --- /dev/null +++ b/docs/clamp/controlloop/api-protocol/swagger/controlloop-comissioning.json @@ -0,0 +1,473 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/controlloop/v2/commission": { + "get": { + "tags": [ + "Clamp Control Loop Commissioning API" + ], + "summary": "Query details of the requested commissioned control loop definitions", + "description": "Queries details of the requested commissioned control loop definitions, returning all control loop details", + "operationId": "queryUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ToscaNodeTemplateRes", + "originalRef": "ToscaNodeTemplateRes" + } + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "post": { + "tags": [ + "Clamp Control Loop Commissioning API" + ], + "summary": "Commissions control loop definitions", + "description": "Commissions control loop definitions, returning the commissioned control loop definition IDs", + "operationId": "createUsingPOST", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Entity Body of Control Loop", + "required": true, + "schema": { + "$ref": "#/definitions/ToscaServiceTemplateReq", + "originalRef": "ToscaServiceTemplateReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommissioningResponse", + "originalRef": "CommissioningResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "delete": { + "tags": [ + "Clamp Control Loop Commissioning API" + ], + "summary": "Delete a commissioned control loop", + "description": "Deletes a Commissioned Control Loop, returning optional error details", + "operationId": "deleteUsingDELETE", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommissioningResponse", + "originalRef": "CommissioningResponse" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/commission/elements": { + "get": { + "tags": [ + "Clamp Control Loop Commissioning API" + ], + "summary": "Query details of the requested commissioned control loop element definitions", + "description": "Queries details of the requested commissioned control loop element definitions, returning all control loop elements' details", + "operationId": "queryElementsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ToscaNodeTemplateRes", + "originalRef": "ToscaNodeTemplateRes" + } + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + } + } +} \ No newline at end of file diff --git a/docs/clamp/controlloop/api-protocol/swagger/controlloop-instantiation.json b/docs/clamp/controlloop/api-protocol/swagger/controlloop-instantiation.json new file mode 100644 index 00000000..12542425 --- /dev/null +++ b/docs/clamp/controlloop/api-protocol/swagger/controlloop-instantiation.json @@ -0,0 +1,584 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/controlloop/v2/instantiation": { + "get": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Query details of the requested control loops", + "description": "Queries details of the requested control loops, returning all control loop details", + "operationId": "queryUsingGET_1", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ControlLoopsRes", + "originalRef": "ControlLoopsRes" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "post": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Commissions control loop definitions", + "description": "Commissions control loop definitions, returning the control loop IDs", + "operationId": "createUsingPOST_1", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "controlLoops", + "description": "Entity Body of Control Loop", + "required": true, + "schema": { + "$ref": "#/definitions/ControlLoopsReq", + "originalRef": "ControlLoopsReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InstantiationResponse", + "originalRef": "InstantiationResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "put": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Updates control loop definitions", + "description": "Updates control loop definitions, returning the updated control loop definition IDs", + "operationId": "updateUsingPUT", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "controlLoops", + "description": "Entity Body of Control Loop", + "required": true, + "schema": { + "$ref": "#/definitions/ControlLoopsReq", + "originalRef": "ControlLoopsReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InstantiationResponse", + "originalRef": "InstantiationResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "delete": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Delete a control loop", + "description": "Deletes a control loop, returning optional error details", + "operationId": "deleteUsingDELETE_1", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InstantiationResponse", + "originalRef": "InstantiationResponse" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/instantiation/command": { + "put": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Issue a command to the requested control loops", + "description": "Issues a command to a control loop, ordering a state change on the control loop", + "operationId": "issueControlLoopCommandUsingPUT", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "command", + "description": "Entity Body of control loop command", + "required": true, + "schema": { + "$ref": "#/definitions/InstantiationCommand", + "originalRef": "InstantiationCommand" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InstantiationResponse", + "originalRef": "InstantiationResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + } + } +} \ No newline at end of file diff --git a/docs/clamp/controlloop/api-protocol/swagger/controlloop-monitoring.json b/docs/clamp/controlloop/api-protocol/swagger/controlloop-monitoring.json new file mode 100644 index 00000000..84fbe7f0 --- /dev/null +++ b/docs/clamp/controlloop/api-protocol/swagger/controlloop-monitoring.json @@ -0,0 +1,521 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/controlloop/v2/monitoring/clelement": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of the requested cl element stats", + "description": "Queries details of the requested cl element stats, returning all clElement stats", + "operationId": "queryElementStatisticsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "endTime", + "in": "query", + "description": "end time", + "required": false, + "type": "string" + }, + { + "name": "id", + "in": "query", + "description": "Control Loop element id", + "required": false, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "Participant name", + "required": true, + "type": "string" + }, + { + "name": "recordCount", + "in": "query", + "description": "Record count", + "required": false, + "type": "integer", + "default": 0, + "format": "int32" + }, + { + "name": "startTime", + "in": "query", + "description": "start time", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Participant version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClElementStatisticsList", + "originalRef": "ClElementStatisticsList" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/monitoring/clelements/controlloop": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of the requested cl element stats in a control loop", + "description": "Queries details of the requested cl element stats, returning all clElement stats", + "operationId": "queryElementStatisticsPerControlLoopUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClElementStatisticsList", + "originalRef": "ClElementStatisticsList" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/monitoring/participant": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of the requested participant stats", + "description": "Queries details of the requested participant stats, returning all participant stats", + "operationId": "queryParticipantStatisticsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "endTime", + "in": "query", + "description": "end time", + "required": false, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "Control Loop participant name", + "required": false, + "type": "string" + }, + { + "name": "recordCount", + "in": "query", + "description": "Record count", + "required": false, + "type": "integer", + "default": 0, + "format": "int32" + }, + { + "name": "startTime", + "in": "query", + "description": "start time", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop participant version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ParticipantStatisticsList", + "originalRef": "ParticipantStatisticsList" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/monitoring/participants/controlloop": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of all the participant stats in a control loop", + "description": "Queries details of the participant stats, returning all participant stats", + "operationId": "queryParticipantStatisticsPerControlLoopUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ParticipantStatisticsList", + "originalRef": "ParticipantStatisticsList" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + } + } +} \ No newline at end of file diff --git a/docs/clamp/controlloop/api-protocol/swagger/k8sparticipant.json b/docs/clamp/controlloop/api-protocol/swagger/k8sparticipant.json new file mode 100644 index 00000000..ae06b06d --- /dev/null +++ b/docs/clamp/controlloop/api-protocol/swagger/k8sparticipant.json @@ -0,0 +1,392 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/k8sparticipant/helm/chart/{name}/{version}": { + "delete": { + "tags": [ + "k8s-participant" + ], + "summary": "Delete the chart", + "operationId": "deleteChartUsingDELETE", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "204": { + "description": "Chart Deleted" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/onap/k8sparticipant/helm/charts": { + "get": { + "tags": [ + "k8s-participant" + ], + "summary": "Return all Charts", + "operationId": "getAllChartsUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "chart List", + "schema": { + "$ref": "#/definitions/ChartList", + "originalRef": "ChartList" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/install": { + "post": { + "tags": [ + "k8s-participant" + ], + "summary": "Install the chart", + "operationId": "installChartUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "info", + "description": "info", + "required": true, + "schema": { + "$ref": "#/definitions/InstallationInfo", + "originalRef": "InstallationInfo" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "201": { + "description": "chart Installed", + "schema": { + "type": "object" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/onboard/chart": { + "post": { + "tags": [ + "k8s-participant" + ], + "summary": "Onboard the Chart", + "operationId": "onboardChartUsingPOST", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "chart", + "in": "formData", + "required": false, + "type": "file" + }, + { + "name": "info", + "in": "formData", + "required": false, + "type": "string" + }, + { + "in": "body", + "name": "values", + "description": "values", + "required": false, + "schema": { + "type": "string", + "format": "binary" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Chart Onboarded", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/repo": { + "post": { + "tags": [ + "k8s-participant" + ], + "summary": "Configure helm repository", + "operationId": "configureRepoUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "repo", + "description": "repo", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "201": { + "description": "Repository added", + "schema": { + "type": "object" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/uninstall/{name}/{version}": { + "delete": { + "tags": [ + "k8s-participant" + ], + "summary": "Uninstall the Chart", + "operationId": "uninstallChartUsingDELETE", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "201": { + "description": "chart Uninstalled", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + } + } + }, + "definitions": { + "ChartInfo": { + "type": "object", + "properties": { + "chartId": { + "$ref": "#/definitions/ToscaConceptIdentifier", + "originalRef": "ToscaConceptIdentifier" + }, + "namespace": { + "type": "string" + }, + "overrideParams": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "releaseName": { + "type": "string" + }, + "repository": { + "$ref": "#/definitions/HelmRepository", + "originalRef": "HelmRepository" + } + }, + "title": "ChartInfo" + }, + "ChartList": { + "type": "object", + "properties": { + "charts": { + "type": "array", + "items": { + "$ref": "#/definitions/ChartInfo", + "originalRef": "ChartInfo" + } + } + }, + "title": "ChartList" + }, + "HelmRepository": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "password": { + "type": "string" + }, + "port": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "repoName": { + "type": "string" + }, + "userName": { + "type": "string" + } + }, + "title": "HelmRepository" + }, + "InstallationInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "title": "InstallationInfo" + }, + "ToscaConceptIdentifier": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "title": "ToscaConceptIdentifier" + } + } +} \ No newline at end of file diff --git a/docs/clamp/controlloop/api-protocol/swagger/participant-sim.json b/docs/clamp/controlloop/api-protocol/swagger/participant-sim.json new file mode 100644 index 00000000..79fc3011 --- /dev/null +++ b/docs/clamp/controlloop/api-protocol/swagger/participant-sim.json @@ -0,0 +1,478 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/participantsim/v2/elements": { + "put": { + "tags": [ + "Clamp Control Loop Participant Simulator API" + ], + "summary": "Updates simulated control loop elements", + "description": "Updates simulated control loop elements, returning the updated control loop definition IDs", + "operationId": "updateUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Body of a control loop element", + "required": true, + "schema": { + "$ref": "#/definitions/ControlLoopElementReq", + "originalRef": "ControlLoopElementReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TypedSimpleResponse«ControlLoopElement»", + "originalRef": "TypedSimpleResponse«ControlLoopElement»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/elements/{name}/{version}": { + "get": { + "tags": [ + "Clamp Control Loop Participant Simulator API" + ], + "summary": "Query details of the requested simulated control loop elements", + "description": "Queries details of the requested simulated control loop elements, returning all control loop element details", + "operationId": "elementsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Control loop element name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Control loop element version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ControlLoopElementRes", + "originalRef": "ControlLoopElementRes" + } + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/participants": { + "put": { + "tags": [ + "Clamp Control Loop Participant Simulator API" + ], + "summary": "Updates simulated participants", + "description": "Updates simulated participants, returning the updated control loop definition IDs", + "operationId": "updateUsingPUT_1", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Body of a participant", + "required": true, + "schema": { + "$ref": "#/definitions/ParticipantReq", + "originalRef": "ParticipantReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TypedSimpleResponse«Participant»", + "originalRef": "TypedSimpleResponse«Participant»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/participants/{name}/{version}": { + "get": { + "tags": [ + "Clamp Control Loop Participant Simulator API" + ], + "summary": "Query details of the requested simulated participants", + "description": "Queries details of the requested simulated participants, returning all participant details", + "operationId": "participantsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Participant name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Participant version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ParticipantRes", + "originalRef": "ParticipantRes" + } + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + } + } +} \ No newline at end of file diff --git a/docs/clamp/controlloop/api-protocol/system-level-dialogues.rst b/docs/clamp/controlloop/api-protocol/system-level-dialogues.rst new file mode 100644 index 00000000..676ffc9b --- /dev/null +++ b/docs/clamp/controlloop/api-protocol/system-level-dialogues.rst @@ -0,0 +1,198 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _system-level-label: + +System Level Dialogues +###################### + + +.. contents:: + :depth: 4 + + +The CLAMP Control Loop Runtime Lifecycle Management uses the following system level dialogues. +These dialogues enable the CLAMP runtime capabilities described in :ref:`Section 2 of +TOSCA Defined Control Loops: Architecture and Design `. +Design Time dialogues will be described in future releases of the system. + + +1 Commissioning Dialogues +========================= + +Commissioning dialogues are used to commission and decommission Control Loop Type definitions +and to set the values of Common Parameters. + +Commissioning a Control Loop Type is a three-step process: + +#. The Control Loop Type must be created, that is the Control Loop Type definition must be + loaded and stored in the database. This step may be carried out over the REST interface or + using SDC distribution. + +#. The Common Properties of the Control Loop type must be assigned values and those values + must be stored in the database. This step is optional only if all mandatory common properties + have default values. The Common Property values may be set and amended over and over again + in multiple sessions until the Control Loop Type is primed. + +#. The Control Loop Type Definition and the Common Property values must be primed, that is + sent to the concerned participants. Once a Control Loop Type is primed, its Common Property + values can no longer be changed. To change Common Properties on a primed Control Loop Type, + all instances of the Control Loop Type must be removed and the Control Loop Type must be + de-primed. + +1.1 Commissioning a Control Loop Type Definition using the CLAMP GUI +-------------------------------------------------------------------- + +This dialogue corresponds to a "File → Import" menu on the CLAMP GUI. The documentation of +future releases of the system will describe how the Design Time functionality interacts +with the Runtime commissioning API. + +.. image:: ../images/system-dialogues/comissioning-clamp-gui.png + +1.2 Commissioning a Control Loop Type Definition using SDC +---------------------------------------------------------- + +.. image:: ../images/system-dialogues/comissioning-sdc.png + +1.3 Setting Common Properties for a Control Loop Type Definition +---------------------------------------------------------------- + +This dialogue sets the values of common properties. The values of the common properties +may be set, updated, or deleted at will, as this dialogue saves the properties to the +database but does not send the definitions or properties to the participants. However, +once a Control Loop Type Definition and its properties are primed +(See :ref:`Section 1.4 `), the properties cannot be changed until the control loop type +definition is de-primed (See :ref:`Section 1.5 `). + +.. image:: ../images/system-dialogues/common-properties-type-definition.png + +.. _priming-cl-label: + +1.4 Priming a Control Loop Type Definition on Participants +---------------------------------------------------------- +The Priming operation sends Control Loop Type definitions and common property values +to participants. Once a Control Loop Type definition is primed, its property values +can on longer be changed until it is de-primed. + +.. image:: ../images/system-dialogues/priming-cl-type-definition.png + +.. _depriming-cl-label: + +1.5 De-Prime a Control Loop Type Definition on Participants +----------------------------------------------------------- + +This dialogue allows a Control Loop Type Definition to be de-primed so that it can be +deleted or its common parameter values can be altered. + +.. image:: ../images/system-dialogues/depriming-cl-type-definition.png + +1.6 Decommissioning a Control Loop Type Definition in CLAMP +----------------------------------------------------------- + +.. image:: ../images/system-dialogues/decommission-cl-type-definition.png + +1.7 Reading Commissioned Control Loop Type Definitions +------------------------------------------------------ + +.. image:: ../images/system-dialogues/read-commision-cl-type-definition.png + + +2. Instantiation Dialogues +========================== + +Instantiation dialogues are used to create, set parameters on, instantiate, update, +and remove Control Loop instances. + +Assume a suitable Control Loop Definition exists in the Commissioned Control Loop Inventory. +To get a Control Loop instance running one would, for example, execute dialogues +:ref:`2.1 `, :ref:`2.3 `, and +:ref:`2.4 `. + +.. _creating-cl-instance: + +2.1 Creating a Control Loop Instance +------------------------------------ + +.. image:: ../images/system-dialogues/create-cl-instance.png + +.. note:: + This dialogue creates the Control Loop Instance in the Instantiated Control Loop Inventory. + The instance is sent to the participants using the process described in the dialogue in + :ref:`Section 2.3 `. + +2.2 Updating Instance Specific Parameters on a Control Loop Instance +-------------------------------------------------------------------- + +.. image:: ../images/system-dialogues/update-instance-params-cl.png + +.. _updating-cl-instance-config: + +2.3 Updating a Control Loop Instance with a Configuration on Participants +------------------------------------------------------------------------- + +.. image:: ../images/system-dialogues/update-cl-instance-config-participants.png + +.. _changing-cl-instance-state: + +2.4 Changing the state of a Control Loop Instance on Participants +----------------------------------------------------------------- + +.. image:: ../images/system-dialogues/change-cl-instance-state-participants.png + +2.5 De-instantiating a Control Loop Instance from Participants +-------------------------------------------------------------- + +.. image:: ../images/system-dialogues/deinstantiate-cl-from-participants.png + +2.6 Deleting a Control Loop Instance +------------------------------------ + +.. image:: ../images/system-dialogues/delete-cl-instance.png + +2.7 Reading Control Loop Instances +---------------------------------- + +.. image:: ../images/system-dialogues/read-cl-instance.png + + +1. Monitoring Dialogues +======================= + +Monitoring dialogues are used to monitor and to read statistics on Control Loop Instances. + +3.1 Reporting of Monitoring Information and Statistics by Participants +---------------------------------------------------------------------- + +.. image:: ../images/system-dialogues/monitoring-by-participants.png + +3.2 Viewing of Monitoring Information +------------------------------------- + +.. image:: ../images/system-dialogues/view-monitoring-info.png + +3.2 Viewing of Statistics +------------------------- + +.. image:: ../images/system-dialogues/view-statistics.png + +3.3 Statistics Housekeeping +--------------------------- + +.. image:: ../images/system-dialogues/statistics-housekeeping.png + + +4. Supervision Dialogues +======================== + +Supervision dialogues are used to check the state of Control Loop Instances and Participants. + +4.1 Supervise Participants +-------------------------- + +.. image:: ../images/system-dialogues/supervise-participants.png + +4.2 Supervise Control Loops +--------------------------- + +.. image:: ../images/system-dialogues/supervise-controlloops.png + +End of Document diff --git a/docs/clamp/controlloop/controlloop-architecture.rst b/docs/clamp/controlloop/controlloop-architecture.rst new file mode 100644 index 00000000..c5977ee4 --- /dev/null +++ b/docs/clamp/controlloop/controlloop-architecture.rst @@ -0,0 +1,468 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop_architecture-label: + +TOSCA Defined Control Loops: Architecture and Design +#################################################### + + +.. contents:: + :depth: 4 + +The idea of using control loops to automatically (or autonomously) perform network management +has been the subject of much research in the Network Management research community, see +:download:`this paper ` for some background. However, it is only with +the advent of ONAP that we have a platform that supports control loops for network management. +Before ONAP, Control Loops have been implemented by hard-coding components together and hard +coding logic into components. ONAP has taken a step forward towards automatic implementation +of Control Loops by allowing parameterization of Control Loops that work on the premise that +the Control Loops use a set of analytic, policy, and control components connected together in +set ways. + +The goal of the work is to extend and enhance the current ONAP Control Loop support to provide +a complete open-source framework for Control Loops. This will enhance the current support to +provide TOSCA based Control Loop definition and development, commissioning and run-time management. +The participants that comprise a Control Loop and the metadata needed to link the participants +together to create a Control Loop are specified in a standardized way using the `OASIS TOSCA +modelling language `_. The TOSCA +description is then used to commission, instantiate, and manage the Control Loops in the run +time system. + +.. image:: images/01-controlloop-overview.png + +1 Terminology +============= + +This section describes the terminology used in the system. + +1.1 Control Loop Terminology +---------------------------- + +**Control Loop Type:** A definition of a Control Loop in the TOSCA language. This definition describes +a certain type of a control loop. The life cycle of instances of a Control Loop Type are managed +by CLAMP. + +**Control Loop Instance:** An instance of a Control Loop Type. The life cycle of a Control Loop +Instance is managed by CLAMP. A Control Loop Instance is a set of executing elements on which +Life Cycle Management (LCM) is executed collectively. For example, a set of microservices may be +spawned and executed together to deliver a service. This collection of services is a control loop. + +**Control Loop Element Type:** A definition of a Control Loop Element in the TOSCA language. This +definition describes a certain type of Control Loop Element for a control loop in a Control +Loop Type. + +**Control Loop Element Instance:** A single entity executing on a participant, with its Life Cycle +being managed as part of the overall control loop. For example, a single microservice that is +executing as one microservice in a service. + +**CLAMP Control Loop Runtime:** The CLAMP server that holds Control Loop Type definitions and manages +the life cycle of Control Loop Instances and their Control Loop Elements in cooperation with +participants. + + +1.2 Participant Terminology +--------------------------- + +**Participant Type:** Definition of a type of system or framework that can take part in control +loops and a definition of the capabilities of that participant type. A participant advertises +its type to the CLAMP Control Loop Runtime. + +**Participant:** A system or framework that takes part in control loops by executing Control Loop +Elements in cooperation with the CLAMP Control Loop Runtime. A participant chooses to partake +in control loops, to manage Control Loop Elements for CLAMP, and to receive, send and act on +LCM messages for the CLAMP runtime. + +1.3 Terminology for Properties +------------------------------ + +**Common Properties:** Properties that apply to all Control Loop Instances of a certain Control +Loop Type and are specified when a Control Loop Type is commissioned. + +**Instance Specific Properties:** Properties that must be specified for each Control Loop Instance +and are specified when a Control Loop Instance is Initialized. + +1.4 Concepts and their relationships +------------------------------------ + +The UML diagram below shows the concepts described in the terminology sections above and how +they are interrelated. + +.. image:: images/02-controlloop-concepts.png + +The Control Loop Definition concepts describe the types of things that are in the system. These +concepts are defined at design time and are passed to the runtime in a TOSCA document. The +concepts in the Control Loop Runtime are created by the runtime part of the system using the +definitions created at design time. + +.. _controlloop-capabilities: + +2 Capabilities +============== + +We consider the capabilities of Control Loops at Design Time and Run Time. + +At Design Time, three capabilities are supported: + +#. **Control Loop Element Definition Specification.** This capability allows users to define Control + Loop Element Types and the metadata that can be used on and configured on a Control Loop Element + Type. Users also define the Participant Type that will run the Control Loop Element when it is + taking part in in a control loop. The post condition of an execution of this capability is that + metadata for a Control Loop Element Type is defined in the Control Loop Design Time Catalogue. + +#. **Control Loop Element Definition Onboarding.** This capability allows external users and systems + (such as SDC or DCAE-MOD) to define the metadata that can be used on and configured on a Control + Loop Element Type and to define the Participant Type that will run the Control Loop Element when + it is taking part in in a control loop. The post condition of an execution of this capability + is that metadata for a Control Loop Element Type is defined in the Control Loop Design Time + Catalogue. + +#. **Control Loop Type Definition.** This capability allows users and other systems to create Control + Loop Type definitions by specifying a set of Control Loop Element Definitions from those that + are available in the Control Loop Design Time Catalogue. These Control Loop Elements will + work together to form Control Loops. In an execution of this capability, a user specifies the + metadata for the Control Loop and specifies the set of Control Loop Elements and their Participant + Types. The user also selects the correct metadata sets for each participant in the Control Loop + Type and defines the overall Control Loop Type metadata. The user also specifies the Common + Property Types that apply to all instances of a control loop type and the Instance Specific + Property Types that apply to individual instances of a Control Loop Type. The post condition for + an execution of this capability is a Control Loop definition in TOSCA stored in the Control Loop + Design Time Catalogue. + +.. note:: + Once a Control Loop Definition is commissioned to the Control Loop Runtime and has been + stored in the Run Time Inventory, it cannot be further edited unless it is decommissioned. + + +At Run Time, the following participant related capabilities are supported: + +#. **System Pre-Configuration.** This capability allows participants to register and deregister + with CLAMP. Participants explicitly register with CLAMP when they start. Control Loop Priming + is performed on each participant once it registers. The post condition for an execution of this + capability is that a participant becomes available (registration) or is no longer available + (deregistration) for participation in a control loop. + +#. **Control Loop Priming on Participants.** A participant is primed to support a Control Loop Type. + Priming a participant means that the definition of a control loop and the values of Common + Property Types that apply to all instances of a control loop type on a participant are sent + to a participant. The participant can then take whatever actions it need to do to support + the control loop type in question. Control Loop Priming takes place at participant + registration and at Control Loop Commissioning. The post condition for an execution of this + capability is that all participants in this control loop type are commissioned, that is they + are prepared to run instances of their Control Loop Element types. + + +At Run Time, the following Control Loop Life Cycle management capabilities are supported: + +#. **Control Loop Commissioning:** This capability allows version controlled Control Loop Type + definitions to be taken from the Control Loop Design Time Catalogue and be placed in the + Commissioned Control Loop Inventory. It also allows the values of Common Property Types + that apply to all instances of a Control Loop Type to be set. Further, the Control Loop + Type is primed on all concerned participants. The post condition for an execution of this + capability is that the Control Loop Type definition is in the Commissioned Control Loop + Inventory and the Control Loop Type is primed on concerned participants. + +#. **Control Loop Instance Life Cycle Management:** This capability allows a Control Loop + Instance to have its life cycle managed. + + #. **Control Loop Instance Creation:** This capability allows a Control Loop Instance to be + created. The Control Loop Type definition is read from the Commissioned Control Loop + Inventory and values are assigned to the Instance Specific Property Types defined for + instances of the Control Loop Type in the same manner as the existing CLAMP client does. + A Control Loop Instance that has been created but has not yet been instantiated on + participants is in state UNINITIALIZED. In this state, the Instance Specific Property Type + values can be revised and updated as often as the user requires. The post condition for an + execution of this capability is that the Control Loop instance is created in the + Instantiated Control Loop Inventory but has not been instantiated on Participants. + + #. **Control Loop Instance Update on Participants:** Once the user is happy with the property + values, the Control Loop Instance is updated on participants and the Control Loop Elements + for this Control Loop Instance are initialized or updated by participants using the control + loop metadata. The post condition for an execution of this capability is that the Control + Loop instance is updated on Participants. + + #. **Control Loop State Change:** The user can now order the participants to change the state + of the Control Loop Instance. If the Control Loop is set to state RUNNING, each participant + begins accepting and processing control loop events and the Control Loop Instance is set + to state RUNNING in the Instantiated Control Loop inventory. The post condition for an + execution of this capability is that the Control Loop instance state is changed on + participants. + + #. **Control Loop Instance Monitoring:** This capability allows Control Loop Instances to be + monitored. Users can check the status of Participants, Control Loop Instances, and Control + Loop Elements. Participants report their overall status and the status of Control Loop + Elements they are running periodically to CLAMP. Clamp aggregates these status reports + into an aggregated Control Loop Instance status record, which is available for monitoring. + The post condition for an execution of this capability is that Control Loop Instances are + being monitored. + + #. **Control Loop Instance Supervision:** This capability allows Control Loop Instances to be + supervised. The CLAMP runtime expects participants to report on Control Loop Elements + periodically. The CLAMP runtime checks that periodic reports are received and that each + Control Loop Element is in the state it should be in. If reports are missed or if a + Control Loop Element is in an incorrect state, remedial action is taken and notifications + are issued. The post condition for an execution of this capability is that Control Loop + Instances are being supervised by the CLAMP runtime. + + #. **Control Loop Instance Removal from Participants:** A user can order the removal of a Control + Loop Instance from participants. The post condition for an execution of this capability is + that the Control Loop instance is removed from Participants. + + #. **Control Loop Instance Deletion:** A user can order the removal of a Control Loop Instance + from the CLAMP runtime. Control Loop Instances that are instantiated on participants cannot + be removed from the CLAMP runtime. The post condition for an execution of this capability + is that the Control Loop instance is removed from Instantiated Control Loop Inventory. + +#. **Control Loop Decommissioning:** This capability allows version controlled Control Loop Type + definitions to be removed from the Commissioned Control Loop Inventory. A Control Loop + Definition that has instances in the Instantiated Control Loop Inventory cannot be removed. + The post condition for an execution of this capability is that the Control Loop Type + definition removed from the Commissioned Control Loop Inventory. + +.. note:: + The system dialogues for run time capabilities are described in detail on the + :ref:`System Level Dialogues ` page. + +.. _controlloop-instance-states: + +2.1 Control Loop Instance States +-------------------------------- + +When a control loop definition has been commissioned, instances of the control loop can be +created, updated, and deleted. The system manages the lifecycle of control loops and control +loop elements following the state transition diagram below. + +.. image:: images/03-controlloop-instance-states.png + +3 Overall Target Architecture +============================= + +The diagram below shows an overview of the architecture of TOSCA based Control Loop +Management in CLAMP. + +.. image:: images/04-overview.png + +Following the ONAP Reference Architecture, the architecture has a Design Time part and +a Runtime part. + +The Design Time part of the architecture allows a user to specify metadata for participants. +It also allows users to compose control loops. The Design Time Catalogue contains the metadata +primitives and control loop definition primitives for composition of control loops. As shown +in the figure above, the Design Time component provides a system where Control Loops can be +designed and defined in metadata. This means that a Control Loop can have any arbitrary +structure and the Control Loop developers can use whatever analytic, policy, or control +participants they like to implement their Control Loop. At composition time, the user +parameterises the Control Loop and stores it in the design time catalogue. This catalogue +contains the primitive metadata for any participants that can be used to compose a Control +Loop. A Control Loop SDK is used to compose a Control Loop by aggregating the metadata for +the participants chosen to be used in a Control Loop and by constructing the references between +the participants. The architecture of the Control Loop Design Time part will be elaborated in +future releases. + +Composed Control Loops are commissioned on the run time part of the system, where they are +stored in the Commissioned Control Loop inventory and are available for instantiation. The +Commissioning component provides a CRUD REST interface for Control Loop Types, and implements +CRUD of Control Loop Types. Commissioning also implements validation and persistence of incoming +Control Loop Types. It also guarantees the integrity of updates and deletions of Control Loop +Types, such as performing updates in accordance with semantic versioning rules and ensuring that +deletions are not allowed on Control Loop Types that have instances defined. + +The Instantiation component manages the Life Cycle Management of Control Loop Instances and +their Control Loop Elements. It publishes a REST interface that is used to create Control Loop +Instances and set values for Common and Instance Specific properties. This REST interface is +public and is used by the CLAMP GUI. It may also be used by any other client via the public +REST interface. the REST interface also allows the state of Control Loop Instances to be changed. +A user can change the state of Control Loop Instances as described in the state transition +diagram shown in section 2 above. The Instantiation component issues update and state change +messages via DMaaP to participants so that they can update and manage the state of the Control +Loop Elements they are responsible for. The Instantiation component also implements persistence +of Control Loop Instances, control loop elements, and their state changes. + +The Monitoring component reads updates sent by participants. Participants report on the +state of their Control Loop Elements periodically and in response to a message they have +received from the Instantiation component. The Monitoring component reads the contents of +the participant messages and persists their state updates and statistics records. It also +publishes a REST interface that publishes the current state of all Participants, Control +Loop Instances and their Control Loop Elements, as well as publishing Participant and +Control Loop statistics. + +The Supervision component is responsible for checking that Control Loop Instances are correctly +instantiated and are in the correct state (UNINITIALIZED/READY/RUNNING). It also handles +timeouts and on state changes to Control Loop Instances, and retries and rolls back state +changes where state changes failed. + +A Participant is an executing component that partakes in control loops. More explicitly, a +Participant is something that implements the Participant Instantiation and Participant +Monitoring messaging protocol over DMaaP for Life Cycle management of Control Loop Elements. +A Participant runs Control Loop Elements and manages and reports on their life cycle +following the instructions it gets from the CLAMP runtime in messages delivered over DMaaP. + +In the figure above, five participants are shown. A Configuration Persistence Participant +manages Control Loop Elements that interact with the `ONAP Configuration Persistence Service +`_ +to store common data. The DCAE Participant runs Control Loop Elements that manage DCAE +microservices. The Kubernetes Participant hosts the Control Loop Elements that are managing +the life cycle of microservices in control loops that are in a Kubernetes ecosystem. The +Policy Participant handles the Control Loop Elements that interact with the Policy Framework +to manage policies for control loops. A Controller Participant such as the CDS Participant +runs Control Loop Elements that load metadata and configure controllers so that they can +partake in control loops. Any third party Existing System Participant can be developed to +run Control Loop Elements that interact with any existing system (such as an operator's +analytic, machine learning, or artificial intelligence system) so that those systems can +partake in control loops. + +4. Other Considerations +======================= + +.. _management-cl-instance-configs: + +4.1 Management of Control Loop Instance Configurations +------------------------------------------------------ + +In order to keep management of versions of the configuration of control loop instances +straightforward and easy to implement, the following version management scheme using +semantic versioning is implemented. Each configuration of a Control Loop Instance and +configuration of a Control Loop Element has a semantic version with 3 digits indicating +the **major.minor.patch** number of the version. + +.. note:: + A **configuration** means a full set of parameter values for a Control Loop Instance. + +.. image:: images/05-upgrade-states.png + +Change constraints: + +#. A Control Loop or Control Loop Element in state **RUNNING** can be changed to a higher patch + level or rolled back to a lower patch level. This means that hot changes that do not + impact the structure of a Control Loop or its elements can be executed. + +#. A Control Loop or Control Loop Element in state **PASSIVE** can be changed to a higher + minor/patch level or rolled back to a lower minor/patch level. This means that structural + changes to Control Loop Elements that do not impact the Control Loop as a whole can be + executed by taking the control loop to state **PASSIVE**. + +#. A Control Loop or Control Loop Element in state **UNINITIALIZED** can be changed to a higher + major/minor/patch level or rolled back to a lower major/minor/patch level. This means + that where the structure of the entire control loop is changed, the control loop must + be uninitialized and reinitialized. + +#. If a Control Loop Element has a **minor** version change, then its Control Loop Instance + must have at least a **minor** version change. + +#. If a Control Loop Element has a **major** version change, then its Control Loop Instance + must have a **major** version change. + +4.2 Scalability +--------------- + +The system is designed to be inherently scalable. The CLAMP runtime is stateless, all state +is preserved in the Instantiated Control Loop inventory in the database. When the user +requests an operation such as an instantiation, activation, passivation, or an uninitialization +on a Control Loop Instance, the CLAMP runtime broadcasts the request to participants over +DMaaP and saves details of the request to the database. The CLAMP runtime does not directly +wait for responses to requests. + +When a request is broadcast on DMaaP, the request is asynchronously picked up by participants +of the types required for the Control Loop Instance and those participants manage the life +cycle of its control loop elements. Periodically, each participant reports back on the status +of operations it has picked up for the Control Loop Elements it controls, together with +statistics on the Control Loop Elements over DMaaP. On reception of these participant messages, +the CLAMP runtime stores this information to its database. + +The participant to use on a control loop can be selected from the registered participants +in either of two ways: + +**Runtime-side Selection:** The CLAMP runtime selects a suitable participant from the list of +participants and sends the participant ID that should be used in the Participant Update message. +In this case, the CLAMP runtime decides on which participant will run the Control Loop Element +based on a suitable algorithm. Algorithms could be round robin based or load based. + +**Participant-side Selection:** The CLAMP runtime sends a list of Participant IDs that may be used +in the Participant Update message. In this case, the candidate participants decide among +themselves which participant should host the Control Loop Element. + +This approach makes it easy to scale Control Loop life cycle management. As Control Loop +Instance counts increase, more than one CLAMP runtime can be deployed and REST/supervision +operations on Control Loop Instances can run in parallel. The number of participants can +scale because an asynchronous broadcast mechanism is used for runtime-participant communication +and there is no direct connection or communication channel between participants and CLAMP +runtime servers. Participant state, Control Loop Instance state, and Control Loop Element +state is held in the database, so any CLAMP runtime server can handle operations for any +participant. Because many participants of a particular type can be deployed and participant +instances can load balance control loop element instances for different Control Loop Instances +of many types across themselves using a mechanism such as a Kubernetes cluster. + + +4.3 Sandboxing and API Gateway Support +-------------------------------------- + +At runtime, interaction between ONAP platform services and application microservices are +relatively unconstrained, so interactions between Control Loop Elements for a given Control +Loop Instance remain relatively unconstrained. A +`proposal to support access-controlled access to and between ONAP services +`_ +will improve this. This can be complemented by intercepting and controlling services +accesses between Control Loop Elements for Control Loop Instances for some/all Control +Loop types. + +API gateways such as `Kong `_ have emerged as a useful technology +for exposing and controlling service endpoint access for applications and services. When a +Control Loop Type is onboarded, or when Control Loop Instances are created in the Participants, +CLAMP can configure service endpoints between Control Loop Elements to redirect through an +API Gateway. + +Authentication and access-control rules can then be dynamically configured at the API gateway +to support constrained access between Control Loop Elements and Control Loop Instances. + +The diagram below shows the approach for configuring API Gateway access at Control Loop +Instance and Control Loop Element level. + +.. image:: images/06-api-gateway-sandbox.png + +At design time, the Control Loop type definition specifies the type of API gateway configuration +that should be supported at Control Loop and Control Loop Element levels. + +At runtime, the CLAMP can configure the API gateway to enable (or deny) interactions between +Control Loop Instances and individually for each Control Loop Element. All service-level +interactions in/out of a Control Loop Element, except that to/from the API Gateway, can be +blocked by networking policies, thus sandboxing a Control Loop Element and an entire Control +Loop Instance if desired. Therefore, a Control Loop Element will only have access to the APIs +that are configured and enabled for the Control Loop Element/Instance in the API gateway. + +For some Control Loop Element Types the Participant can assist with service endpoint +reconfiguration, service request/response redirection to/from the API Gateway, or +annotation of requests/responses. + +Once the Control Loop instance is instantiated on participants, the participants configure +the API gateway with the Control Loop Instance level configuration and with the specific +configuration for their Control Loop Element. + +Monitoring and logging of the use of the API gateway may also be provided. Information and +statistics on API gateway use can be read from the API gateway and passed back in monitoring +messages to the CLAMP runtime. + +Additional isolation and execution-environment sandboxing can be supported depending on the +Control Loop Element Type. For example: ONAP policies for given Control Loop Instances/Types +can be executed in a dedicated PDP engine instances; DCAE or K8S-hosted services can executed +in isolated namespaces or in dedicated workers/clusters; etc.. + + +5 APIs and Protocols +==================== + +The APIs and Protocols used by CLAMP for Control Loops are described on the pages below: + +#. :ref:`System Level Dialogues ` +#. :ref:`The CLAMP Control Loop Participant Protocol ` +#. :ref:`REST APIs for CLAMP Control Loops ` + + +6 Design and Implementation +=========================== + +The design and implementation of TOSCA Control Loops in CLAMP is described for each executable entity on the pages below: + +#. :ref:`The CLAMP Control Loop Runtime Server ` +#. :ref:`CLAMP Control Loop Participants ` +#. :ref:`Managing Control Loops using The CLAMP GUI ` + +End of Document diff --git a/docs/clamp/controlloop/controlloop-participant-protocol.rst b/docs/clamp/controlloop/controlloop-participant-protocol.rst deleted file mode 100644 index 208c5659..00000000 --- a/docs/clamp/controlloop/controlloop-participant-protocol.rst +++ /dev/null @@ -1,472 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _controlloop-participant-protocol-label: - -The CLAMP Control Loop Participant Protocol -########################################### - -The CLAMP Control Loop Participant protocol is an asynchronous protocol that is used by the -CLAMP runtime to coordinate life cycle management of Control Loop instances. The protocol -supports the functions described in the sections below. - - -Protocol Dialogues -================== - -The protocol supports the dialogues described below. - -Participant Registration and De-Registration --------------------------------------------- - -Registration when a participant comes up and update of participant with control loop type -information and common parameter values for its control loop types. - -.. image:: images/clamp-cl-participants/participant-registering.png - - -De-registration is executed as a participant goes down. - -.. image:: images/clamp-cl-participants/participant-deregistration.png - - -Control Loop Priming and De-Priming ------------------------------------ - -When a control loop is primed, the portion of the Control Loop Type Definition and Common -Property values for the participants of each participant type mentioned in the Control Loop -Definition are sent to the participants. - -.. image:: images/clamp-cl-participants/controlloop-priming.png - -When a control loop is de-primed, the portion of the Control Loop Type Definition and Common -Property values for the participants of each participant type mentioned in the Control Loop -Definition are deleted on participants. - -.. image:: images/clamp-cl-participants/controlloop-depriming.png - - -Control Loop Update -------------------- - -Control Loop Update handles creation, change, and deletion of control loops on participants. -Change of control loops uses a semantic versioning approach and follow the semantics described -on the page `4.1 Management of Control Loop Instance Configurations `. - -.. image:: images/clamp-cl-participants/controlloop-update.png - -The handling of a ControlLoopUpdate message in each participant is as shown below. - -.. image:: images/clamp-cl-participants/controlloop-update-msg.png - -Control Loop State Change -------------------------- - -This dialogue is used to change the state of Control Loops and their Control Loop Elements. The -CLAMP Runtime sends a Control Loop State Change message on the control loop to all participants. -Participants that have Control Loop Elements in that Control Loop attempt an update on the state -of the control loop elements they have for that control loop, and report the result back. - -The *startPhase* in the `Definition of TOSCA fundamental Control Loop Types -`_ -is particularly important in control loop state changes because sometime the user wishes to control -the order in which the state changes in Control Loop Elements in a control loop. In state changes -from *UNITITIALISED* → *PASSIVE* and from *PASSIVE* → *RUNNING*, control loop elements are started in -increasing order of their *startPhase*. In state changes from *RUNNING* → *PASSIVE* and from *PASSIVE* -→ *UNITITIALISED*, control loop elements are started in decreasing order of their *startPhase*. - -The CLAMP runtime controls the state change process described in the diagram below. The CLAMP runtime -sends a Control Loop State Change message on DMaaP to all participants in a particular Start Phase so, -in each state change multiple Control Loop State Change messages are sent, one for each Start Phase in -the control loop. If more than one Control Loop Element has the same Start Phase, those Control Loop -Elements receive the same Control Loop State Change message from DMaaP and start in parallel. - -The Participant reads each State Change Message it sees on DMaaP. If the Start Phase on the Control -Loop State Change message matches the Start Phase of the Control Loop Element, the participant processes -the State Change message. Otherwise the participant ignores the message. - -.. image:: images/clamp-cl-participants/controlloop-state-change.png - -The handling of a ControlLoopStateChange message in each participant is as shown below. - -.. image:: images/clamp-cl-participants/controlloop-state-change-msg.png - -Control Loop Monitoring and Reporting -------------------------------------- - -This dialogue is used as a heartbeat mechanism for participants, to monitor the status of Control Loop -Elements, and to gather statistics on control loops. The ParticipantStatus message is sent periodically -by each participant. The reporting interval for sending the message is configurable. - -.. image:: images/clamp-cl-participants/controlloop-monitoring.png - - -Messages -======== - -The CLAMP Control Loop Participant Protocol uses the following messages. The descriptions below give -an overview of each message. For the precise definition of the messages, see the `CLAMP code at Github -`_ -. All messages are carried on DMaaP. - - -.. list-table:: - :widths: 15 10 10 15 15 35 - :header-rows: 1 - - * - Message - - Source - - Target - - Purpose - - Important Fields - - Field Descriptions - * - ParticipantRegister - - Participant - - CLAMP Runtime - - Participant registers with the CLAMP runtime - - ParticipantId - - The ID of this participant - * - - - - - - - - - ParticipantType - - The type of the participant, maps to the capabilities of the participant in Control Loop Type - Definitions - * - ParticipantRegisterAck - - CLAMP Runtime - - Participant - - Acknowledgement of Participant Registration - - ParticipantId - - The ID of this participant - * - - - - - - - - - ParticipantType - - The type of the participant, maps to the capabilities of the participant in Control Loop Type - Definitions - * - - - - - - - - - Result - - Success/Fail - * - - - - - - - - - Message - - Message indicating reason for failure - * - ParticipantUpdate - - CLAMP Runtime - - Participant - - CLAMP Runtime sends Control Loop Element Definitions and Common Parameter Values to Participants - - ParticipantDefinitionUpdateMap - - Map with Participant ID as its key, each value on the map is a ControlLoopElementDefintionMap - * - - - - - - - - - ControlLoopElementDefintionMap - - List of ControlLoopElementDefinition values for a particular participant, keyed by its Control - Loop Element Definition ID - * - - - - - - - - - ControlLoopElementDefinition - - A ControlLoopElementToscaServiceTemplate containing the definition of the Control Loop Element - and a CommonPropertiesMap with the values of the common property values for Control Loop Elements - of this type - * - - - - - - - - - ControlLoopElementToscaServiceTemplate - - The definition of the Control Loop Element in TOSCA - * - - - - - - - - - CommonPropertiesMap - - A map indexed by the property name. Each map entry is the serialized value of - the property, which can be deserialized into an instance of the type of the property. - * - ParticipantUpdateAck - - Participant - - CLAMP Runtime - - Acknowledgement of Participant Update - - ParticipantId - - The ID of this participant - * - - - - - - - - - ParticipantType - - The type of the participant, maps to the capabilities of the participant in Control Loop Type - Definitions - * - - - - - - - - - Result - - Success/Fail - * - - - - - - - - - Message - - Message indicating reason for failure - * - ParticipantDeregister - - Participant - - CLAMP Runtime - - Participant deregisters with the CLAMP runtime - - ParticipantId - - The ID of this participant - * - - - - - - - - - ParticipantType - - The type of the participant, maps to the capabilities of the participant in Control Loop Type - Definitions - * - ParticipantDeregisterAck - - CLAMP Runtime - - Participant - - Acknowledgement of Participant Deegistration - - ParticipantId - - The ID of this participant - * - - - - - - - - - ParticipantType - - The type of the participant, maps to the capabilities of the participant in Control Loop Type - Definitions - * - - - - - - - - - Result - - Success/Fail - * - - - - - - - - - Message - - Message indicating reason for failure - * - ControlLoopUpdate - - CLAMP Runtime - - Participant - - CLAMP Runtime sends Control Loop Element instances and Instance Specific Parameter Values for - a Control Loop Instance to Participants - - ControlLoopId - - The name and version of the Control Loop - * - - - - - - - - - ParticipantUpdateMap - - Map with Participant ID as its key, each value on the map is a ControlLoopElementList - * - - - - - - - - - ControlLoopElementList - - List of ControlLoopElement values for the Control Loop - * - - - - - - - - - ControlLoopElement - - A ControlLoopElement, which contains among other things a PropertiesMap with the values of the - property values for this Control Loop Element instance and a ToscaServiceTemplateFragment with - extra concept definitions and instances that a participant may need. - * - - - - - - - - - PropertiesMap - - A map indexed by the property name. Each map entry is the serialized value of - the property, which can be deserialized into an instance of the type of the property. - * - - - - - - - - - ToscaServiceTemplateFragment - - A well-formed TOSCA service template containing extra concept definitions and instances that a - participant may need. For example, the Policy Participant may need policy type definitions or - policy instances to be provided if they are not already stored in the Policy Framework. - * - ControlLoopUpdateAck - - Participant - - CLAMP Runtime - - Acknowledgement of Control Loop Update - - ParticipantId - - The ID of this participant - * - - - - - - - - - ParticipantType - - The type of the participant, maps to the capabilities of the participant in Control Loop Type - Definitions - * - - - - - - - - - ControlLoopId - - The name and version of the Control Loop - * - - - - - - - - - ControlLoopResult - - Holds a Result and Message for the overall operation on the participant and a map of Result - and Message fields for each Control Loop Element of the control loop on this participant - * - - - - - - - - - Result - - Success/Fail - * - - - - - - - - - Message - - Message indicating reason for failure - * - ControlLoopStateChange - - CLAMP Runtime - - Participant - - CLAMP Runtime asks Participants to change the state of a Control Loop - - ControlLoopId - - The name and version of the Control Loop - * - - - - - - - - - currentState - - The current state of the Control Loop - * - - - - - - - - - orderedState - - The state that the Control Loop should transition to - * - - - - - - - - - startPhase - - The start phase to which this ControLoopStateChange message applies - * - ControlLoopStateChangeAck - - Participant - - CLAMP Runtime - - Acknowledgement of Control Loop State Change - - ParticipantId - - The ID of this participant - * - - - - - - - - - ParticipantType - - The type of the participant, maps to the capabilities of the participant in Control Loop Type - Definitions - * - - - - - - - - - ControlLoopId - - The name and version of the Control Loop - * - - - - - - - - - startPhase - - The start phase to which this ControLoopStateChangeAck message applies - * - - - - - - - - - ControlLoopResult - - Holds a Result and Message for the overall operation on the participant and a map of Result and - Message fields for each Control Loop Element of the control loop on this participant - * - - - - - - - - - Result - - Success/Fail - * - - - - - - - - - Message - - Message indicating reason for failure - * - ParticipantStatusReq - - CLAMP Runtime - - Participant - - Request that the specified participants return a ParticipantStatus message immediately - - ParticipantId - - The ID of this participant, if not specified, all participants respond. - * - ParticipantStatus - - Participant - - CLAMP Runtime - - Periodic or on-demand report for heartbeat, Participant Status, Control Loop Status, and Control - Loop Statistics - - ParticipantId - - The ID of this participant - * - - - - - - - - - ParticipantType - - The type of the participant, maps to the capabilities of the participant in Control Loop - Type Definitions - * - - - - - - - - - ParticipantDefinitionUpdateMap (returned in repsonse to ParticipantStatusReq only) - - See ParticipantUpdate message above for definition of this field - * - - - - - - - - - ParticipantStatus - - The current status of the participant for monitoring - * - - - - - - - - - ParticipantStatistics - - Statistics on the participant such as up time, or messages processed. Can include participant - specific data in a string blob that is opaque to CLAMP - * - - - - - - - - - ControlLoopInfoMap - - A map of ControlLoopInfo types indexed by ControlLoopId, one entry for each control loop - running on the participant - * - - - - - - - - - ControlLoopInfo - - The ControlLoopStatus and ControlLoopStatistics for a given control loop - * - - - - - - - - - ControlLoopStatus - - The current status of the control loop for monitoring - * - - - - - - - - - ControlLoopStatistics - - Statistics on the control loop such as up time, or messages processed. Can include participant - specific data in a string blob that is opaque to CLAMP - - -End of Document diff --git a/docs/clamp/controlloop/controlloop-rest-apis.rst b/docs/clamp/controlloop/controlloop-rest-apis.rst deleted file mode 100644 index 1012e53f..00000000 --- a/docs/clamp/controlloop/controlloop-rest-apis.rst +++ /dev/null @@ -1,130 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _controlloop-rest-apis-label: - -REST APIs for CLAMP Control Loops -################################# - - -Commissioning API -================= - -This API is a CRUD API that allows Control Loop Type definitions created in a design -environment to be commissioned on the CLAMP runtime. It has endpoints that allow Control -Loop Types to be created, read, updated, and deleted. - -The body of the create and update end points is a TOSCA Service/Topology template that -defines the new or changed Control Loop Type. The update and delete endpoints take a -reference to the Control Loop Type. The incoming TOSCA is verified and checked for -referential integrity. On delete requests, a check is made to ensure that no Control -Loop Instances exist for the Control Loop Type to be deleted. - -:download:`Download Policy Control Loop Commissioning API Swagger ` - -.. swaggerv2doc:: swagger/controlloop-comissioning.json - - -Instantiation API -================= - -The instantiation API has two functions: - -#. Creation, Reading, Update, and Deletion of Control Loop Instances. -#. Instantiation and lifecycle management of Control Loop Instances on participants - -The Instantiation API is used by the CLAMP GUI. - -Instantiation Control Loop Instance CRUD ----------------------------------------- - -This sub API allows for the creation, read, update, and deletion of Control Loop Instances. -The endpoints for create and update take a JSON body that describes the Control Loop Instance. -The endpoints for read and delete take a Control Loop Instance ID to determine which Control -Loop Instance to act on. For the delete endpoint, a check is made to ensure that the Control -Loop Instance is not instantiated on participants. - -A call to the update endpoint for a Control Loop Instance follow the semantics described here: -`4.1 Management of Control Loop Instance Configurations `. - -:download:`Download Policy Control Loop Instantiation API Swagger ` - -.. swaggerv2doc:: swagger/controlloop-instantiation.json - - -Instantiation Control Loop Instance Lifecycle Management --------------------------------------------------------- - -This sub API is used to manage the life cycle of Control Loop Instances. A Control Loop Instance -can be in the states described here: `2.1 Control Loop Instance States `. -Managing the life cycle of a Control Loop Instance amounts to steering the Control Loop through -its states. - -The sub API allows upgrades and downgrades of Control Loop Instances to be pushed to participants -following the semantics described here: `4.1 Management of Control Loop Instance Configurations -`. When the API is used to update the participants on a Control -Loop Instance, the new/upgraded/downgraded definition of the Control Loop is pushed to the -participants. Note that the API asks the participants in a Control Loop Instance to perform the -update, it is the responsibility of the participants to execute the update and report the result -using the protocols described here: `CLAMP Participants <#>`_. The progress and result of an update -can be monitored using the `Monitoring API `. - -The sub API also allows a state change of a Control Loop Instance to be ordered. The required state -of the Control Loop Instance is pushed to participants in a Control Loop Instance using the API. -Note that the API asks the participants in a Control Loop Instance to perform the state change, it -is the responsibility of the participants to execute the state change and report the result using -the protocols described here: CLAMP Participants. The progress and result of a state change can be -monitored using the `Monitoring API `. - -.. warning:: - The Swagger for the Instantiation Lifecycle Management API will appear here. - -.. _monitoring-api: - -Monitoring API -============== - -The Monitoring API allows the state and statistics of Participants, Control Loop Instances and their Control Loop Elements to be monitored. This API is used by the CLAMP GUI. The API provides filtering so that specific Participants and Control Loop Instances can be retrieved. In addition, the quantity of statistical information to be returned can be scoped. - -:download:`Download Policy Control Loop Monitoring API Swagger ` - -.. swaggerv2doc:: swagger/controlloop-monitoring.json - -Pass Through API -================ - -This API allows information to be passed to Control Loop Elements in a control loop. - -.. warning:: - The requirements on this API are still under discussion. - -.. warning:: - The Swagger for the Pass Through API will appear here. - - -Participant Standalone API -========================== - -This API allows a Participant to run in standalone mode and to run standalone Control Loop Elements. - -Kubernetes participant can also be deployed as a standalone application and provides REST end points -for onboarding helm charts to its local chart storage, installing and uninstalling of helm charts to -a kubernetes cluster. It also allows to configure a remote repository in kubernetes participant for -installing helm charts. User can onboard a helm chart along with the overrides yaml file, the chart -gets stored in to the local chart directory of kubernetes participant. The onboarded charts can be -installed, uninstalled. The GET API fetches all the available helm charts from the chart storage. - -:download:`Download Policy Control Loop Participant Standalone API Swagger ` - -.. swaggerv2doc:: swagger/k8sparticipant.json - - -Participant Simulator API -========================= - -This API allows a Participant Simulator to be started and run for test purposes. - -:download:`Download Policy Participant Simulator API Swagger ` - -.. swaggerv2doc:: swagger/participant-sim.json - -End of Document diff --git a/docs/clamp/controlloop/controlloop.rst b/docs/clamp/controlloop/controlloop.rst index 4cf242ba..51aa7ec1 100644 --- a/docs/clamp/controlloop/controlloop.rst +++ b/docs/clamp/controlloop/controlloop.rst @@ -1,471 +1,16 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. _clamp-builtin-label: +.. _clamp-controlloop-label: CLAMP Metadata Control Loop Automation Management using TOSCA ############################################################# +CLAMP supports the definition, deployment, and life cycle management of control loops using Metadata described in TOSCA. -.. contents:: - :depth: 4 +.. toctree:: + :maxdepth: 2 -The idea of using control loops to automatically (or autonomously) perform network management -has been the subject of much research in the Network Management research community, see -:download:`this paper ` for some background. However, it is only with -the advent of ONAP that we have a platform that supports control loops for network management. -Before ONAP, Control Loops have been implemented by hard-coding components together and hard -coding logic into components. ONAP has taken a step forward towards automatic implementation -of Control Loops by allowing parameterization of Control Loops that work on the premise that -the Control Loops use a set of analytic, policy, and control components connected together in -set ways. - -The goal of the work is to extend and enhance the current ONAP Control Loop support to provide -a complete open-source framework for Control Loops. This will enhance the current support to -provide TOSCA based Control Loop definition and development, commissioning and run-time management. -The participants that comprise a Control Loop and the metadata needed to link the participants -together to create a Control Loop are specified in a standardized way using the `OASIS TOSCA -modelling language `_. The TOSCA -description is then used to commission, instantiate, and manage the Control Loops in the run -time system. - -.. image:: images/01-controlloop-overview.png - -1 Terminology -============= - -This section describes the terminology used in the system. - -1.1 Control Loop Terminology ----------------------------- - -**Control Loop Type:** A definition of a Control Loop in the TOSCA language. This definition describes -a certain type of a control loop. The life cycle of instances of a Control Loop Type are managed -by CLAMP. - -**Control Loop Instance:** An instance of a Control Loop Type. The life cycle of a Control Loop -Instance is managed by CLAMP. A Control Loop Instance is a set of executing elements on which -Life Cycle Management (LCM) is executed collectively. For example, a set of microservices may be -spawned and executed together to deliver a service. This collection of services is a control loop. - -**Control Loop Element Type:** A definition of a Control Loop Element in the TOSCA language. This -definition describes a certain type of Control Loop Element for a control loop in a Control -Loop Type. - -**Control Loop Element Instance:** A single entity executing on a participant, with its Life Cycle -being managed as part of the overall control loop. For example, a single microservice that is -executing as one microservice in a service. - -**CLAMP Control Loop Runtime:** The CLAMP server that holds Control Loop Type definitions and manages -the life cycle of Control Loop Instances and their Control Loop Elements in cooperation with -participants. - - -1.2 Participant Terminology ---------------------------- - -**Participant Type:** Definition of a type of system or framework that can take part in control -loops and a definition of the capabilities of that participant type. A participant advertises -its type to the CLAMP Control Loop Runtime. - -**Participant:** A system or framework that takes part in control loops by executing Control Loop -Elements in cooperation with the CLAMP Control Loop Runtime. A participant chooses to partake -in control loops, to manage Control Loop Elements for CLAMP, and to receive, send and act on -LCM messages for the CLAMP runtime. - -1.3 Terminology for Properties ------------------------------- - -**Common Properties:** Properties that apply to all Control Loop Instances of a certain Control -Loop Type and are specified when a Control Loop Type is commissioned. - -**Instance Specific Properties:** Properties that must be specified for each Control Loop Instance -and are specified when a Control Loop Instance is Initialized. - -1.4 Concepts and their relationships ------------------------------------- - -The UML diagram below shows the concepts described in the terminology sections above and how -they are interrelated. - -.. image:: images/02-controlloop-concepts.png - -The Control Loop Definition concepts describe the types of things that are in the system. These -concepts are defined at design time and are passed to the runtime in a TOSCA document. The -concepts in the Control Loop Runtime are created by the runtime part of the system using the -definitions created at design time. - -.. _controlloop-capabilities: - -2 Capabilities -============== - -We consider the capabilities of Control Loops at Design Time and Run Time. - -At Design Time, three capabilities are supported: - -#. **Control Loop Element Definition Specification.** This capability allows users to define Control - Loop Element Types and the metadata that can be used on and configured on a Control Loop Element - Type. Users also define the Participant Type that will run the Control Loop Element when it is - taking part in in a control loop. The post condition of an execution of this capability is that - metadata for a Control Loop Element Type is defined in the Control Loop Design Time Catalogue. - -#. **Control Loop Element Definition Onboarding.** This capability allows external users and systems - (such as SDC or DCAE-MOD) to define the metadata that can be used on and configured on a Control - Loop Element Type and to define the Participant Type that will run the Control Loop Element when - it is taking part in in a control loop. The post condition of an execution of this capability - is that metadata for a Control Loop Element Type is defined in the Control Loop Design Time - Catalogue. - -#. **Control Loop Type Definition.** This capability allows users and other systems to create Control - Loop Type definitions by specifying a set of Control Loop Element Definitions from those that - are available in the Control Loop Design Time Catalogue. These Control Loop Elements will - work together to form Control Loops. In an execution of this capability, a user specifies the - metadata for the Control Loop and specifies the set of Control Loop Elements and their Participant - Types. The user also selects the correct metadata sets for each participant in the Control Loop - Type and defines the overall Control Loop Type metadata. The user also specifies the Common - Property Types that apply to all instances of a control loop type and the Instance Specific - Property Types that apply to individual instances of a Control Loop Type. The post condition for - an execution of this capability is a Control Loop definition in TOSCA stored in the Control Loop - Design Time Catalogue. - -.. note:: - Once a Control Loop Definition is commissioned to the Control Loop Runtime and has been - stored in the Run Time Inventory, it cannot be further edited unless it is decommissioned. - - -At Run Time, the following participant related capabilities are supported: - -#. **System Pre-Configuration.** This capability allows participants to register and deregister - with CLAMP. Participants explicitly register with CLAMP when they start. Control Loop Priming - is performed on each participant once it registers. The post condition for an execution of this - capability is that a participant becomes available (registration) or is no longer available - (deregistration) for participation in a control loop. - -#. **Control Loop Priming on Participants.** A participant is primed to support a Control Loop Type. - Priming a participant means that the definition of a control loop and the values of Common - Property Types that apply to all instances of a control loop type on a participant are sent - to a participant. The participant can then take whatever actions it need to do to support - the control loop type in question. Control Loop Priming takes place at participant - registration and at Control Loop Commissioning. The post condition for an execution of this - capability is that all participants in this control loop type are commissioned, that is they - are prepared to run instances of their Control Loop Element types. - - -At Run Time, the following Control Loop Life Cycle management capabilities are supported: - -#. **Control Loop Commissioning:** This capability allows version controlled Control Loop Type - definitions to be taken from the Control Loop Design Time Catalogue and be placed in the - Commissioned Control Loop Inventory. It also allows the values of Common Property Types - that apply to all instances of a Control Loop Type to be set. Further, the Control Loop - Type is primed on all concerned participants. The post condition for an execution of this - capability is that the Control Loop Type definition is in the Commissioned Control Loop - Inventory and the Control Loop Type is primed on concerned participants. - -#. **Control Loop Instance Life Cycle Management:** This capability allows a Control Loop - Instance to have its life cycle managed. - - #. **Control Loop Instance Creation:** This capability allows a Control Loop Instance to be - created. The Control Loop Type definition is read from the Commissioned Control Loop - Inventory and values are assigned to the Instance Specific Property Types defined for - instances of the Control Loop Type in the same manner as the existing CLAMP client does. - A Control Loop Instance that has been created but has not yet been instantiated on - participants is in state UNINITIALIZED. In this state, the Instance Specific Property Type - values can be revised and updated as often as the user requires. The post condition for an - execution of this capability is that the Control Loop instance is created in the - Instantiated Control Loop Inventory but has not been instantiated on Participants. - - #. **Control Loop Instance Update on Participants:** Once the user is happy with the property - values, the Control Loop Instance is updated on participants and the Control Loop Elements - for this Control Loop Instance are initialized or updated by participants using the control - loop metadata. The post condition for an execution of this capability is that the Control - Loop instance is updated on Participants. - - #. **Control Loop State Change:** The user can now order the participants to change the state - of the Control Loop Instance. If the Control Loop is set to state RUNNING, each participant - begins accepting and processing control loop events and the Control Loop Instance is set - to state RUNNING in the Instantiated Control Loop inventory. The post condition for an - execution of this capability is that the Control Loop instance state is changed on - participants. - - #. **Control Loop Instance Monitoring:** This capability allows Control Loop Instances to be - monitored. Users can check the status of Participants, Control Loop Instances, and Control - Loop Elements. Participants report their overall status and the status of Control Loop - Elements they are running periodically to CLAMP. Clamp aggregates these status reports - into an aggregated Control Loop Instance status record, which is available for monitoring. - The post condition for an execution of this capability is that Control Loop Instances are - being monitored. - - #. **Control Loop Instance Supervision:** This capability allows Control Loop Instances to be - supervised. The CLAMP runtime expects participants to report on Control Loop Elements - periodically. The CLAMP runtime checks that periodic reports are received and that each - Control Loop Element is in the state it should be in. If reports are missed or if a - Control Loop Element is in an incorrect state, remedial action is taken and notifications - are issued. The post condition for an execution of this capability is that Control Loop - Instances are being supervised by the CLAMP runtime. - - #. **Control Loop Instance Removal from Participants:** A user can order the removal of a Control - Loop Instance from participants. The post condition for an execution of this capability is - that the Control Loop instance is removed from Participants. - - #. **Control Loop Instance Deletion:** A user can order the removal of a Control Loop Instance - from the CLAMP runtime. Control Loop Instances that are instantiated on participants cannot - be removed from the CLAMP runtime. The post condition for an execution of this capability - is that the Control Loop instance is removed from Instantiated Control Loop Inventory. - -#. **Control Loop Decommissioning:** This capability allows version controlled Control Loop Type - definitions to be removed from the Commissioned Control Loop Inventory. A Control Loop - Definition that has instances in the Instantiated Control Loop Inventory cannot be removed. - The post condition for an execution of this capability is that the Control Loop Type - definition removed from the Commissioned Control Loop Inventory. - -.. note:: - The system dialogues for run time capabilities are described in detail on the - :ref:`System Level Dialogues ` page. - -.. _controlloop-instance-states: - -2.1 Control Loop Instance States --------------------------------- - -When a control loop definition has been commissioned, instances of the control loop can be -created, updated, and deleted. The system manages the lifecycle of control loops and control -loop elements following the state transition diagram below. - -.. image:: images/03-controlloop-instance-states.png - -3 Overall Target Architecture -============================= - -The diagram below shows an overview of the architecture of TOSCA based Control Loop -Management in CLAMP. - -.. image:: images/04-overview.png - -Following the ONAP Reference Architecture, the architecture has a Design Time part and -a Runtime part. - -The Design Time part of the architecture allows a user to specify metadata for participants. -It also allows users to compose control loops. The Design Time Catalogue contains the metadata -primitives and control loop definition primitives for composition of control loops. As shown -in the figure above, the Design Time component provides a system where Control Loops can be -designed and defined in metadata. This means that a Control Loop can have any arbitrary -structure and the Control Loop developers can use whatever analytic, policy, or control -participants they like to implement their Control Loop. At composition time, the user -parameterises the Control Loop and stores it in the design time catalogue. This catalogue -contains the primitive metadata for any participants that can be used to compose a Control -Loop. A Control Loop SDK is used to compose a Control Loop by aggregating the metadata for -the participants chosen to be used in a Control Loop and by constructing the references between -the participants. The architecture of the Control Loop Design Time part will be elaborated in -future releases. - -Composed Control Loops are commissioned on the run time part of the system, where they are -stored in the Commissioned Control Loop inventory and are available for instantiation. The -Commissioning component provides a CRUD REST interface for Control Loop Types, and implements -CRUD of Control Loop Types. Commissioning also implements validation and persistence of incoming -Control Loop Types. It also guarantees the integrity of updates and deletions of Control Loop -Types, such as performing updates in accordance with semantic versioning rules and ensuring that -deletions are not allowed on Control Loop Types that have instances defined. - -The Instantiation component manages the Life Cycle Management of Control Loop Instances and -their Control Loop Elements. It publishes a REST interface that is used to create Control Loop -Instances and set values for Common and Instance Specific properties. This REST interface is -public and is used by the CLAMP GUI. It may also be used by any other client via the public -REST interface. the REST interface also allows the state of Control Loop Instances to be changed. -A user can change the state of Control Loop Instances as described in the state transition -diagram shown in section 2 above. The Instantiation component issues update and state change -messages via DMaaP to participants so that they can update and manage the state of the Control -Loop Elements they are responsible for. The Instantiation component also implements persistence -of Control Loop Instances, control loop elements, and their state changes. - -The Monitoring component reads updates sent by participants. Participants report on the -state of their Control Loop Elements periodically and in response to a message they have -received from the Instantiation component. The Monitoring component reads the contents of -the participant messages and persists their state updates and statistics records. It also -publishes a REST interface that publishes the current state of all Participants, Control -Loop Instances and their Control Loop Elements, as well as publishing Participant and -Control Loop statistics. - -The Supervision component is responsible for checking that Control Loop Instances are correctly -instantiated and are in the correct state (UNINITIALIZED/READY/RUNNING). It also handles -timeouts and on state changes to Control Loop Instances, and retries and rolls back state -changes where state changes failed. - -A Participant is an executing component that partakes in control loops. More explicitly, a -Participant is something that implements the Participant Instantiation and Participant -Monitoring messaging protocol over DMaaP for Life Cycle management of Control Loop Elements. -A Participant runs Control Loop Elements and manages and reports on their life cycle -following the instructions it gets from the CLAMP runtime in messages delivered over DMaaP. - -In the figure above, five participants are shown. A Configuration Persistence Participant -manages Control Loop Elements that interact with the `ONAP Configuration Persistence Service -`_ -to store common data. The DCAE Participant runs Control Loop Elements that manage DCAE -microservices. The Kubernetes Participant hosts the Control Loop Elements that are managing -the life cycle of microservices in control loops that are in a Kubernetes ecosystem. The -Policy Participant handles the Control Loop Elements that interact with the Policy Framework -to manage policies for control loops. A Controller Participant such as the CDS Participant -runs Control Loop Elements that load metadata and configure controllers so that they can -partake in control loops. Any third party Existing System Participant can be developed to -run Control Loop Elements that interact with any existing system (such as an operator's -analytic, machine learning, or artificial intelligence system) so that those systems can -partake in control loops. - -4. Other Considerations -======================= - -.. _management-cl-instance-configs: - -4.1 Management of Control Loop Instance Configurations ------------------------------------------------------- - -In order to keep management of versions of the configuration of control loop instances -straightforward and easy to implement, the following version management scheme using -semantic versioning is implemented. Each configuration of a Control Loop Instance and -configuration of a Control Loop Element has a semantic version with 3 digits indicating -the **major.minor.patch** number of the version. - -.. note:: - A **configuration** means a full set of parameter values for a Control Loop Instance. - -.. image:: images/05-upgrade-states.png - -Change constraints: - -#. A Control Loop or Control Loop Element in state **RUNNING** can be changed to a higher patch - level or rolled back to a lower patch level. This means that hot changes that do not - impact the structure of a Control Loop or its elements can be executed. - -#. A Control Loop or Control Loop Element in state **PASSIVE** can be changed to a higher - minor/patch level or rolled back to a lower minor/patch level. This means that structural - changes to Control Loop Elements that do not impact the Control Loop as a whole can be - executed by taking the control loop to state **PASSIVE**. - -#. A Control Loop or Control Loop Element in state **UNINITIALIZED** can be changed to a higher - major/minor/patch level or rolled back to a lower major/minor/patch level. This means - that where the structure of the entire control loop is changed, the control loop must - be uninitialized and reinitialized. - -#. If a Control Loop Element has a **minor** version change, then its Control Loop Instance - must have at least a **minor** version change. - -#. If a Control Loop Element has a **major** version change, then its Control Loop Instance - must have a **major** version change. - -4.2 Scalability ---------------- - -The system is designed to be inherently scalable. The CLAMP runtime is stateless, all state -is preserved in the Instantiated Control Loop inventory in the database. When the user -requests an operation such as an instantiation, activation, passivation, or an uninitialization -on a Control Loop Instance, the CLAMP runtime broadcasts the request to participants over -DMaaP and saves details of the request to the database. The CLAMP runtime does not directly -wait for responses to requests. - -When a request is broadcast on DMaaP, the request is asynchronously picked up by participants -of the types required for the Control Loop Instance and those participants manage the life -cycle of its control loop elements. Periodically, each participant reports back on the status -of operations it has picked up for the Control Loop Elements it controls, together with -statistics on the Control Loop Elements over DMaaP. On reception of these participant messages, -the CLAMP runtime stores this information to its database. - -The participant to use on a control loop can be selected from the registered participants -in either of two ways: - -**Runtime-side Selection:** The CLAMP runtime selects a suitable participant from the list of -participants and sends the participant ID that should be used in the Participant Update message. -In this case, the CLAMP runtime decides on which participant will run the Control Loop Element -based on a suitable algorithm. Algorithms could be round robin based or load based. - -**Participant-side Selection:** The CLAMP runtime sends a list of Participant IDs that may be used -in the Participant Update message. In this case, the candidate participants decide among -themselves which participant should host the Control Loop Element. - -This approach makes it easy to scale Control Loop life cycle management. As Control Loop -Instance counts increase, more than one CLAMP runtime can be deployed and REST/supervision -operations on Control Loop Instances can run in parallel. The number of participants can -scale because an asynchronous broadcast mechanism is used for runtime-participant communication -and there is no direct connection or communication channel between participants and CLAMP -runtime servers. Participant state, Control Loop Instance state, and Control Loop Element -state is held in the database, so any CLAMP runtime server can handle operations for any -participant. Because many participants of a particular type can be deployed and participant -instances can load balance control loop element instances for different Control Loop Instances -of many types across themselves using a mechanism such as a Kubernetes cluster. - - -4.3 Sandboxing and API Gateway Support --------------------------------------- - -At runtime, interaction between ONAP platform services and application microservices are -relatively unconstrained, so interactions between Control Loop Elements for a given Control -Loop Instance remain relatively unconstrained. A -`proposal to support access-controlled access to and between ONAP services -`_ -will improve this. This can be complemented by intercepting and controlling services -accesses between Control Loop Elements for Control Loop Instances for some/all Control -Loop types. - -API gateways such as `Kong `_ have emerged as a useful technology -for exposing and controlling service endpoint access for applications and services. When a -Control Loop Type is onboarded, or when Control Loop Instances are created in the Participants, -CLAMP can configure service endpoints between Control Loop Elements to redirect through an -API Gateway. - -Authentication and access-control rules can then be dynamically configured at the API gateway -to support constrained access between Control Loop Elements and Control Loop Instances. - -The diagram below shows the approach for configuring API Gateway access at Control Loop -Instance and Control Loop Element level. - -.. image:: images/06-api-gateway-sandbox.png - -At design time, the Control Loop type definition specifies the type of API gateway configuration -that should be supported at Control Loop and Control Loop Element levels. - -At runtime, the CLAMP can configure the API gateway to enable (or deny) interactions between -Control Loop Instances and individually for each Control Loop Element. All service-level -interactions in/out of a Control Loop Element, except that to/from the API Gateway, can be -blocked by networking policies, thus sandboxing a Control Loop Element and an entire Control -Loop Instance if desired. Therefore, a Control Loop Element will only have access to the APIs -that are configured and enabled for the Control Loop Element/Instance in the API gateway. - -For some Control Loop Element Types the Participant can assist with service endpoint -reconfiguration, service request/response redirection to/from the API Gateway, or -annotation of requests/responses. - -Once the Control Loop instance is instantiated on participants, the participants configure -the API gateway with the Control Loop Instance level configuration and with the specific -configuration for their Control Loop Element. - -Monitoring and logging of the use of the API gateway may also be provided. Information and -statistics on API gateway use can be read from the API gateway and passed back in monitoring -messages to the CLAMP runtime. - -Additional isolation and execution-environment sandboxing can be supported depending on the -Control Loop Element Type. For example: ONAP policies for given Control Loop Instances/Types -can be executed in a dedicated PDP engine instances; DCAE or K8S-hosted services can executed -in isolated namespaces or in dedicated workers/clusters; etc.. - - -5 APIs and Protocols -==================== - -The APIs and Protocols used by CLAMP for Control Loops are described on the pages below: - -#. :ref:`System Level Dialogues ` -#. :ref:`Defining Control Loops in TOSCA for CLAMP ` -#. :ref:`The CLAMP Control Loop Participant Protocol ` -#. :ref:`REST APIs for CLAMP Control Loops ` - - -6 Design and Implementation -=========================== - -The design and implementation of TOSCA Control Loops in CLAMP is described for each executable entity on the pages below: - -#. The CLAMP Runtime Server -#. CLAMP Participants -#. The CLAMP GUI -#. Building and running CLAMP -#. Testing CLAMP - -End of Document + controlloop-architecture + defining-controlloops + api-protocol/api-protocol + design-impl/design-impl diff --git a/docs/clamp/controlloop/defining-controlloops.rst b/docs/clamp/controlloop/defining-controlloops.rst index dad5ff1a..71a646dd 100644 --- a/docs/clamp/controlloop/defining-controlloops.rst +++ b/docs/clamp/controlloop/defining-controlloops.rst @@ -193,7 +193,7 @@ Properties are instance specific by default, but can be identified by a special in Control Loop and Control Loop Element definitions. For example, the chart parameter on a Kubernetes Control Loop Element has a different value for every instance of a Kubernetes Control Loop Element, so it can be defined as shown below in the :ref:`Kubernetes Control Loop Type definition -<_kubernetes-cl-element>` yaml file. +` yaml file. .. code-block:: yaml diff --git a/docs/clamp/controlloop/design-impl/clamp-controlloop-runtime.rst b/docs/clamp/controlloop/design-impl/clamp-controlloop-runtime.rst new file mode 100644 index 00000000..5bea627f --- /dev/null +++ b/docs/clamp/controlloop/design-impl/clamp-controlloop-runtime.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop-runtime: + +The CLAMP Control Loop Runtime +############################## + +To be completed. diff --git a/docs/clamp/controlloop/design-impl/clamp-gui-controlloop.rst b/docs/clamp/controlloop/design-impl/clamp-gui-controlloop.rst new file mode 100644 index 00000000..9064889b --- /dev/null +++ b/docs/clamp/controlloop/design-impl/clamp-gui-controlloop.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-gui-controlloop: + +The CLAMP GUI for Control Loops +############################### + +To be completed. diff --git a/docs/clamp/controlloop/design-impl/design-impl.rst b/docs/clamp/controlloop/design-impl/design-impl.rst new file mode 100644 index 00000000..50ebb2e7 --- /dev/null +++ b/docs/clamp/controlloop/design-impl/design-impl.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop-design-impl: + +CLAMP TOSCA Control Loop Components: Design and Implementaiton +############################################################## + +The sections below describe the components that handle TOSCA Control Loops. + +.. toctree:: + :maxdepth: 1 + + clamp-controlloop-runtime + clamp-gui-controlloop + participants/participants diff --git a/docs/clamp/controlloop/design-impl/participants/http-participant.rst b/docs/clamp/controlloop/design-impl/participants/http-participant.rst new file mode 100644 index 00000000..87f0ec6f --- /dev/null +++ b/docs/clamp/controlloop/design-impl/participants/http-participant.rst @@ -0,0 +1,103 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop-http-participant: + +HTTP Participant +################ + +.. warning:: To be completed + +The CLAMP HTTP participant receives configuration information from the CLAMP runtime, +maps the configuration information to a REST URL, and makes a REST call on the URL. +Typically the HTTP Participant is used with another participant such as the +:ref:`Kubernetes Participant `, which brings up +the microservice that runs a REST server. Once the microservice is up, the HTTP +participant can be used to configure the microservice over its REST interface.Of course, +the HTTP participant works towards any REST service, it is not restricted to REST +services started by participants. + +.. image:: ../../images/participants/http-participant.png + +The HTTP participant runs a Control Loop Element to handle the REST dialogues for a +particular application domain. The REST dialogues are whatever REST calls that are +required to implement the functionality for the application domain. + +The HTTP participant allows the REST dialogues for a Control Loop to be managed. A +particular Control Loop may require many *things* to be configured and managed and this +may require many REST dialogues to achieve. + +A *Configuration Entity* describes a concept that is managed by the HTTP participant. A +Configuration Entity can be created, Read, Updated, and Deleted (CRUD). The user defines +the Configuration Entities that it wants its HTTP Control Loop Element to manage and +provides a sequence of parameterized REST commands to Create, Read, Update, and Delete +each Configuration Entity. + +When a control loop is initialized, the HTTP participant starts a HTTP Control Loop +element for the control loop. It reads the configuration information sent from the +Control Loop Runtime runs a HTTP client to talk to the REST endpoint that is receiving +the REST requests. A HTTP participant can simultaneously manage HTTP Control Loop +Elements towards multiple REST endpoints, as shown in the diagram above where the HTTP +participant is running two HTTP Control Loop Elements, one for Control Loop A and one for +Control Loop B. + +Configuring a Control Loop Element on the HTTP participant for a Control Loop +----------------------------------------------------------------------------- + +The user configures the following properties in the CLAMP GUI for the HTTP participant: + +.. list-table:: + :widths: 15 10 50 + :header-rows: 1 + + * - Property + - Type + - Description + * - baseUrl + - URL + - A well formed URL pointing at the REST server that is processing the REST requests + * - httpHeaders + - map + - A map of ** defining the HTTP headers to send on all REST calls + * - configurationEntitiies + - map + - A map of ** describing the names and definitions of + configuration entities that are managed by this HTTP Control Loop Element + +The *ConfigurationEntity* type is described in the following table: + +.. list-table:: + :widths: 15 10 50 + :header-rows: 1 + + * - Field + - Type + - Description + * - ID + - ToscaConceptIdentifier + - The name and version of the Configuration Entity + * - restSequence + - List + - A list of REST requests to give manage the Configuration Entity + +The *RestRequest* type is described in the following table: + +.. list-table:: + :widths: 15 10 50 + :header-rows: 1 + + * - Field + - Type + - Description + * - httpMethod + - HttpMethod + - An enum for the HTTP method {GET, PUT, POST, DELETE} + * - path + - String + - The path of the REST endopint relative to the baseUrl + * - body + - String + - The body of the request for POST and PUT methods + * - expectedResponse + - HttpStatus + - The expected HTTP response code fo the REST request + \ No newline at end of file diff --git a/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst b/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst new file mode 100644 index 00000000..1e1a05a3 --- /dev/null +++ b/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop-k8s-participant: + +Kubernetes Participant +###################### + +.. warning:: To be completed diff --git a/docs/clamp/controlloop/design-impl/participants/participant-intermediary.rst b/docs/clamp/controlloop/design-impl/participants/participant-intermediary.rst new file mode 100644 index 00000000..7f6cf499 --- /dev/null +++ b/docs/clamp/controlloop/design-impl/participants/participant-intermediary.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop-participant-intermediary: + +Participant Intermediary +######################## + +The CLAMP Participant Intermediary is a common library in ONAP, which does common message and +state handling for participant implementations. It provides a Java API, which participant +implementations implement to receive and send messages to the CLAMP runtime and to handle +Control Loop Element state. + +.. warning:: To be completed diff --git a/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst b/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst new file mode 100644 index 00000000..8f59a9f1 --- /dev/null +++ b/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop-participant-simulator: + +Participant Simulator +##################### + +To be completed. diff --git a/docs/clamp/controlloop/design-impl/participants/participants.rst b/docs/clamp/controlloop/design-impl/participants/participants.rst new file mode 100644 index 00000000..230c9888 --- /dev/null +++ b/docs/clamp/controlloop/design-impl/participants/participants.rst @@ -0,0 +1,39 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop-participants: + +Control Loop Participants +######################### + +A Participant is a component that acts as a bridge between the CLAMP COntrol Loop runtime and components such as +the Policy Framework, DCAE, or a Kubernetes cluster that are taking part in control loops. It listens +to DMaaP to receive messages from the CLAMP runtime and performs operations towards components that +are taking part in control loops. A participant has a Control Loop Element for each control loop in +which it is taking part. + +The implementation of a participant may use a common +:ref:`Participant Intermediary library `, which carries out common +message and state handling for Control Loop Elements in participants. The *ParticipantImpelementation* is the +component specific implementation of a participant, which is specifically developed for each component that +wishes to take part in control loops. + +.. image:: ../../images/participants/participants.png + +The figure above shows participants for various components that may take part in control loops. + +.. note:: The figure above is for illustration. Not all the participants mentioned above + have realizations in ONAP. Some of the participants in the figure above represent + a type of participant. For example, a controller participant would be written for + a specific controller such as CDS and a participant for an existing system would be + written towards that existing system. + +The detailed implementation of the CLAMP Participant ecosystem is described on the following pages: + +.. toctree:: + :maxdepth: 1 + + participant-intermediary + http-participant + k8s-participant + policy-framework-participant + participant-simulator diff --git a/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst b/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst new file mode 100644 index 00000000..746dd529 --- /dev/null +++ b/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _clamp-controlloop-policy-framework-participant: + +Policy Framework Participant +############################ + +To be completed. diff --git a/docs/clamp/controlloop/images/04-overview.png b/docs/clamp/controlloop/images/04-overview.png index 0f33d9c6..8f59bd15 100644 Binary files a/docs/clamp/controlloop/images/04-overview.png and b/docs/clamp/controlloop/images/04-overview.png differ diff --git a/docs/clamp/controlloop/images/participants/http-participant.png b/docs/clamp/controlloop/images/participants/http-participant.png new file mode 100644 index 00000000..39dfdc46 Binary files /dev/null and b/docs/clamp/controlloop/images/participants/http-participant.png differ diff --git a/docs/clamp/controlloop/images/participants/participants.png b/docs/clamp/controlloop/images/participants/participants.png new file mode 100644 index 00000000..77b0b840 Binary files /dev/null and b/docs/clamp/controlloop/images/participants/participants.png differ diff --git a/docs/clamp/controlloop/swagger/controlloop-comissioning.json b/docs/clamp/controlloop/swagger/controlloop-comissioning.json deleted file mode 100644 index 8fa09368..00000000 --- a/docs/clamp/controlloop/swagger/controlloop-comissioning.json +++ /dev/null @@ -1,473 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "Api Documentation", - "version": "1.0", - "title": "Api Documentation", - "termsOfService": "urn:tos", - "contact": {}, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "paths": { - "/onap/controlloop/v2/commission": { - "get": { - "tags": [ - "Clamp Control Loop Commissioning API" - ], - "summary": "Query details of the requested commissioned control loop definitions", - "description": "Queries details of the requested commissioned control loop definitions, returning all control loop details", - "operationId": "queryUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop definition name", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop definition version", - "required": false, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ToscaNodeTemplateRes", - "originalRef": "ToscaNodeTemplateRes" - } - } - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - }, - "post": { - "tags": [ - "Clamp Control Loop Commissioning API" - ], - "summary": "Commissions control loop definitions", - "description": "Commissions control loop definitions, returning the commissioned control loop definition IDs", - "operationId": "createUsingPOST", - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Entity Body of Control Loop", - "required": true, - "schema": { - "$ref": "#/definitions/ToscaServiceTemplateReq", - "originalRef": "ToscaServiceTemplateReq" - } - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CommissioningResponse", - "originalRef": "CommissioningResponse" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - }, - "delete": { - "tags": [ - "Clamp Control Loop Commissioning API" - ], - "summary": "Delete a commissioned control loop", - "description": "Deletes a Commissioned Control Loop, returning optional error details", - "operationId": "deleteUsingDELETE", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop definition name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop definition version", - "required": true, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CommissioningResponse", - "originalRef": "CommissioningResponse" - } - }, - "204": { - "description": "No Content" - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - }, - "/onap/controlloop/v2/commission/elements": { - "get": { - "tags": [ - "Clamp Control Loop Commissioning API" - ], - "summary": "Query details of the requested commissioned control loop element definitions", - "description": "Queries details of the requested commissioned control loop element definitions, returning all control loop elements' details", - "operationId": "queryElementsUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop definition name", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop definition version", - "required": false, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ToscaNodeTemplateRes", - "originalRef": "ToscaNodeTemplateRes" - } - } - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - } - } -} \ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/controlloop-instantiation.json b/docs/clamp/controlloop/swagger/controlloop-instantiation.json deleted file mode 100644 index 12542425..00000000 --- a/docs/clamp/controlloop/swagger/controlloop-instantiation.json +++ /dev/null @@ -1,584 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "Api Documentation", - "version": "1.0", - "title": "Api Documentation", - "termsOfService": "urn:tos", - "contact": {}, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "paths": { - "/onap/controlloop/v2/instantiation": { - "get": { - "tags": [ - "Clamp Control Loop Instantiation API" - ], - "summary": "Query details of the requested control loops", - "description": "Queries details of the requested control loops, returning all control loop details", - "operationId": "queryUsingGET_1", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop definition name", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop definition version", - "required": false, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ControlLoopsRes", - "originalRef": "ControlLoopsRes" - } - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - }, - "post": { - "tags": [ - "Clamp Control Loop Instantiation API" - ], - "summary": "Commissions control loop definitions", - "description": "Commissions control loop definitions, returning the control loop IDs", - "operationId": "createUsingPOST_1", - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "controlLoops", - "description": "Entity Body of Control Loop", - "required": true, - "schema": { - "$ref": "#/definitions/ControlLoopsReq", - "originalRef": "ControlLoopsReq" - } - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/InstantiationResponse", - "originalRef": "InstantiationResponse" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - }, - "put": { - "tags": [ - "Clamp Control Loop Instantiation API" - ], - "summary": "Updates control loop definitions", - "description": "Updates control loop definitions, returning the updated control loop definition IDs", - "operationId": "updateUsingPUT", - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "controlLoops", - "description": "Entity Body of Control Loop", - "required": true, - "schema": { - "$ref": "#/definitions/ControlLoopsReq", - "originalRef": "ControlLoopsReq" - } - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/InstantiationResponse", - "originalRef": "InstantiationResponse" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - }, - "delete": { - "tags": [ - "Clamp Control Loop Instantiation API" - ], - "summary": "Delete a control loop", - "description": "Deletes a control loop, returning optional error details", - "operationId": "deleteUsingDELETE_1", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop definition name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop definition version", - "required": false, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/InstantiationResponse", - "originalRef": "InstantiationResponse" - } - }, - "204": { - "description": "No Content" - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - }, - "/onap/controlloop/v2/instantiation/command": { - "put": { - "tags": [ - "Clamp Control Loop Instantiation API" - ], - "summary": "Issue a command to the requested control loops", - "description": "Issues a command to a control loop, ordering a state change on the control loop", - "operationId": "issueControlLoopCommandUsingPUT", - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "command", - "description": "Entity Body of control loop command", - "required": true, - "schema": { - "$ref": "#/definitions/InstantiationCommand", - "originalRef": "InstantiationCommand" - } - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/InstantiationResponse", - "originalRef": "InstantiationResponse" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - } - } -} \ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/controlloop-monitoring.json b/docs/clamp/controlloop/swagger/controlloop-monitoring.json deleted file mode 100644 index 84fbe7f0..00000000 --- a/docs/clamp/controlloop/swagger/controlloop-monitoring.json +++ /dev/null @@ -1,521 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "Api Documentation", - "version": "1.0", - "title": "Api Documentation", - "termsOfService": "urn:tos", - "contact": {}, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "paths": { - "/onap/controlloop/v2/monitoring/clelement": { - "get": { - "tags": [ - "Clamp Control Loop Monitoring API" - ], - "summary": "Query details of the requested cl element stats", - "description": "Queries details of the requested cl element stats, returning all clElement stats", - "operationId": "queryElementStatisticsUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "endTime", - "in": "query", - "description": "end time", - "required": false, - "type": "string" - }, - { - "name": "id", - "in": "query", - "description": "Control Loop element id", - "required": false, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "Participant name", - "required": true, - "type": "string" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count", - "required": false, - "type": "integer", - "default": 0, - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "start time", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Participant version", - "required": true, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClElementStatisticsList", - "originalRef": "ClElementStatisticsList" - } - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - }, - "/onap/controlloop/v2/monitoring/clelements/controlloop": { - "get": { - "tags": [ - "Clamp Control Loop Monitoring API" - ], - "summary": "Query details of the requested cl element stats in a control loop", - "description": "Queries details of the requested cl element stats, returning all clElement stats", - "operationId": "queryElementStatisticsPerControlLoopUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop version", - "required": true, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClElementStatisticsList", - "originalRef": "ClElementStatisticsList" - } - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - }, - "/onap/controlloop/v2/monitoring/participant": { - "get": { - "tags": [ - "Clamp Control Loop Monitoring API" - ], - "summary": "Query details of the requested participant stats", - "description": "Queries details of the requested participant stats, returning all participant stats", - "operationId": "queryParticipantStatisticsUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "endTime", - "in": "query", - "description": "end time", - "required": false, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "Control Loop participant name", - "required": false, - "type": "string" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count", - "required": false, - "type": "integer", - "default": 0, - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "start time", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop participant version", - "required": false, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ParticipantStatisticsList", - "originalRef": "ParticipantStatisticsList" - } - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - }, - "/onap/controlloop/v2/monitoring/participants/controlloop": { - "get": { - "tags": [ - "Clamp Control Loop Monitoring API" - ], - "summary": "Query details of all the participant stats in a control loop", - "description": "Queries details of the participant stats, returning all participant stats", - "operationId": "queryParticipantStatisticsPerControlLoopUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop version", - "required": true, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ParticipantStatisticsList", - "originalRef": "ParticipantStatisticsList" - } - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - } - } -} \ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/k8sparticipant.json b/docs/clamp/controlloop/swagger/k8sparticipant.json deleted file mode 100644 index ae06b06d..00000000 --- a/docs/clamp/controlloop/swagger/k8sparticipant.json +++ /dev/null @@ -1,392 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "Api Documentation", - "version": "1.0", - "title": "Api Documentation", - "termsOfService": "urn:tos", - "contact": {}, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "paths": { - "/onap/k8sparticipant/helm/chart/{name}/{version}": { - "delete": { - "tags": [ - "k8s-participant" - ], - "summary": "Delete the chart", - "operationId": "deleteChartUsingDELETE", - "produces": [ - "*/*" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - }, - "204": { - "description": "Chart Deleted" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/onap/k8sparticipant/helm/charts": { - "get": { - "tags": [ - "k8s-participant" - ], - "summary": "Return all Charts", - "operationId": "getAllChartsUsingGET", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "chart List", - "schema": { - "$ref": "#/definitions/ChartList", - "originalRef": "ChartList" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/onap/k8sparticipant/helm/install": { - "post": { - "tags": [ - "k8s-participant" - ], - "summary": "Install the chart", - "operationId": "installChartUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "info", - "description": "info", - "required": true, - "schema": { - "$ref": "#/definitions/InstallationInfo", - "originalRef": "InstallationInfo" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - }, - "201": { - "description": "chart Installed", - "schema": { - "type": "object" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/onap/k8sparticipant/helm/onboard/chart": { - "post": { - "tags": [ - "k8s-participant" - ], - "summary": "Onboard the Chart", - "operationId": "onboardChartUsingPOST", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "chart", - "in": "formData", - "required": false, - "type": "file" - }, - { - "name": "info", - "in": "formData", - "required": false, - "type": "string" - }, - { - "in": "body", - "name": "values", - "description": "values", - "required": false, - "schema": { - "type": "string", - "format": "binary" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "201": { - "description": "Chart Onboarded", - "schema": { - "type": "string" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/onap/k8sparticipant/helm/repo": { - "post": { - "tags": [ - "k8s-participant" - ], - "summary": "Configure helm repository", - "operationId": "configureRepoUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "repo", - "description": "repo", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - }, - "201": { - "description": "Repository added", - "schema": { - "type": "object" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/onap/k8sparticipant/helm/uninstall/{name}/{version}": { - "delete": { - "tags": [ - "k8s-participant" - ], - "summary": "Uninstall the Chart", - "operationId": "uninstallChartUsingDELETE", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - }, - "201": { - "description": "chart Uninstalled", - "schema": { - "type": "object" - } - }, - "204": { - "description": "No Content" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - } - } - } - }, - "definitions": { - "ChartInfo": { - "type": "object", - "properties": { - "chartId": { - "$ref": "#/definitions/ToscaConceptIdentifier", - "originalRef": "ToscaConceptIdentifier" - }, - "namespace": { - "type": "string" - }, - "overrideParams": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "releaseName": { - "type": "string" - }, - "repository": { - "$ref": "#/definitions/HelmRepository", - "originalRef": "HelmRepository" - } - }, - "title": "ChartInfo" - }, - "ChartList": { - "type": "object", - "properties": { - "charts": { - "type": "array", - "items": { - "$ref": "#/definitions/ChartInfo", - "originalRef": "ChartInfo" - } - } - }, - "title": "ChartList" - }, - "HelmRepository": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "password": { - "type": "string" - }, - "port": { - "type": "string" - }, - "protocol": { - "type": "string" - }, - "repoName": { - "type": "string" - }, - "userName": { - "type": "string" - } - }, - "title": "HelmRepository" - }, - "InstallationInfo": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - }, - "title": "InstallationInfo" - }, - "ToscaConceptIdentifier": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - }, - "title": "ToscaConceptIdentifier" - } - } -} \ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/participant-sim.json b/docs/clamp/controlloop/swagger/participant-sim.json deleted file mode 100644 index 79fc3011..00000000 --- a/docs/clamp/controlloop/swagger/participant-sim.json +++ /dev/null @@ -1,478 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "Api Documentation", - "version": "1.0", - "title": "Api Documentation", - "termsOfService": "urn:tos", - "contact": {}, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "paths": { - "/onap/participantsim/v2/elements": { - "put": { - "tags": [ - "Clamp Control Loop Participant Simulator API" - ], - "summary": "Updates simulated control loop elements", - "description": "Updates simulated control loop elements, returning the updated control loop definition IDs", - "operationId": "updateUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Body of a control loop element", - "required": true, - "schema": { - "$ref": "#/definitions/ControlLoopElementReq", - "originalRef": "ControlLoopElementReq" - } - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TypedSimpleResponse«ControlLoopElement»", - "originalRef": "TypedSimpleResponse«ControlLoopElement»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - }, - "/onap/participantsim/v2/elements/{name}/{version}": { - "get": { - "tags": [ - "Clamp Control Loop Participant Simulator API" - ], - "summary": "Query details of the requested simulated control loop elements", - "description": "Queries details of the requested simulated control loop elements, returning all control loop element details", - "operationId": "elementsUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Control loop element name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "path", - "description": "Control loop element version", - "required": true, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ControlLoopElementRes", - "originalRef": "ControlLoopElementRes" - } - } - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - }, - "/onap/participantsim/v2/participants": { - "put": { - "tags": [ - "Clamp Control Loop Participant Simulator API" - ], - "summary": "Updates simulated participants", - "description": "Updates simulated participants, returning the updated control loop definition IDs", - "operationId": "updateUsingPUT_1", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Body of a participant", - "required": true, - "schema": { - "$ref": "#/definitions/ParticipantReq", - "originalRef": "ParticipantReq" - } - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TypedSimpleResponse«Participant»", - "originalRef": "TypedSimpleResponse«Participant»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - }, - "/onap/participantsim/v2/participants/{name}/{version}": { - "get": { - "tags": [ - "Clamp Control Loop Participant Simulator API" - ], - "summary": "Query details of the requested simulated participants", - "description": "Queries details of the requested simulated participants, returning all participant details", - "operationId": "participantsUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Participant name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "path", - "description": "Participant version", - "required": true, - "type": "string" - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantRes", - "originalRef": "ParticipantRes" - } - } - }, - "401": { - "description": "Authentication Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "403": { - "description": "Authorization Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - }, - "404": { - "description": "Not Found" - }, - "500": { - "description": "Internal Server Error", - "headers": { - "X-LatestVersion": { - "type": "string" - }, - "X-PatchVersion": { - "type": "string" - }, - "X-MinorVersion": { - "type": "string" - }, - "X-ONAP-RequestID": { - "type": "string", - "format": "uuid" - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "x-interface info": { - "api-version": "1.0.0", - "last-mod-release": "Dublin" - } - } - } - } -} \ No newline at end of file diff --git a/docs/clamp/controlloop/system-level-dialogues.rst b/docs/clamp/controlloop/system-level-dialogues.rst deleted file mode 100644 index 4392e1e8..00000000 --- a/docs/clamp/controlloop/system-level-dialogues.rst +++ /dev/null @@ -1,198 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _system-level-label: - -System Level Dialogues -###################### - - -.. contents:: - :depth: 4 - - -The CLAMP Control Loop Runtime Lifecycle Management uses the following system level dialogues. -These dialogues enable the CLAMP runtime capabilities described in :ref:`Section 2 of -TOSCA Defined Control Loops: Architecture and Design `. -Design Time dialogues will be described in future releases of the system. - - -1 Commissioning Dialogues -========================= - -Commissioning dialogues are used to commission and decommission Control Loop Type definitions -and to set the values of Common Parameters. - -Commissioning a Control Loop Type is a three-step process: - -#. The Control Loop Type must be created, that is the Control Loop Type definition must be - loaded and stored in the database. This step may be carried out over the REST interface or - using SDC distribution. - -#. The Common Properties of the Control Loop type must be assigned values and those values - must be stored in the database. This step is optional only if all mandatory common properties - have default values. The Common Property values may be set and amended over and over again - in multiple sessions until the Control Loop Type is primed. - -#. The Control Loop Type Definition and the Common Property values must be primed, that is - sent to the concerned participants. Once a Control Loop Type is primed, its Common Property - values can no longer be changed. To change Common Properties on a primed Control Loop Type, - all instances of the Control Loop Type must be removed and the Control Loop Type must be - de-primed. - -1.1 Commissioning a Control Loop Type Definition using the CLAMP GUI --------------------------------------------------------------------- - -This dialogue corresponds to a "File → Import" menu on the CLAMP GUI. The documentation of -future releases of the system will describe how the Design Time functionality interacts -with the Runtime commissioning API. - -.. image:: images/system-dialogues/comissioning-clamp-gui.png - -1.2 Commissioning a Control Loop Type Definition using SDC ----------------------------------------------------------- - -.. image:: images/system-dialogues/comissioning-sdc.png - -1.3 Setting Common Properties for a Control Loop Type Definition ----------------------------------------------------------------- - -This dialogue sets the values of common properties. The values of the common properties -may be set, updated, or deleted at will, as this dialogue saves the properties to the -database but does not send the definitions or properties to the participants. However, -once a Control Loop Type Definition and its properties are primed (See :ref:`Section 1.4 -<_priming-cl-label>`), the properties cannot be changed until the control loop type -definition is de-primed (See :ref:`Section 1.5 `). - -.. image:: images/system-dialogues/common-properties-type-definition.png - -.. _priming-cl-label: - -1.4 Priming a Control Loop Type Definition on Participants ----------------------------------------------------------- -The Priming operation sends Control Loop Type definitions and common property values -to participants. Once a Control Loop Type definition is primed, its property values -can on longer be changed until it is de-primed. - -.. image:: images/system-dialogues/priming-cl-type-definition.png - -.. _depriming-cl-label: - -1.5 De-Prime a Control Loop Type Definition on Participants ------------------------------------------------------------ - -This dialogue allows a Control Loop Type Definition to be de-primed so that it can be -deleted or its common parameter values can be altered. - -.. image:: images/system-dialogues/depriming-cl-type-definition.png - -1.6 Decommissioning a Control Loop Type Definition in CLAMP ------------------------------------------------------------ - -.. image:: images/system-dialogues/decommission-cl-type-definition.png - -1.7 Reading Commissioned Control Loop Type Definitions ------------------------------------------------------- - -.. image:: images/system-dialogues/read-commision-cl-type-definition.png - - -2. Instantiation Dialogues -========================== - -Instantiation dialogues are used to create, set parameters on, instantiate, update, -and remove Control Loop instances. - -Assume a suitable Control Loop Definition exists in the Commissioned Control Loop Inventory. -To get a Control Loop instance running one would, for example, execute dialogues -:ref:`2.1 `, :ref:`2.3 `, and -:ref:`2.4 `. - -.. _creating-cl-instance: - -2.1 Creating a Control Loop Instance ------------------------------------- - -.. image:: images/system-dialogues/create-cl-instance.png - -.. note:: - This dialogue creates the Control Loop Instance in the Instantiated Control Loop Inventory. - The instance is sent to the participants using the process described in the dialogue in - :ref:`Section 2.3 `. - -2.2 Updating Instance Specific Parameters on a Control Loop Instance --------------------------------------------------------------------- - -.. image:: images/system-dialogues/update-instance-params-cl.png - -.. _updating-cl-instance-config: - -2.3 Updating a Control Loop Instance with a Configuration on Participants -------------------------------------------------------------------------- - -.. image:: images/system-dialogues/update-cl-instance-config-participants.png - -.. _changing-cl-instance-state: - -2.4 Changing the state of a Control Loop Instance on Participants ------------------------------------------------------------------ - -.. image:: images/system-dialogues/change-cl-instance-state-participants.png - -2.5 De-instantiating a Control Loop Instance from Participants --------------------------------------------------------------- - -.. image:: images/system-dialogues/deinstantiate-cl-from-participants.png - -2.6 Deleting a Control Loop Instance ------------------------------------- - -.. image:: images/system-dialogues/delete-cl-instance.png - -2.7 Reading Control Loop Instances ----------------------------------- - -.. image:: images/system-dialogues/read-cl-instance.png - - -1. Monitoring Dialogues -======================= - -Monitoring dialogues are used to monitor and to read statistics on Control Loop Instances. - -3.1 Reporting of Monitoring Information and Statistics by Participants ----------------------------------------------------------------------- - -.. image:: images/system-dialogues/monitoring-by-participants.png - -3.2 Viewing of Monitoring Information -------------------------------------- - -.. image:: images/system-dialogues/view-monitoring-info.png - -3.2 Viewing of Statistics -------------------------- - -.. image:: images/system-dialogues/view-statistics.png - -3.3 Statistics Housekeeping ---------------------------- - -.. image:: images/system-dialogues/statistics-housekeeping.png - - -4. Supervision Dialogues -======================== - -Supervision dialogues are used to check the state of Control Loop Instances and Participants. - -4.1 Supervise Participants --------------------------- - -.. image:: images/system-dialogues/supervise-participants.png - -4.2 Supervise Control Loops ---------------------------- - -.. image:: images/system-dialogues/supervise-controlloops.png - -End of Document -- cgit 1.2.3-korg