diff options
| author |   adheli.tavares <adheli.tavares@est.tech> | 2022-03-31 10:31:36 +0100 |
|---|---|---|
| committer | adheli.tavares <adheli.tavares@est.tech> | 2022-03-31 10:32:07 +0100 |
| commit | 96f544440333fb59fcc45fb9f53346e2320bc9bb (patch) | |
| tree | 32584ae289aeb76dd416d8c7299af61a0e57e00d /docs/clamp/controlloop | |
| parent | 178dea1eb3eb979994d8b99f317f536b85435b60 (diff) | |
Reestructuring the clamp doc tree
Issue-ID: POLICY-3941
Change-Id: I116742a732789a2737a00250849914aa30ad2fbf
Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
Diffstat (limited to 'docs/clamp/controlloop')
75 files changed, 0 insertions, 6590 deletions
diff --git a/docs/clamp/controlloop/api-protocol/api-protocol.rst b/docs/clamp/controlloop/api-protocol/api-protocol.rst deleted file mode 100644 index 2d509921..00000000 --- a/docs/clamp/controlloop/api-protocol/api-protocol.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. 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 deleted file mode 100644 index 2fa5336f..00000000 --- a/docs/clamp/controlloop/api-protocol/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 <management-cl-instance-configs>`. - -.. 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 -<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/ControlLoopTOSCAServiceTemplateTypes.yaml>`_ -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 -<https://github.com/onap/policy-clamp/tree/master/models/src/main/java/org/onap/policy/clamp/controlloop/models/messages/dmaap/participant>`_ -. 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 <String, String> 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 <String, String> 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 deleted file mode 100644 index cef2c2fb..00000000 --- a/docs/clamp/controlloop/api-protocol/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 <swagger/controlloop-comissioning.json>` - -.. 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 <management-cl-instance-configs>`. - -:download:`Download Policy Control Loop Instantiation API Swagger <swagger/controlloop-instantiation.json>` - -.. 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 <controlloop-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 -<management-cl-instance-configs>`. 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 <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 <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 <swagger/controlloop-monitoring.json>` - -.. 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 <swagger/k8sparticipant.json>` - -.. 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 <swagger/participant-sim.json>` - -.. 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 deleted file mode 100644 index 8fa09368..00000000 --- a/docs/clamp/controlloop/api-protocol/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/api-protocol/swagger/controlloop-instantiation.json b/docs/clamp/controlloop/api-protocol/swagger/controlloop-instantiation.json deleted file mode 100644 index 12542425..00000000 --- a/docs/clamp/controlloop/api-protocol/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/api-protocol/swagger/controlloop-monitoring.json b/docs/clamp/controlloop/api-protocol/swagger/controlloop-monitoring.json deleted file mode 100644 index 84fbe7f0..00000000 --- a/docs/clamp/controlloop/api-protocol/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/api-protocol/swagger/k8sparticipant.json b/docs/clamp/controlloop/api-protocol/swagger/k8sparticipant.json deleted file mode 100644 index ae06b06d..00000000 --- a/docs/clamp/controlloop/api-protocol/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/api-protocol/swagger/participant-sim.json b/docs/clamp/controlloop/api-protocol/swagger/participant-sim.json deleted file mode 100644 index 79fc3011..00000000 --- a/docs/clamp/controlloop/api-protocol/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/api-protocol/system-level-dialogues.rst b/docs/clamp/controlloop/api-protocol/system-level-dialogues.rst deleted file mode 100644 index 676ffc9b..00000000 --- a/docs/clamp/controlloop/api-protocol/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 <controlloop-capabilities>`. -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 <depriming-cl-label>`). - -.. 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 <creating-cl-instance>`, :ref:`2.3 <updating-cl-instance-config>`, and -:ref:`2.4 <changing-cl-instance-state>`. - -.. _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 <updating-cl-instance-config>`. - -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 deleted file mode 100644 index c5977ee4..00000000 --- a/docs/clamp/controlloop/controlloop-architecture.rst +++ /dev/null @@ -1,468 +0,0 @@ -.. 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 <files/ControlLoops.pdf>` 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 <http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/>`_. 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 <system-level-label>` 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 -<https://docs.onap.org/projects/onap-cps/en/latest/overview.html>`_ -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 -<https://wiki.onap.org/pages/viewpage.action?pageId=103417456>`_ -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 <https://konghq.com/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 <system-level-label>` -#. :ref:`The CLAMP Control Loop Participant Protocol <controlloop-participant-protocol-label>` -#. :ref:`REST APIs for CLAMP Control Loops <controlloop-rest-apis-label>` - - -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 <clamp-controlloop-runtime>` -#. :ref:`CLAMP Control Loop Participants <clamp-controlloop-participants>` -#. :ref:`Managing Control Loops using The CLAMP GUI <clamp-gui-controlloop>` - -End of Document diff --git a/docs/clamp/controlloop/controlloop.rst b/docs/clamp/controlloop/controlloop.rst deleted file mode 100644 index 51aa7ec1..00000000 --- a/docs/clamp/controlloop/controlloop.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _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. - -.. toctree:: - :maxdepth: 2 - - 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 deleted file mode 100644 index 92564c6f..00000000 --- a/docs/clamp/controlloop/defining-controlloops.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _defining-controlloops-label: - -Defining Control Loops in TOSCA for CLAMP -######################################### - - -.. contents:: - :depth: 4 - - -A Control Loop Type is defined in a TOSCA service template. A TOSCA Service Template has -two parts: a definition part in the service template itself, which contains the definitions -of concepts that can be used to define the types of concepts that can appear on a Toplogy -Template and a Topology Template that defines a topology. See the `Oasis Open TOSCA -<https://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.3/>`_ web page -for more details on TOSCA. - -Unsurprisingly, to define a Control Loop Type in TOSCA, of Control Loop related concepts -that we can use in all control loops exist. They are described in Section 1. Section 2 -describes how properties are managed. Properties are the configuration parameters that are -provided to Control Loops and the Control Loop Elements they use. Section 3 describes how to -define a Control Loop using the predefined Control Loop concepts. - - -1 Standard TOSCA Service Template Concepts for Control Loops -============================================================ - -These concepts are the base concepts available to users who write definitions for control -loops in TOSCA. TOSCA control loop definitions are written using these concepts. - -1.1 Fundamental TOSCA Concepts for Control Loops ------------------------------------------------- - -The following TOSCA concepts are the fundamental concepts in a TOSCA Service Template for -defining control loops. - -.. image:: images/defining-controlloops/fundamental-concepts.png - -The TOSCA concepts above may be declared in the TOSCA Service Template of a control loop. -If the concepts already exist in the Design Time Catalogue or the Runtime Inventory, they -may be omitted from a TOSCA service template that defines a control loop type. - -The *start_phase* is a value indicating the start phase in which this control loop element -will be started, the first start phase is zero. Control Loop Elements are started in their -start_phase order and stopped in reverse start phase order. Control Loop Elements with the -same start phase are started and stopped simultaneously. - -The Yaml file that holds the Definition of `TOSCA fundamental Control Loop Types is available in Github -<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/ControlLoopTOSCAServiceTemplateTypes.yaml>`_ -and is the canonical definition of the Control Loop concepts. - -1.2 TOSCA Concepts for Control Loop Elements delivered by ONAP --------------------------------------------------------------- - -TOSCA Standard Control Loop Elements - -.. image:: images/defining-controlloops/standard-cle.png - :width: 600 - -1.2.1 Policy Control Loop Element -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Policy Participant runs Policy Control Loop Elements. Each Policy Control Loop Element -manages the deployment of the policy specified in the Policy Control Loop Element definition. -The Yaml file that holds the `Policy Control Loop Element Type definition is available in Github -<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/PolicyControlLoopElementType.yaml>`_ -and is the canonical definition of the Policy Control Loop Element type. For a description of -the Policy Control Loop Element and Policy Participant, please see `The CLAMP Policy Framework -Participant <#>`_ page. - -1.2.2 HTTP Control Loop Element -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The HTTP Participant runs HTTP Control Loop Elements. Each HTTP Control Loop Element manages -REST communication towards a REST endpoint using the REST calls a user has specified in the -configuration of the HTTP Control Loop Element. The Yaml file that holds the -`HTTP Control Loop Element Type definition is available in Github -<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/HttpControlLoopElementType.yaml>`_ -and is the canonical definition of the HTTP Control Loop Element type. For a description of -the HTTP Control Loop Element and HTTP Participant, please see `The CLAMP HTTP Participant <#>`_ page. - -.. _kubernetes-cl-element: - -1.2.3 Kubernetes Control Loop Element -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Kubernetes Participant runs Kubernetes Control Loop Elements. Each Kubernetes Control Loop -Element manages a Kubernetes microservice using Helm. The user defines the Helm chart for the -Kubernetes microservice as well as other properties that the microservice requires in order to -execute. The Yaml file that holds the -`Kubernetes Control Loop Element Type defintion is available in Github -<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/KubernetesControlLoopElementType.yaml>`_ -and is the canonical definition of the Kubernetes Control Loop Element type. For a description -of the Kubernetes Control Loop Element and Kubernetes Participant,please see -`The CLAMP Kubernetes Participant <#>`_ page. - - -2 Common and Instance Specific Properties -========================================= - -Properties are used to define the configuration for Control Loops and Control Loop Elements. -At design time, the types, constraints, and descriptions of the properties are specified. -The values for properties are specified in the CLAMP GUI at runtime. TOSCA provides support -for defining properties, see `Section 3.6.10: TOSCA Property Definition -<https://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.3/os/TOSCA-Simple-Profile-YAML-v1.3-os.html#DEFN_ELEMENT_PROPERTY_DEFN>`_ -in the TOSCA documentation. - -2.1 Terminology for Properties ------------------------------- - -**Property:** Metadata defined in TOSCA that is associated with a Control Loop, a Control -Loop Element, or a Participant. - -**TOSCA Property Type:** The TOSCA definition of the type of a property. A property can have -a generic type such as string or integer or can have a user defined TOSCA data type. - -**TOSCA Property Value:** The value of a Property Type. Property values are assigned at run -time in CLAMP. - -**Common Property Type:** Property Types that apply to all instances of a Control Loop Type. - -**Common Property Value:** The value of a Property Type. It is assigned at run time once for -all instances of a Control Loop Type. - -**Instance Specific Property Type:** Property Types that apply to an individual instance of -a Control Loop Type. - -**Instance Specific Property Value:** The value of a Property Type that applies to an -individual instance of a Control Loop Type. The value is assigned at run time for each -control loop instance. - -Control Loop Properties can be *common* or *instance specific*. See Section 2 of -:ref:`TOSCA Defined Control Loops: Architecture and Design <controlloop-capabilities>` -for a detailed description of the usage of common and instance specific properties. - -2.2 Common Properties ---------------------- - -Common properties apply to all instances of a control loop. Common properties are identified -by a special metadata flag in Control Loop and Control Loop Element definitions. For example, -the startPhase parameter on any Control Loop Element has the same value for any instance of -that control loop element, so it is defined as shown below in the -`Definition of TOSCA fundamental Control Loop Types -<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/ControlLoopTOSCAServiceTemplateTypes.yaml>`_ -yaml file. - -.. code-block:: yaml - - startPhase: - type: integer - required: false - constraints: - - greater-or-equal: 0 - description: A value indicating the start phase in which this control loop element will be started, the - first start phase is zero. Control Loop Elements are started in their start_phase order and stopped - in reverse start phase order. Control Loop Elements with the same start phase are started and - stopped simultaneously - metadata: - common: true - -The "common: true" value in the metadata of the startPhase property identifies that property -as being a common property. This property will be set on the CLAMP GUI during control loop -commissioning. - -2.3 Instance Specific Properties --------------------------------- - -Instance Specific properties apply to individual instances of a Control Loop and/or Control -Loop Element and must be set individually for Control Loop and Control Loop Element instance. -Properties are instance specific by default, but can be identified by a special metadata flag -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. - - -.. code-block:: yaml - - # Definition that omits the common flag metadata - chart: - type: org.onap.datatypes.policy.clamp.controlloop.kubernetesControlLoopElement.Chart - typeVersion: 1.0.0 - description: The helm chart for the microservice - required: true - - # Definition that specifies the common flag metadata - chart: - type: org.onap.datatypes.policy.clamp.controlloop.kubernetesControlLoopElement.Chart - typeVersion: 1.0.0 - description: The helm chart for the microservice - required: true - metadata: - common: false - -The "common: false" value in the metadata of the chart property identifies that property as -being an instance specific property. This property will be set on the CLAMP GUI during control -loop instantiation. - - -3 Writing a Control Loop Type Definition -========================================= - -The TOSCA definition of a control loop contains a TOSCA Node Template for the control loop -itself, which contains TOSCA Node Templates for each Control Loop Element that makes up the -Control Loop. - -.. image:: images/defining-controlloops/controlloop-node-template.png - :width: 600 - -To create a control loop, a user creates a TOSCA Topology Template. In the Topology Template, -the user creates a TOSCA Node Template for each Control Loop Element that will be in the -Control Loop Definition. Finally, the user creates the Node Template that defines the Control -Loop itself, and references the Control Loop Element definitions that make up the Control Loop -Definition. - -3.1 The Gentle Guidance Control Loop ------------------------------------- - -The best way to explain how to create a Control Loop Definition is by example. - -.. image:: images/defining-controlloops/gentle-guidance-controlloop.png - -The example Gentle Guidance control loop is illustrated in the diagram above. The domain logic for the control loop is -implemented in a microservice running in Kubernetes, a policy, and some configuration that is passed to the microservice -over a REST endpoint. We want to manage the life cycle of the domain logic for our Gentle Guidance control loop using -our TOSCA based Control Loop Life Cycle Management approach. To do this we create four Control Loop Element definitions, -one for the Kubernetes microservice, one for the policy and one or the REST configuration. - -3.2 The TOSCA Control Loop Definition -------------------------------------- - -We use a TOSCA Topology Template to specify a Control Loop definition and the definitions of -its Control Loop Elements. Optionally, we can specify default parameter values in the TOSCA -Topology Template. The actual values of Control Loop common and instance specific parameters -are set at run time in the CLAMP GUI. - -In the case of the Gentle Guidance control loop, we define a Control Loop Element Node Template -for each part of the domain logic we are managing. We then define the Control Loop Node Template -for the control loop itself. - -Please refer to the `No Properties yaml file in Github -<https://github.com/onap/policy-clamp/blob/master/common/src/test/resources/gentleguidance/GentleGuidanceNoPropeties.yaml>`_ -for the definitive Yaml specification for the TOSCA Topology Template for the Gentle Guidance -domain when no parameters are defined. - -Please refer to the `Default Properties yaml file in Github -<https://github.com/onap/policy-clamp/blob/master/common/src/test/resources/gentleguidance/GentleGuidanceDefaultPropeties.yaml>`_ -for the definitive Yaml specification for the TOSCA Topology Template for the Gentle Guidance -domain when the default values of parameters are defined. - - -4 Creating Custom Control Loop Elements -======================================== - -Any organization can include their own component in the framework and use the framework and have -the Policy Framework CLAMP manage the lifecycle of domain logic in their component as part of a -Control Loop. To do this, a participant for the component must be developed that allows Control -Loop Elements for that component to be run. To develop a participant, the participant must comply -with the `CLAMP Participants <#>`_ -framework and in particular comply with `The CLAMP Control Loop Participant Protocol <#>`_. -The organization must also specify a new Control Loop Element type definition in TOSCA similar to -those supplied in ONAP and described in Section 1.2. This Control Loop Element type tells the -CLAMP Control Loop Lifecycle management that the Control Loop Element exists and can be included -in control loops. It also specifies the properties that can be specified for the Control Loop Element. - -An organization can supply the code for the Participant (for example as a Java jar file) and a -TOSCA artifact with the Control Loop Element definition and it can be added to the platform. In -future releases, support will be provided to include participants and their Control Loop Element -definitions as packaged plugins that can be installed on the platform. - -End of document diff --git a/docs/clamp/controlloop/design-impl/clamp-controlloop-runtime.rst b/docs/clamp/controlloop/design-impl/clamp-controlloop-runtime.rst deleted file mode 100644 index 0077b3de..00000000 --- a/docs/clamp/controlloop/design-impl/clamp-controlloop-runtime.rst +++ /dev/null @@ -1,254 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _clamp-controlloop-runtime: - -The CLAMP Control Loop Runtime -############################## - -.. contents:: - :depth: 3 - - -This article explains how CLAMP Control Loop Runtime is implemented. - -Terminology -*********** -- Broadcast message: a message for all participants (participantId=null and participantType=null) -- Message to a participant: a message only for a participant (participantId and participantType properly filled) -- ThreadPoolExecutor: ThreadPoolExecutor executes the given task, into SupervisionAspect class is configured to execute tasks in ordered manner, one by one -- Spring Scheduling: into SupervisionAspect class, the @Scheduled annotation invokes "schedule()" method every "runtime.participantParameters.heartBeatMs" milliseconds with a fixed delay -- MessageIntercept: "@MessageIntercept" annotation is used into SupervisionHandler class to intercept "handleParticipantMessage" method calls using spring aspect oriented programming -- GUI: graphical user interface, Postman or a Front-End Application - -Design of Rest Api -****************** - -Create of a Control Loop Type -+++++++++++++++++++++++++++++ -- GUI calls POST "/commission" endpoint with a Control Loop Type Definition (Tosca Service Template) as body -- CL-runtime receives the call by Rest-Api (CommissioningController) -- It saves to DB the Tosca Service Template using PolicyModelsProvider -- if there are participants registered, it triggers the execution to send a broadcast PARTICIPANT_UPDATE message -- the message is built by ParticipantUpdatePublisher using Tosca Service Template data (to fill the list of ParticipantDefinition) - -Delete of a Control Loop Type -+++++++++++++++++++++++++++++ -- GUI calls DELETE "/commission" endpoint -- CL-runtime receives the call by Rest-Api (CommissioningController) -- if there are participants registered, CL-runtime triggers the execution to send a broadcast PARTICIPANT_UPDATE message -- the message is built by ParticipantUpdatePublisher with an empty list of ParticipantDefinition -- It deletes the Control Loop Type from DB - -Create of a Control Loop -++++++++++++++++++++++++ -- GUI calls POST "/instantiation" endpoint with a Control Loop as body -- CL-runtime receives the call by Rest-Api (InstantiationController) -- It validates the Control Loop -- It saves the Control Loop to DB -- Design of an update of a Control Loop -- GUI calls PUT "/instantiation" endpoint with a Control Loop as body -- CL-runtime receives the call by Rest-Api (InstantiationController) -- It validates the Control Loop -- It saves the Control Loop to DB - -Delete of a Control Loop -++++++++++++++++++++++++ -- GUI calls DELETE "/instantiation" endpoint -- CL-runtime receives the call by Rest-Api (InstantiationController) -- It checks that Control Loop is in UNINITIALISED status -- It deletes the Control Loop from DB - -"issues control loop commands to control loops" -+++++++++++++++++++++++++++++++++++++++++++++++ - -case **UNINITIALISED to PASSIVE** - -- GUI calls "/instantiation/command" endpoint with PASSIVE as orderedState -- CL-runtime checks if participants registered are matching with the list of control Loop Element -- It updates control loop and control loop elements to DB (orderedState = PASSIVE) -- It validates the status order issued -- It triggers the execution to send a broadcast CONTROL_LOOP_UPDATE message -- the message is built by ControlLoopUpdatePublisher using Tosca Service Template data and ControlLoop data. (with startPhase = 0) -- It updates control loop and control loop elements to DB (state = UNINITIALISED2PASSIVE) - -case **PASSIVE to UNINITIALISED** - -- GUI calls "/instantiation/command" endpoint with UNINITIALISED as orderedState -- CL-runtime checks if participants registered are matching with the list of control Loop Element -- It updates control loop and control loop elements to DB (orderedState = UNINITIALISED) -- It validates the status order issued -- It triggers the execution to send a broadcast CONTROL_LOOP_STATE_CHANGE message -- the message is built by ControlLoopStateChangePublisher with controlLoopId -- It updates control loop and control loop elements to DB (state = PASSIVE2UNINITIALISED) - -case **PASSIVE to RUNNING** - -- GUI calls "/instantiation/command" endpoint with RUNNING as orderedState -- CL-runtime checks if participants registered are matching with the list of control Loop Element. -- It updates control loop and control loop elements to DB (orderedState = RUNNING) -- It validates the status order issued -- It triggers the execution to send a broadcast CONTROL_LOOP_STATE_CHANGE message -- the message is built by ControlLoopStateChangePublisher with controlLoopId -- It updates control loop and control loop elements to DB (state = PASSIVE2RUNNING) - -case **RUNNING to PASSIVE** - -- GUI calls "/instantiation/command" endpoint with UNINITIALISED as orderedState -- CL-runtime checks if participants registered are matching with the list of control Loop Element -- It updates control loop and control loop elements to db (orderedState = RUNNING) -- It validates the status order issued -- It triggers the execution to send a broadcast CONTROL_LOOP_STATE_CHANGE message -- the message is built by ControlLoopStateChangePublisher with controlLoopId -- It updates control loop and control loop elements to db (state = RUNNING2PASSIVE) - -StartPhase -********** -The startPhase is particularly important in control loop update and 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. - -How to define StartPhase -++++++++++++++++++++++++ -StartPhase is defined as shown below in the Definition of TOSCA fundamental Control Loop Types yaml file. - -.. code-block:: YAML - - startPhase: - type: integer - required: false - constraints: - - greater-or-equal: 0 - description: A value indicating the start phase in which this control loop element will be started, the - first start phase is zero. Control Loop Elements are started in their start_phase order and stopped - in reverse start phase order. Control Loop Elements with the same start phase are started and - stopped simultaneously - metadata: - common: true - -The "common: true" value in the metadata of the startPhase property identifies that property as being a common property. -This property will be set on the CLAMP GUI during control loop commissioning. -Example where it could be used: - -.. code-block:: YAML - - org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement: - # Consul http config for PMSH. - version: 1.2.3 - type: org.onap.policy.clamp.controlloop.HttpControlLoopElement - type_version: 1.0.1 - description: Control loop element for the http requests of PMSH microservice - properties: - provider: ONAP - participant_id: - name: HttpParticipant0 - version: 1.0.0 - participantType: - name: org.onap.k8s.controlloop.HttpControlLoopParticipant - version: 2.3.4 - uninitializedToPassiveTimeout: 180 - startPhase: 1 - -How StartPhase works -++++++++++++++++++++ -In state changes from UNITITIALISED → PASSIVE, control loop elements are started in increasing order of their startPhase. - -Example with Http_PMSHMicroserviceControlLoopElement with startPhase to 1 and PMSH_K8SMicroserviceControlLoopElement with startPhase to 0 - -- CL-runtime sends a broadcast CONTROL_LOOP_UPDATE message to all participants with startPhase = 0 -- participant receives the CONTROL_LOOP_UPDATE message and runs to PASSIVE state (only CL elements defined as startPhase = 0) -- CL-runtime receives CONTROL_LOOP_UPDATE_ACT messages from participants and set the state (from the CL element of the message) to PASSIVE -- CL-runtime calculates that all CL elements with startPhase = 0 are set to proper state and sends a broadcast CONTROL_LOOP_UPDATE message with startPhase = 1 -- participant receives the CONTROL_LOOP_UPDATE message and runs to PASSIVE state (only CL elements defined as startPhase = 1) -- CL-runtime calculates that all CL elements are set to proper state and set CL to PASSIVE - -In that scenario the message CONTROL_LOOP_UPDATE has been sent two times. - -Design of managing messages -*************************** - -PARTICIPANT_REGISTER -++++++++++++++++++++ -- A participant starts and send a PARTICIPANT_REGISTER message -- ParticipantRegisterListener collects the message from DMaap -- if not present, it saves participant reference with status UNKNOWN to DB -- if is present a Control Loop Type, it triggers the execution to send a PARTICIPANT_UPDATE message to the participant registered (message of Priming) -- the message is built by ParticipantUpdatePublisher using Tosca Service Template data (to fill the list of ParticipantDefinition) -- It triggers the execution to send a PARTICIPANT_REGISTER_ACK message to the participant registered -- MessageIntercept intercepts that event, if PARTICIPANT_UPDATE message has been sent, it will be add a task to handle PARTICIPANT_REGISTER in SupervisionScanner -- SupervisionScanner starts the monitoring for participantUpdate - -PARTICIPANT_UPDATE_ACK -++++++++++++++++++++++ -- A participant sends PARTICIPANT_UPDATE_ACK message in response to a PARTICIPANT_UPDATE message -- ParticipantUpdateAckListener collects the message from DMaap -- MessageIntercept intercepts that event and adds a task to handle PARTICIPANT_UPDATE_ACK in SupervisionScanner -- SupervisionScanner removes the monitoring for participantUpdate -- It updates the status of the participant to DB - -PARTICIPANT_STATUS -++++++++++++++++++ -- A participant sends a scheduled PARTICIPANT_STATUS message -- ParticipantStatusListener collects the message from DMaap -- MessageIntercept intercepts that event and adds a task to handle PARTICIPANT_STATUS in SupervisionScanner -- SupervisionScanner clears and starts the monitoring for participantStatus - -CONTROLLOOP_UPDATE_ACK -++++++++++++++++++++++ -- A participant sends CONTROLLOOP_UPDATE_ACK message in response to a CONTROLLOOP_UPDATE message. It will send a CONTROLLOOP_UPDATE_ACK - for each CL-elements moved to the ordered state as indicated by the CONTROLLOOP_UPDATE -- ControlLoopUpdateAckListener collects the message from DMaap -- It checks the status of all control loop elements and checks if the control loop is primed -- It updates the CL to DB if it is changed -- MessageIntercept intercepts that event and adds a task to handle a monitoring execution in SupervisionScanner - -CONTROLLOOP_STATECHANGE_ACK -+++++++++++++++++++++++++++ -Design of a CONTROLLOOP_STATECHANGE_ACK is similar to the design for CONTROLLOOP_UPDATE_ACK - -Design of monitoring execution in SupervisionScanner -**************************************************** -Monitoring is designed to process the follow operations: - -- to determine the next startPhase in a CONTROLLOOP_UPDATE message -- to update CL state: in a scenario that "ControlLoop.state" is in a kind of transitional state (example UNINITIALISED2PASSIVE), if all - CL-elements are moved properly to the specific state, the "ControlLoop.state" will be updated to that and saved to DB -- to retry CONTROLLOOP_UPDATE/CONTROL_LOOP_STATE_CHANGE messages. if there is a CL Element not in the proper state, it will retry a broadcast message -- to retry PARTICIPANT_UPDATE message to the participant in a scenario that CL-runtime do not receive PARTICIPANT_UPDATE_ACT from it -- to send PARTICIPANT_STATUS_REQ to the participant in a scenario that CL-runtime do not receive PARTICIPANT_STATUS from it - -The solution Design of retry, timeout, and reporting for all Participant message dialogues are implemented into the monitoring execution. - -- Spring Scheduling inserts the task to monitor retry execution into ThreadPoolExecutor -- ThreadPoolExecutor executes the task -- a message will be retry if CL-runtime do no receive Act message before MaxWaitMs milliseconds - -Design of Exception handling -**************************** -GlobalControllerExceptionHandler -++++++++++++++++++++++++++++++++ -If error occurred during the Rest Api call, CL-runtime responses with a proper status error code and a JSON message error. -This class is implemented to intercept and handle ControlLoopException, PfModelException and PfModelRuntimeException if they are thrown during the Rest Ali calls. -All of those classes must implement ErrorResponseInfo that contains message error and status response code. -So the Exception is converted in JSON message. - -RuntimeErrorController -++++++++++++++++++++++ -If wrong end-point is called or an Exception not intercepted by GlobalControllerExceptionHandler, CL-runtime responses with a proper status error code and a JSON message error. -This class is implemented to redirect the standard Web error page to a JSON message error. -Typically that happen when a wrong end-point is called, but also could be happen for not authorized call, or any other Exception not intercepted by GlobalControllerExceptionHandler. - -Handle version and "X-ONAP-RequestID" -************************************* -RequestResponseLoggingFilter class handles version and "X-ONAP-RequestID" during a Rest-Api call; it works as a filter, so intercepts the Rest-Api and adds to the header those information. - -Media Type Support -****************** -CL-runtime Rest Api supports **application/json**, **application/yaml** and **text/plain** Media Types. The configuration is implemented in CoderHttpMesageConverter. - -application/json -++++++++++++++++ -JSON format is a standard for Rest Api. For the conversion from JSON to Object and vice-versa will be used **org.onap.policy.common.utils.coder.StandardCoder**. - -application/yaml -++++++++++++++++ -YAML format is a standard for Control Loop Type Definition. For the conversion from YAML to Object and vice-versa will be used **org.onap.policy.common.utils.coder.StandardYamlCoder**. - -text/plain -++++++++++ -Text format is used by Prometheus. For the conversion from Object to String will be used **StringHttpMessageConverter**. diff --git a/docs/clamp/controlloop/design-impl/clamp-gui-controlloop.rst b/docs/clamp/controlloop/design-impl/clamp-gui-controlloop.rst deleted file mode 100644 index 71d0a053..00000000 --- a/docs/clamp/controlloop/design-impl/clamp-gui-controlloop.rst +++ /dev/null @@ -1,141 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _clamp-gui-controlloop: - -The Policy GUI for Control Loops -******************************** - -.. contents:: - :depth: 4 - -.. _Introduction: - -1. Introduction -############### -The Policy GUI for Control Loops is designed to provide a user the ability to interact with the Control Loop Runtime to perform several actions. The actual technical design of the Control Loop Runtime is detailed in :ref:`clamp-controlloop-runtime`. All of the endpoints and the purpose for accessing those endpoints is discussed there. In the current release of the GUI, the main purposes are to perform the below: - -- Commission new Tosca Service Templates. -- Editing Common Properties. -- Priming/De-priming Control Loop Definitions. -- Decommission existing Tosca Service Templates. -- Create new instances of Control Loops. -- Change the state of the Control Loops. -- Delete Control Loops. - -These functions can be carried out by accessing the Controlloop Runtime alone but this should not be required for a typical user to access the system. That is why the Controlloop GUI is required. The remainder of this document will be split into 2 main sections. The first section will show the overall architecture of ControlLoop with the GUI included, so that the reader can see where it fits in to the system. Then the section will outline the individual components required for a working GUI and outline how GUI interacts with these components and why. The final section has a diagram to show the flow of typical operations from the GUI, all the way down to the participants. - -2. GUI-focussed System Architecture -################################### -An architectural/functional diagram has bee provided in below. This does not show details of the other components involved in the GUI functionality. Most of the detail is provided for the GUI itself. - - .. image:: ../images/gui/GUI-Architecture.png - :align: center - -The remainder of this section outlines the different elements that comprise the architecture of the GUI and how the different elements connect to one another. - -2.1 Policy CLAMP GUI --------------------- - -2.1.1 CLAMP GUI -================ -The original Clamp project used the GUI to connect to various onap services, including policy api, policy pap, dcae, sdc and cds. Connection to all of these services is managed by the Camel Exchange present in the section :ref:`Policy Clamp Backend`. - -Class-based react components are used to render the different pages related to functionality around - -- Creating loop instances from existing templates that have been distributed by SDC. -- Deploying/Undeploying policies to the policy framework. -- Deploying/Undeploying microservices to the policy framework. -- Deleting Instances. - -Although this GUI deploys microservices, it is a completely different paradigm to the new ControlLoop participant-based deployment of services. Details of the CLAMP GUI are provided in :ref:`clamp-builtin-label` - -2.1.2 Controlloop GUI -===================== - -The current control loop GUI is an extension of the previously created GUI for the Clamp project. The Clamp project used the CLAMP GUI to connect to various onap services, including policy api, policy pap, dcae, sdc and cds. Although the current control loop project builds upon this GUI, it does not rely on these connected services. Instead, the ControlLoop GUI connects to the ControlLoop Runtime only. The ControlLoop Runtime then communicates with the database and all the ControlLoop participants (indirectly) over DMAAP. - -The CLAMP GUI was originally housed in the clamp repository but for the Istanbul release, it has been moved to the policy/gui repo. There are 3 different GUIs within this repository - clamp-gui (and ControlLoop gui) code is housed under the "gui-clamp" directory and the majority of development takes place within the "gui-clamp/ui-react" directory. - -The original CLAMP GUI was created using the React framework, which is a light-weight framework that promotes use of component-based architecture. Previously, a class-based style was adopted to create the Clamp components. It was decided that ControlLoop would opt for the more concise functional style of components. This architecture style allows for the logical separation of functionality into different components and minimizes bloat. As you can see from the image, there is a "ControlLoop" directory under components where all of our ControlLoop components are housed. - - .. image:: ../images/gui/ComponentFileStructure.png - -Any code that is directly involved in communication with outside services like Rest Apis is under "ui-react/src/api". The "fetch" Javascript library is used for these calls. The ControlLoop service communicates with just the ControlLoop Runtime Rest Api, so all of the communication code is within "ui-react/src/api/ControlLoopService.js". - -2.1.2.1 Services -"""""""""""""""" -The ControlLoop GUI is designed to be service-centric. This means that the code involved in rendering and manipulating data is housed in a different place to the code responsible for communication with outside services. The ControlLoop related services are those responsible for making calls to the commissioning and instantiation endpoints in the ControlLoop Runtime. Another detail to note is that both the ControlLoop and CLAMP GUI use a proxy to forward requests to the policy clamp backend. Any URLs called by the frontend that contain the path "restservices/clds/v2/" are forwarded to the backend. Services are detailed below: - -- A commissioning call is provided for contacting the commissioning API to commission a tosca service template. -- A decommissioning call is provided for calling the decommissioning endpoint. -- A call to retrieve the tosca service template from the runtime is provided. This is useful for carrying out manipulations on the template, such as editing the common properties. -- A call to get the common or instance properties is provided. This is used to provide the user an opportunity to edit these properties. -- Calls to allow creation and deletion of an instance are provided -- Calls to change the state of and instance are provided. -- Calls to get the current state and ordered state of the instances, effectively monitoring. - -These services provide the data and communication functionality to allow the user to perform all of the actions mentioned in the :ref:`Introduction`. - -2.1.2.2 Components -"""""""""""""""""" -The components in the architecture image reflect those rendered elements that are presented to the user. Each element is designed to be as user-friendly as possible, providing the user with clean uncluttered information. Note that all of these components relate to and were designed around specific system dialogues that are present in :ref:`system-level-label`. - -- For commissioning, the user is provided with a simple file upload. This is something the user will have seen many times before and is self explanatory. -- For the edit of common properties, a JSON editor is used to present whatever common properties that are present in the service template to the user in as simple a way possible. The user can then edit, save and recommission. -- A link is provided to manage the tosca service template, where the user can view the file that has been uploaded in JSON format and optionally delete it. -- Several functions are exposed to the user in the "Manage Instances" modal. From there they can trigger, creation of an instance, view monitoring information, delete an instance and change the state. -- Before an instance is created, the user is provided an opportunity to edit the instance properties. That is, those properties that have not been marked as common. -- The user can change the state of the instance by using the "Change" button on the "Manage Instances" modal. This is effectively where the user can deploy and undeploy an instance. -- Priming and De-priming take place as a result of the action of commissioning and decommissioning a tosca service template. A more complete discussion of priming and de-priming is found here :ref:`controlloop-participant-protocol-label`. -- As part of the "Manage Instances" modal, we can monitor the state of the instances in 2 ways. The color of the instance highlight in the table indicates the state (grey - uninitialised, passive - yellow, green - running). Also, there is a monitoring button that allows use to view the individual elements' state. - -.. _Policy Clamp Backend: - -2.2 Policy Clamp Backend ------------------------- -The only Rest API that the ControlLoop frontend (and CLAMP frontend) communicates with directly is the Clamp backend. The backend is written in the Springboot framework and has many functions. In this document, we will only discuss the ControlLoop related functionality. Further description of non-ControlLoop Clamp and its' architecture can be found in :ref:`clamp-builtin-label`. The backend receives the calls from the frontend and forwards the requests to other relevant APIs. In the case of the ControlLoop project, the only Rest API that it currently requires communication with is the runtime ControlLoop API. ControlLoop adopts the same "request forwarding" method as the non-ControlLoop elements in the CLAMP GUI. This forwarding is performed by Apache Camel Exchanges, which are specified in XML and can be found in the directory shown below in the Clamp repository. - - .. image:: ../images/gui/CamelDirectory.png - -The Rest Endpoints for the GUI to call are defined in "clamp-api-v2.xml" and all of the runtime ControlLoop rest endpoints that GUI requests are forwarded to are defined in ControlLoop-flows.xml. If an Endpoint is added to the runtime ControlLoop component, or some other component you wish the GUI to communicate with, a Camel XML exchange must be defined for it here. - -2.3 ControlLoop Runtime ------------------------ -This is where all of the endpoints for operations on ControlLoops are defined thus far. Commissioning, decommissioning, control loop creation, control loop state change and control loop deletion are all performed here. The component is written using the Springboot framework and all of the code is housed in the runtime-ControlLoop directory shown below: - - .. image:: ../images/gui/RuntimeControlloopDirectory.png - -The rest endpoints are split over two main classes; CommissioningController.java and InstantiationController.java. There are also some rest endpoints defined in the MonitoringQueryController. These classes have minimal business logic defined in them and delegate these operations to other classes within the controlloop.runtime package. The ControlLoop Runtime write all data received on its' endpoints regarding commissioning and instantiation to its; database, where it can be easily accessed later by the UI. - -The Runtime also communicates with the participants over DMAAP. Commissioning a control loop definition writes it to the database but also triggers priming of the definitions over DMAAP. The participants then receive those definitions and hold them in memory. Similarly, upon decommissioning, a message is sent over DMAAP to the participants to trigger de-priming. - -Using DMAAP, the Runtime can send; updates to the control loop definitions, change the state of control loops, receive information about participants, receive state information about control loops and effectively supervise the control loops. This data is then made available via Rest APIs that can be queried by the frontend. This is how the GUI can perform monitoring operations. - -More detail on the design of the Runtime ControlLoop can be found in :ref:`clamp-controlloop-runtime`. - -2.4 DMAAP ---------- -DMAAP is comonent that provides data movement services that transports and processes data from any source to any target. It provides the capability to: -- Support the transfer of messages between ONAP components, as well as to other components -- Support the transfer of data between ONAP components as well as to other components. -- Data Filtering capabilities -- Data Processing capabilities -- Data routing (file based transport) -- Message routing (event based transport) -- Batch and event based processing - -Specifically, regarding the communication between the ControlLoop Runtime and the ControlLoop Participants, both components publish and subscribe to a specific topic, over which data and updates from the participants and control loops are sent. The ControlLoop Runtime updates the current statuses sent from the participants in the database and makes them available the the GUI over the Rest API. - -2.5 The Participants --------------------- -The purpose of the ControlLoop participants is to communicate with different services on behalf of the ControlLoop Runtime. As there are potentially many different services that a ControlLoop might require access to, there can be many different participants. For example, the kubernetes participant is responsible for carrying out operations on a kubernetes cluster with helm. As of the time of writing, there are three participants defined for the ControlLoop project; the policy participant, the kubernetes participant and the http participant. The participants are housed in the directory shown below in the policy-clamp repo. - - .. image:: ../images/gui/ParticipantsDirectory.png - -The participants communicate with the Runtime over DMAAP. Tosca service template specifications, ControlLoop updates and state changes are shared with the participants via messages from runtime ControlLoop through the topic "POLICY-CLRUNTIME-PARTICIPANT". - -3. GUI Sample Flows -################### -The primary flows from the GUI to the backend, through DMAAP and the participants are shown in the diagram below. This diagram just serves as an illustration of the scenarios that the user will experience in the GUI. You can see factually complete dialogues in :ref:`system-level-label`. - - .. image:: ../images/gui/GUI-Flow.png diff --git a/docs/clamp/controlloop/design-impl/design-impl.rst b/docs/clamp/controlloop/design-impl/design-impl.rst deleted file mode 100644 index 50ebb2e7..00000000 --- a/docs/clamp/controlloop/design-impl/design-impl.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. 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 deleted file mode 100644 index b4b9b858..00000000 --- a/docs/clamp/controlloop/design-impl/participants/http-participant.rst +++ /dev/null @@ -1,133 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _clamp-controlloop-http-participant: - -HTTP Participant -################ - -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 <clamp-controlloop-k8s-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. - -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 ------------------------------------------------------------------------------ -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. - -Sample tosca template defining a http participant and a control loop element for a control loop. :download:`click here <tosca/tosca-http-participant.yml>` - -The user configures the following properties in the TOSCA 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 *<String, String>* defining the HTTP headers to send on all REST calls - * - configurationEntitiies - - map - - A map of *<String, ConfigurationEntity>* 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<RestRequest> - - 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 endpoint 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 - -Http participant Interactions: ------------------------------- -The http participant interacts with Control Loop Runtime on the northbound via DMaap. It interacts with any microservice on the southbound over http for configuration. - -The communication for the Control loop updates and state change requests are sent from the Control Loop Runtime to the participant via DMaap. -The participant invokes the appropriate http endpoint of the microservice based on the received messages from the Control Loop Runtime. - - -startPhase: ------------ -The http participant is often used along with :ref:`Kubernetes Participant <clamp-controlloop-k8s-participant>` to configure the microservice after the deployment. -This requires the Control Loop Element of http participant to be started after the completion of deployment of the microservice. This can be achieved by adding the property `startPhase` -in the Control Loop Element of http participant. Control Loop Runtime starts the elements based on the `startPhase` value defined in the Tosca. The default value of startPhase is taken as '0' -which takes precedence over the Control Loop Elements with the startPhase value '1'. Http Control Loop Elements are defined with value '1' in order to start the Control Loop Element in the second phase. - -Http participant Workflow: --------------------------- -Once the participant is started, it sends a "REGISTER" event to the DMaap topic which is then consumed by the Control Loop Runtime to register this participant on the runtime database. -The user can commission the tosca definitions from the Policy Gui to the Control Loop Runtime that further updates the participant with these definitions via DMaap. -Once the control loop definitions are available in the runtime database, the Control Loop can be instantiated with the default state "UNINITIALISED" from the Policy Gui. - -When the state of the Control Loop is changed from "UNINITIALISED" to "PASSIVE" from the Policy Gui, the http participant receives the control loop state change event from the runtime and -configures the microservice of the corresponding Control Loop Element over http. -The configuration entity for a microservice is associated with each Control Loop Element for the http participant. -The http participant holds the executed http requests information along with the responses received. - -The participant is used in a generic way to configure any entity over http and it does not hold the information about the microservice to unconfigure/revert the configurations when the -state of Control Loop changes from "PASSIVE" to "UNINITIALISED". - diff --git a/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst b/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst deleted file mode 100644 index 20f60b60..00000000 --- a/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst +++ /dev/null @@ -1,139 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _clamp-controlloop-k8s-participant: - -Kubernetes Participant -###################### - -The kubernetes participant receives a helm chart information from the CLAMP runtime and installs the helm chart in to the -k8s cluster on the specified namespace. It can fetch the helm chart from remote helm repositories as well as from any of the repositories -that are configured on the helm client. The participant acts as a wrapper around the helm client and creates the required -resources in the k8s cluster. - -The kubernetes participant also exposes REST endpoints for onboarding, installing and uninstalling of helm charts from the -local chart database which facilitates the user to also use this component as a standalone application for helm operations. - -In Istanbul version, the kubernetes participant supports the following methods of installation of helm charts. - -- Installation of helm charts from configured helm repositories and remote repositories passed via TOSCA in CLAMP. -- Installation of helm charts from the local chart database via the participant's REST Api. - -Prerequisites for using Kubernetes participant in Istanbul version: -------------------------------------------------------------------- - -- A running Kubernetes cluster. - - Note: - - - If the kubernetes participant is deployed outside the cluster , the config file of the k8s cluster needs to be copied to the `./kube` folder of kubernetes participant's home directory to make the participant work with the external cluster. - - - If the participant needs additional permission to create resources on the cluster, cluster-admin role binding can be created for the service account of the participant with the below command. - - Example: `kubectl create clusterrolebinding k8s-participant-admin-binding --clusterrole=cluster-admin --serviceaccount=<k8s participant service account>` - - -.. image:: ../../images/participants/k8s-participant.png - -Defining a TOSCA CL definition for kubernetes participant: ----------------------------------------------------------- - -A *chart* parameter map describes the helm chart parameters in tosca template for a microservice that is used by the kubernetes participant for the deployment. -A Control Loop element in TOSCA is mapped to the kubernetes participant and also holds the helm chart parameters for a microservice defined under the properties of the Control Loop Element. - -Sample tosca template defining a participant and a control loop element for a control loop. :download:`click here <tosca/tosca-k8s-participant.yml>` - - -Configuring a Control Loop Element on the kubernetes participant for a Control Loop ------------------------------------------------------------------------------------ - -The user configures the following properties in the TOSCA template for the kubernetes participant: - -.. list-table:: - :widths: 15 10 50 - :header-rows: 1 - - * - Property - - Type - - Description - * - chartId - - ToscaConceptIdentifier - - The name and version of the helm chart that needs to be managed by the kubernetes participant - * - namespace - - String - - The namespace in the k8s cluster where the helm chart needs to be installed - * - releaseName - - String - - The helm deployment name that specifies the installed component in the k8s cluster - * - repository (optional) - - map - - A map of *<String, String>* defining the helm repository parameters for the chart - * - overrideParams (optional) - - map - - A map of *<String, String>* defining the helm chart parameters that needs to be overridden - -Note: The repository property can be skipped if the helm chart is available in the local chart database or -in a repository that is already configured on the helm client. The participant does a chart lookup by default. - -The *repository* type is described in the following table: - -.. list-table:: - :widths: 15 10 50 - :header-rows: 1 - - * - Field - - Type - - Description - * - repoName - - String - - The name of the helm repository that needs to be configured on the helm client - * - protocol - - String - - Specifies http/https protocols to connect with repository url - * - address - - String - - Specifies the ip address or the host name - * - port (optional) - - String - - Specifies the port where the repository service is running - * - userName (optional) - - String - - The username to login the helm repository - * - password (optional) - - String - - The password to login the helm repository - - -Kubernetes participant Interactions: ------------------------------------- -The kubernetes participant interacts with Control Loop Runtime on the northbound via DMaap. It interacts with the helm client on the southbound for performing various helm operations to the k8s cluster. - -The communication for the Control loop updates and state change requests are sent from the Control Loop Runtime to the participant via DMaap. -The participant performs appropriate operations on the k8s cluster via helm client based on the received messages from the Control Loop Runtime. - - -kubernetes participant Workflow: --------------------------------- -Once the participant is started, it sends a "REGISTER" event to the DMaap topic which is then consumed by the Control Loop Runtime to register this participant on the runtime database. -The user can commission the tosca definitions from the Policy Gui to the Control Loop Runtime that further updates the participant with these definitions via DMaap. -Once the control loop definitions are available in the runtime database, the Control Loop can be instantiated with the default state "UNINITIALISED" from the Policy Gui. - -When the state of the Control Loop is changed from "UNINITIALISED" to "PASSIVE" from the Policy Gui, the kubernetes participant receives the control loop state change event from the runtime and -deploys the helm charts associated with each Control Loop Elements by creating appropriate namespace on the cluster. -If the repository of the helm chart is not passed via TOSCA, the participant looks for the helm chart in the configured helm repositories of helm client. -It also performs a chart look up on the local chart database where the helm charts are onboarded via the participant's REST Api. - -The participant also monitors the deployed pods for the next 3 minutes until the pods comes to RUNNING state. -It holds the deployment information of the pods including the current status of the pods after the deployment. - -When the state of the Control Loop is changed from "PASSIVE" to "UNINITIALISED" back, the participant also undeploys the helm charts from the cluster that are part of the Control Loop Element. - -REST APIs on Kubernetes participant ------------------------------------ - -Kubernetes participant can also be installed as a standalone application which exposes REST endpoints for onboarding, -installing, uninstalling helm charts from local chart database. - - -.. image:: ../../images/participants/k8s-rest.png - -:download:`Download Kubernetes participant API Swagger <swagger/k8s-participant-swagger.json>`
\ No newline at end of file diff --git a/docs/clamp/controlloop/design-impl/participants/participant-intermediary.rst b/docs/clamp/controlloop/design-impl/participants/participant-intermediary.rst deleted file mode 100644 index a483dfc3..00000000 --- a/docs/clamp/controlloop/design-impl/participants/participant-intermediary.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. 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. - -Terminology ------------ -- Broadcast message: a message for all participants (participantId=null and participantType=null) -- Message to a participant: a message only for a participant (participantId and participantType properly filled) -- MessageSender: a class that takes care of sending messages from participant-intermediary -- GUI: graphical user interface, Postman or a Front-End Application - -Inbound messages to participants --------------------------------- -- PARTICIPANT_REGISTER_ACK: received as a response from controlloop runtime server as an acknowledgement to ParticipantRegister message sent from a participant -- PARTICIPANT_DEREGISTER_ACK: received as a response from controlloop runtime server as an acknowledgement to ParticipantDeregister message sent from a participant -- CONTROL_LOOP_STATE_CHANGE: a message received from controlloop runtime server for a state change of controlloop -- CONTROL_LOOP_UPDATE: a message received from controlloop runtime server for a controlloop update with controlloop instances -- PARTICIPANT_UPDATE: a message received from controlloop runtime server for a participant update with tosca definitions of controlloop -- PARTICIPANT_STATUS_REQ: A status request received from controlloop runtime server to send an immediate ParticipantStatus from all participants - -Outbound messages ------------------ -- PARTICIPANT_REGISTER: is sent by a participant during startup -- PARTICIPANT_DEREGISTER: is sent by a participant during shutdown -- PARTICIPANT_STATUS: is sent by a participant as heartbeat with the status and health of a participant -- CONTROLLOOP_STATECHANGE_ACK: is an acknowledgement sent by a participant as a response to ControlLoopStateChange -- CONTROLLOOP_UPDATE_ACK: is an acknowledgement sent by a participant as a response to ControlLoopUpdate -- PARTICIPANT_UPDATE_ACK: is an acknowledgement sent by a participant as a response to ParticipantUpdate - -Design of a PARTICIPANT_REGISTER message ----------------------------------------- -- A participant starts and send a PARTICIPANT_REGISTER message -- ParticipantRegisterListener collects the message from DMaap -- if participant is not present in DB, it saves participant reference with status UNKNOWN to DB -- if participant is present in DB, it triggers the execution to send a PARTICIPANT_UPDATE message to the participant registered (message of Priming) -- the message is built by ParticipantUpdatePublisher using Tosca Service Template data (to fill the list of ParticipantDefinition) -- It triggers the execution to send a PARTICIPANT_REGISTER_ACK message to the participant registered -- MessageIntercept intercepts that event, if PARTICIPANT_UPDATE message has been sent, it will be add a task to handle PARTICIPANT_REGISTER in SupervisionScanner -- SupervisionScanner starts the monitoring for participantUpdate - -Design of a PARTICIPANT_DEREGISTER message ------------------------------------------- -- A participant starts and send a PARTICIPANT_DEREGISTER message -- ParticipantDeregisterListener collects the message from DMaap -- if participant is not present in DB, do nothing -- if participant is present in DB, it triggers the execution to send a PARTICIPANT_UPDATE message to the participant registered (message of DePriming) -- the message is built by ParticipantUpdatePublisher using Tosca Service Template data as null -- ParticipantHandler removes the tosca definitions stored -- It triggers the execution to send a PARTICIPANT_DEREGISTER_ACK message to the participant registered -- Participant is not monitored. - -Design of a creation of a Control Loop Type -------------------------------------------- -- If there are participants registered with CL-runtime, it triggers the execution to send a broadcast PARTICIPANT_UPDATE message -- the message is built by ParticipantUpdatePublisher using Tosca Service Template data (to fill the list of ParticipantDefinition) -- Participant-intermediary will receive a PARTICIPANT_UDPATE message and stores the Tosca Service Template data on ParticipantHandler - -Design of a deletion of a Control Loop Type -------------------------------------------- -- if there are participants registered, CL-runtime triggers the execution to send a broadcast PARTICIPANT_UPDATE message -- the message is built by ParticipantUpdatePublisher with an empty list of ParticipantDefinition -- It deletes the Control Loop Type from DB -- Participant-intermediary will receive a PARTICIPANT_UDPATE message and deletes the Tosca Service Template data on ParticipantHandler - -Design of a creation of a Control Loop --------------------------------------- -- CONTROL_LOOP_UPDATE message with instantiation details and UNINITIALISED state is sent to participants -- Participant-intermediary validates the current state change -- Participant-intermediary will recieve CONTROL_LOOP_UPDATE message and sends the details of ControlLoopElements to participants -- Each participant performs its designated job of deployment by interacting with respective frameworks - -Design of a deletion of a Control Loop --------------------------------------- -- CONTROL_LOOP_STATE_CHANGE message with UNINITIALISED state is sent to participants -- Participant-intermediary validates the current state change -- Participant-intermediary will recieve CONTROL_LOOP_STATE_CHANGE message and sends the details of ControlLoopElements to participants -- Each participant performs its designated job of undeployment by interacting with respective frameworks - -Design of "issues control loop commands to control loops" - case UNINITIALISED to PASSIVE ------------------------------------------------------------------------------------------ -- CONTROL_LOOP_STATE_CHANGE message with state changed from UNINITIALISED to PASSIVE is sent to participants -- Participant-intermediary validates the current state change -- Participant-intermediary will recieve CONTROL_LOOP_STATE_CHANGE message and sends the details of state change to participants -- Each participant performs its designated job of state change by interacting with respective frameworks - -Design of "issues control loop commands to control loops" - case PASSIVE to UNINITIALISED ------------------------------------------------------------------------------------------ -- CONTROL_LOOP_STATE_CHANGE message with state changed from PASSIVE to UNINITIALISED is sent to participants -- Participant-intermediary validates the current state change -- Participant-intermediary will recieve CONTROL_LOOP_STATE_CHANGE message and sends the details of state change to participants -- Each participant performs its designated job of state change by interacting with respective frameworks - -Design of "issues control loop commands to control loops" - case PASSIVE to RUNNING ------------------------------------------------------------------------------------ -- CONTROL_LOOP_STATE_CHANGE message with state changed from PASSIVE to RUNNING is sent to participants -- Participant-intermediary validates the current state change -- Participant-intermediary will recieve CONTROL_LOOP_STATE_CHANGE message and sends the details of state change to participants -- Each participant performs its designated job of state change by interacting with respective frameworks - -Design of "issues control loop commands to control loops" - case RUNNING to PASSIVE ------------------------------------------------------------------------------------ -- CONTROL_LOOP_STATE_CHANGE message with state changed from RUNNING to PASSIVE is sent to participants -- Participant-intermediary validates the current state change -- Participant-intermediary will recieve CONTROL_LOOP_STATE_CHANGE message and sends the details of state change to participants -- Each participant performs its designated job of state change by interacting with respective frameworks - -Design of a PARTICIPANT_STATUS message --------------------------------------- -- A participant sends a scheduled PARTICIPANT_STATUS message -- This message will hold the state and healthStatus of all the participants running actively -- PARTICIPANT_STATUS message holds a special attribute to return Tosca definitions, this attribute is populated only in response to PARTICIPANT_STATUS_REQ - -Design of a CONTROLLOOP_UPDATE_ACK message ------------------------------------------- -- A participant sends CONTROLLOOP_UPDATE_ACK message in response to a CONTROLLOOP_UPDATE message. -- For each CL-elements moved to the ordered state as indicated by the CONTROLLOOP_UPDATE -- ControlLoopUpdateAckListener in CL-runtime collects the messages from DMaap -- It checks the status of all control loop elements and checks if the control loop is primed -- It updates the controlloop in DB accordingly - -Design of a CONTROLLOOP_STATECHANGE_ACK is similar to the design for CONTROLLOOP_UPDATE_ACK diff --git a/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst b/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst deleted file mode 100644 index 9ac4e735..00000000 --- a/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _clamp-controlloop-participant-simulator: - -Participant Simulator -##################### - -This can be used for simulation testing purpose when there are no actual frameworks or a full deployment. -Participant simulator can edit the states of ControlLoopElements and Participants for verification of other controlloop components -for early testing. -All controlloop components should be setup, except participant frameworks (for example, no policy framework components -are needed) and participant simulator acts as respective participant framework, and state changes can be done with following REST APIs - -Participant Simulator API -========================= - -This API allows a Participant Simulator to be started and run for test purposes. - -:download:`Download Policy Participant Simulator API Swagger <swagger/participant-sim.json>` - -.. swaggerv2doc:: swagger/participant-sim.json diff --git a/docs/clamp/controlloop/design-impl/participants/participants.rst b/docs/clamp/controlloop/design-impl/participants/participants.rst deleted file mode 100644 index 230c9888..00000000 --- a/docs/clamp/controlloop/design-impl/participants/participants.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. 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 <clamp-controlloop-participant-intermediary>`, 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 deleted file mode 100644 index 56b2844f..00000000 --- a/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _clamp-controlloop-policy-framework-participant: - -The CLAMP Policy Framework Participant -###################################### - -.. contents:: - :depth: 3 - -Control Loop Elements in the Policy Framework Participant are configured using TOSCA metadata defined for the Policy Control Loop Element type. - -The Policy Framework participant receives messages through participant-intermediary common code, and handles them by invoking REST APIs towards policy-framework. - -For example, When a ControlLoopUpdate message is received by policy participant, it contains full ToscaServiceTemplate describing all components participating in a control loop. When the control loop element state changed from UNINITIALIZED to PASSIVE, the Policy-participant triggers the creation of policy-types and policies in Policy-Framework. - -When the state changes from PASSIVE to UNINITIALIZED, Policy-Participant deletes the policies, policy-types by invoking REST APIs towards the policy-framework. - -Run Policy Framework Participant command line using Maven -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -mvn spring-boot:run -Dspring-boot.run.arguments="--server.port=8082" - -Run Policy Framework Participant command line using Jar -+++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -java -jar -Dserver.port=8082 -DtopicServer=localhost target/policy-clamp-participant-impl-policy-6.1.2-SNAPSHOT.jar - -Distributing Policies -+++++++++++++++++++++ - -The Policy Framework participant uses the Policy PAP API to deploy and undeploy policies. - -When a Policy Framework Control Loop Element changes from state PASSIVE to state RUNNING, the policy is deployed. When it changes from state RUNNING to state PASSIVE, the policy is undeployed. - -The PDP group to which the policy should be deployed is specified in the Control Loop Element metadata, see the Policy Control Loop Element type definition. If the PDP group specified for policy deployment does not exist, an error is reported. - -The PAP Policy Status API and Policy Deployment Status API are used to retrieve data to report on the deployment status of policies in Participant Status messages. - -The PDP Statistics API is used to get statistics for statistics report from the Policy Framework Participant back to the CLAMP runtime. - -Policy Type and Policy References -+++++++++++++++++++++++++++++++++ - -The Policy Framework uses the policyType and policyId properties defined in the Policy Control Loop Element type references to specify what policy type and policy should be used by a Policy Control Loop Element. - -The Policy Type and Policy specified in the policyType and policyId reference must of course be available in the Policy Framework in order for them to be used in Control Loop instances. In some cases, the Policy Type and/or the Policy may be already loaded in the Policy Framework. In other cases, the Policy Framework participant must load the Policy Type and/or policy. - -Policy Type References -********************** - -The Policy Participant uses the following steps for Policy Type References: - -#. The Policy Participant reads the Policy Type ID from the policyType property specified for the Control Loop Element. - -#. It checks if a Policy Type with that Policy Type ID has been specified in the ToscaServiceTemplateFragment field in - the ControLoopElement definition in the ControlLoopUpdate message, see :ref:`controlloop-participant-protocol-label`. - - #. If the Policy Type has been specified, the Participant stores the Policy Type in the Policy framework. If the - Policy Type is successfully stored, execution proceeds, otherwise an error is reported. - - #. If the Policy Type has not been specified, the Participant checks that the Policy Type is already in the Policy - framework. If the Policy Type already exists, execution proceeds, otherwise an error is reported. - -Policy References -***************** - -The Policy Participant uses the following steps for Policy References: - -#. The Policy Participant reads the Policy ID from the policyId property specified for the Control Loop Element. - -#. It checks if a Policy with that Policy ID has been specified in the ToscaServiceTemplateFragment field in the - ControLoopElement definition in the ControlLoopUpdate message, :ref:`controlloop-participant-protocol-label`. - - #. If the Policy has been specified, the Participant stores the Policy in the Policy framework. If the Policy is - successfully stored, execution proceeds, otherwise an error is reported. - - #. If the Policy has not been specified, the Participant checks that the Policy is already in the Policy framework. If - the Policy already exists, execution proceeds, otherwise an error is reported.
\ No newline at end of file diff --git a/docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json b/docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json deleted file mode 100644 index b2fca37a..00000000 --- a/docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json +++ /dev/null @@ -1,399 +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" - } - }, - "host":"localhost:8083", - "tags":[ - { - "name":"k8s-participant", - "description":"Chart Controller" - } - ], - "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" - } - } -} diff --git a/docs/clamp/controlloop/design-impl/participants/swagger/participant-sim.json b/docs/clamp/controlloop/design-impl/participants/swagger/participant-sim.json deleted file mode 100644 index 79fc3011..00000000 --- a/docs/clamp/controlloop/design-impl/participants/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/design-impl/participants/tosca/tosca-http-participant.yml b/docs/clamp/controlloop/design-impl/participants/tosca/tosca-http-participant.yml deleted file mode 100644 index dae4c76a..00000000 --- a/docs/clamp/controlloop/design-impl/participants/tosca/tosca-http-participant.yml +++ /dev/null @@ -1,439 +0,0 @@ -tosca_definitions_version: tosca_simple_yaml_1_3 -data_types: - onap.datatypes.ToscaConceptIdentifier: - derived_from: tosca.datatypes.Root - properties: - name: - type: string - required: true - version: - type: string - required: true - onap.datatype.controlloop.Target: - derived_from: tosca.datatypes.Root - description: Definition for a entity in A&AI to perform a control loop operation on - properties: - targetType: - type: string - description: Category for the target type - required: true - constraints: - - valid_values: - - VNF - - VM - - VFMODULE - - PNF - entityIds: - type: map - description: | - Map of values that identify the resource. If none are provided, it is assumed that the - entity that generated the ONSET event will be the target. - required: false - metadata: - clamp_possible_values: ClampExecution:CSAR_RESOURCES - entry_schema: - type: string - onap.datatype.controlloop.Actor: - derived_from: tosca.datatypes.Root - description: An actor/operation/target definition - properties: - actor: - type: string - description: The actor performing the operation. - required: true - metadata: - clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor - operation: - type: string - description: The operation the actor is performing. - metadata: - clamp_possible_values: Dictionary:DefaultOperations,ClampExecution:CDS/operation - required: true - target: - type: onap.datatype.controlloop.Target - description: The resource the operation should be performed on. - required: true - payload: - type: map - description: Name/value pairs of payload information passed by Policy to the actor - required: false - metadata: - clamp_possible_values: ClampExecution:CDS/payload - entry_schema: - type: string - onap.datatype.controlloop.Operation: - derived_from: tosca.datatypes.Root - description: An operation supported by an actor - properties: - id: - type: string - description: Unique identifier for the operation - required: true - description: - type: string - description: A user-friendly description of the intent for the operation - required: false - operation: - type: onap.datatype.controlloop.Actor - description: The definition of the operation to be performed. - required: true - timeout: - type: integer - description: The amount of time for the actor to perform the operation. - required: true - retries: - type: integer - description: The number of retries the actor should attempt to perform the operation. - required: true - default: 0 - success: - type: string - description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation. - required: false - default: final_success - failure: - type: string - description: Points to the operation to invoke on Actor operation failure. - required: false - default: final_failure - failure_timeout: - type: string - description: Points to the operation to invoke when the time out for the operation occurs. - required: false - default: final_failure_timeout - failure_retries: - type: string - description: Points to the operation to invoke when the current operation has exceeded its max retries. - required: false - default: final_failure_retries - failure_exception: - type: string - description: Points to the operation to invoke when the current operation causes an exception. - required: false - default: final_failure_exception - failure_guard: - type: string - description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement. - required: false - default: final_failure_guard - org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest: - version: 1.0.0 - derived_from: tosca.datatypes.Root - properties: - restRequestId: - type: onap.datatypes.ToscaConceptIdentifier - typeVersion: 1.0.0 - required: true - description: The name and version of a REST request to be sent to a REST endpoint - httpMethod: - type: string - required: true - constraints: - - valid_values: [POST, PUT, GET, DELETE] - description: The REST method to use - path: - type: string - required: true - description: The path of the REST request relative to the base URL - body: - type: string - required: false - description: The body of the REST request for PUT and POST requests - expectedResponse: - type: integer - required: true - constraints: - - in_range: [100, 599] - description: THe expected HTTP status code for the REST request - org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity: - version: 1.0.0 - derived_from: tosca.datatypes.Root - properties: - configurationEntityId: - type: onap.datatypes.ToscaConceptIdentifier - typeVersion: 1.0.0 - required: true - description: The name and version of a Configuration Entity to be handled by the HTTP Control Loop Element - restSequence: - type: list - entry_schema: - type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest - typeVersion: 1.0.0 - description: A sequence of REST commands to send to the REST endpoint -node_types: - org.onap.policy.clamp.controlloop.Participant: - version: 1.0.1 - derived_from: tosca.nodetypes.Root - properties: - provider: - type: string - requred: false - org.onap.policy.clamp.controlloop.ControlLoopElement: - version: 1.0.1 - derived_from: tosca.nodetypes.Root - properties: - provider: - type: string - required: false - metadata: - common: true - description: Specifies the organization that provides the control loop element - participant_id: - type: onap.datatypes.ToscaConceptIdentifier - requred: true - metadata: - common: true - participantType: - type: onap.datatypes.ToscaConceptIdentifier - required: true - metadata: - common: true - description: The identity of the participant type that hosts this type of Control Loop Element - startPhase: - type: integer - required: false - constraints: - - greater_or_equal: 0 - metadata: - common: true - description: A value indicating the start phase in which this control loop element will be started, the - first start phase is zero. Control Loop Elements are started in their start_phase order and stopped - in reverse start phase order. Control Loop Elements with the same start phase are started and - stopped simultaneously - uninitializedToPassiveTimeout: - type: integer - required: false - constraints: - - greater_or_equal: 0 - default: 60 - metadata: - common: true - description: The maximum time in seconds to wait for a state chage from uninitialized to passive - passiveToRunningTimeout: - type: integer - required: false - constraints: - - greater_or_equal: 0 - default: 60 - metadata: - common: true - description: The maximum time in seconds to wait for a state chage from passive to running - runningToPassiveTimeout: - type: integer - required: false - constraints: - - greater_or_equal: 0 - default: 60 - metadata: - common: true - description: The maximum time in seconds to wait for a state chage from running to passive - passiveToUninitializedTimeout: - type: integer - required: false - constraints: - - greater_or_equal: 0 - default: 60 - metadata: - common: true - description: The maximum time in seconds to wait for a state chage from passive to uninitialized - org.onap.policy.clamp.controlloop.ControlLoop: - version: 1.0.1 - derived_from: tosca.nodetypes.Root - properties: - provider: - type: string - required: false - metadata: - common: true - description: Specifies the organization that provides the control loop element - elements: - type: list - required: true - metadata: - common: true - entry_schema: - type: onap.datatypes.ToscaConceptIdentifier - description: Specifies a list of control loop element definitions that make up this control loop definition - org.onap.policy.clamp.controlloop.HttpControlLoopElement: - version: 1.0.1 - derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement - properties: - baseUrl: - type: string - required: true - description: The base URL to be prepended to each path, identifies the host for the REST endpoints. - httpHeaders: - type: map - required: false - entry_schema: - type: string - description: HTTP headers to send on REST requests - configurationEntities: - type: map - required: true - entry_schema: - type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity - typeVersion: 1.0.0 - description: The connfiguration entities the Control Loop Element is managing and their associated REST requests - -topology_template: - node_templates: - org.onap.controlloop.HttpControlLoopParticipant: - version: 2.3.4 - type: org.onap.policy.clamp.controlloop.Participant - type_version: 1.0.1 - description: Participant for Http requests - properties: - provider: ONAP - org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement: - # Consul http config for PMSH. - version: 1.2.3 - type: org.onap.policy.clamp.controlloop.HttpControlLoopElement - type_version: 1.0.1 - description: Control loop element for the http requests of PMSH microservice - properties: - provider: ONAP - participant_id: - name: HttpParticipant0 - version: 1.0.0 - participantType: - name: org.onap.k8s.controlloop.HttpControlLoopParticipant - version: 2.3.4 - uninitializedToPassiveTimeout: 180 - baseUrl: http://consul-server-ui:8500 - httpHeaders: - Content-Type: application/json - configurationEntities: - - configurationEntityId: - name: entity1 - version: 1.0.1 - restSequence: - - restRequestId: - name: request1 - version: 1.0.1 - httpMethod: PUT - path: v1/kv/dcae-pmsh2 - body: '{ - "control_loop_name":"pmsh-control-loop", - "operational_policy_name":"pmsh-operational-policy", - "aaf_password":"demo123456!", - "aaf_identity":"dcae@dcae.onap.org", - "cert_path":"/opt/app/pmsh/etc/certs/cert.pem", - "key_path":"/opt/app/pmsh/etc/certs/key.pem", - "ca_cert_path":"/opt/app/pmsh/etc/certs/cacert.pem", - "enable_tls":"true", - "pmsh_policy":{ - "subscription":{ - "subscriptionName":"ExtraPM-All-gNB-R2B", - "administrativeState":"UNLOCKED", - "fileBasedGP":15, - "fileLocation":"\/pm\/pm.xml", - "nfFilter":{ - "nfNames":[ - "^pnf.*", - "^vnf.*" - ], - "modelInvariantIDs":[ - ], - "modelVersionIDs":[ - ], - "modelNames":[ - ] - }, - "measurementGroups":[ - { - "measurementGroup":{ - "measurementTypes":[ - { - "measurementType":"countera" - }, - { - "measurementType":"counterb" - } - ], - "managedObjectDNsBasic":[ - { - "DN":"dna" - }, - { - "DN":"dnb" - } - ] - } - }, - { - "measurementGroup":{ - "measurementTypes":[ - { - "measurementType":"counterc" - }, - { - "measurementType":"counterd" - } - ], - "managedObjectDNsBasic":[ - { - "DN":"dnc" - }, - { - "DN":"dnd" - } - ] - } - } - ] - } - }, - "streams_subscribes":{ - "aai_subscriber":{ - "type":"message_router", - "dmaap_info":{ - "topic_url":"https://10.152.183.151:3905/events/AAI_EVENT", - "client_role":"org.onap.dcae.aaiSub", - "location":"san-francisco", - "client_id":"1575976809466" - } - }, - "policy_pm_subscriber":{ - "type":"message_router", - "dmaap_info":{ - "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS", - "client_role":"org.onap.dcae.pmSubscriber", - "location":"san-francisco", - "client_id":"1575876809456" - } - } - }, - "streams_publishes":{ - "policy_pm_publisher":{ - "type":"message_router", - "dmaap_info":{ - "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS", - "client_role":"org.onap.dcae.pmPublisher", - "location":"san-francisco", - "client_id":"1475976809466" - } - }, - "other_publisher":{ - "type":"message_router", - "dmaap_info":{ - "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.SOME_OTHER_TOPIC", - "client_role":"org.onap.dcae.pmControlPub", - "location":"san-francisco", - "client_id":"1875976809466" - } - } - } - }' - expectedResponse: 200 - org.onap.domain.sample.GenericK8s_ControlLoopDefinition: - version: 1.2.3 - type: org.onap.policy.clamp.controlloop.ControlLoop - type_version: 1.0.0 - description: Control loop for Hello World - properties: - provider: ONAP - elements: - - name: org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement - version: 1.2.3 - diff --git a/docs/clamp/controlloop/design-impl/participants/tosca/tosca-k8s-participant.yml b/docs/clamp/controlloop/design-impl/participants/tosca/tosca-k8s-participant.yml deleted file mode 100644 index 70bbe928..00000000 --- a/docs/clamp/controlloop/design-impl/participants/tosca/tosca-k8s-participant.yml +++ /dev/null @@ -1,304 +0,0 @@ -tosca_definitions_version: tosca_simple_yaml_1_3 -data_types: - onap.datatypes.ToscaConceptIdentifier: - derived_from: tosca.datatypes.Root - properties: - name: - type: string - required: true - version: - type: string - required: true - onap.datatype.controlloop.Target: - derived_from: tosca.datatypes.Root - description: Definition for a entity in A&AI to perform a control loop operation on - properties: - targetType: - type: string - description: Category for the target type - required: true - constraints: - - valid_values: - - VNF - - VM - - VFMODULE - - PNF - entityIds: - type: map - description: | - Map of values that identify the resource. If none are provided, it is assumed that the - entity that generated the ONSET event will be the target. - required: false - metadata: - clamp_possible_values: ClampExecution:CSAR_RESOURCES - entry_schema: - type: string - onap.datatype.controlloop.Actor: - derived_from: tosca.datatypes.Root - description: An actor/operation/target definition - properties: - actor: - type: string - description: The actor performing the operation. - required: true - metadata: - clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor - operation: - type: string - description: The operation the actor is performing. - metadata: - clamp_possible_values: Dictionary:DefaultOperations,ClampExecution:CDS/operation - required: true - target: - type: onap.datatype.controlloop.Target - description: The resource the operation should be performed on. - required: true - payload: - type: map - description: Name/value pairs of payload information passed by Policy to the actor - required: false - metadata: - clamp_possible_values: ClampExecution:CDS/payload - entry_schema: - type: string - onap.datatype.controlloop.Operation: - derived_from: tosca.datatypes.Root - description: An operation supported by an actor - properties: - id: - type: string - description: Unique identifier for the operation - required: true - description: - type: string - description: A user-friendly description of the intent for the operation - required: false - operation: - type: onap.datatype.controlloop.Actor - description: The definition of the operation to be performed. - required: true - timeout: - type: integer - description: The amount of time for the actor to perform the operation. - required: true - retries: - type: integer - description: The number of retries the actor should attempt to perform the operation. - required: true - default: 0 - success: - type: string - description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation. - required: false - default: final_success - failure: - type: string - description: Points to the operation to invoke on Actor operation failure. - required: false - default: final_failure - failure_timeout: - type: string - description: Points to the operation to invoke when the time out for the operation occurs. - required: false - default: final_failure_timeout - failure_retries: - type: string - description: Points to the operation to invoke when the current operation has exceeded its max retries. - required: false - default: final_failure_retries - failure_exception: - type: string - description: Points to the operation to invoke when the current operation causes an exception. - required: false - default: final_failure_exception - failure_guard: - type: string - description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement. - required: false - default: final_failure_guard -node_types: - org.onap.policy.clamp.controlloop.Participant: - version: 1.0.1 - derived_from: tosca.nodetypes.Root - properties: - provider: - type: string - requred: false - org.onap.policy.clamp.controlloop.ControlLoopElement: - version: 1.0.1 - derived_from: tosca.nodetypes.Root - properties: - provider: - type: string - required: false - metadata: - common: true - description: Specifies the organization that provides the control loop element - participant_id: - type: onap.datatypes.ToscaConceptIdentifier - requred: true - metadata: - common: true - participantType: - type: onap.datatypes.ToscaConceptIdentifier - required: true - metadata: - common: true - description: The identity of the participant type that hosts this type of Control Loop Element - startPhase: - type: integer - required: false - constraints: - - greater_or_equal: 0 - metadata: - common: true - description: A value indicating the start phase in which this control loop element will be started, the - first start phase is zero. Control Loop Elements are started in their start_phase order and stopped - in reverse start phase order. Control Loop Elements with the same start phase are started and - stopped simultaneously - uninitializedToPassiveTimeout: - type: integer - required: false - constraints: - - greater_or_equal: 0 - default: 60 - metadata: - common: true - description: The maximum time in seconds to wait for a state chage from uninitialized to passive - passiveToRunningTimeout: - type: integer - required: false - constraints: - - greater_or_equal: 0 - default: 60 - metadata: - common: true - description: The maximum time in seconds to wait for a state chage from passive to running - runningToPassiveTimeout: - type: integer - required: false - constraints: - - greater_or_equal: 0 - default: 60 - metadata: - common: true - description: The maximum time in seconds to wait for a state chage from running to passive - passiveToUninitializedTimeout: - type: integer - required: false - constraints: - - greater_or_equal: 0 - default: 60 - metadata: - common: true - description: The maximum time in seconds to wait for a state chage from passive to uninitialized - org.onap.policy.clamp.controlloop.ControlLoop: - version: 1.0.1 - derived_from: tosca.nodetypes.Root - properties: - provider: - type: string - required: false - metadata: - common: true - description: Specifies the organization that provides the control loop element - elements: - type: list - required: true - metadata: - common: true - entry_schema: - type: onap.datatypes.ToscaConceptIdentifier - description: Specifies a list of control loop element definitions that make up this control loop definition - org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement: - version: 1.0.1 - derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement - properties: - chart: - type: string - required: true - configs: - type: list - required: false - requirements: - type: string - requred: false - templates: - type: list - required: false - entry_schema: - values: - type: string - required: true - -topology_template: - node_templates: - org.onap.k8s.controlloop.K8SControlLoopParticipant: - version: 2.3.4 - type: org.onap.policy.clamp.controlloop.Participant - type_version: 1.0.1 - description: Participant for K8S - properties: - provider: ONAP - org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement: - # Chart from new repository - version: 1.2.3 - type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement - type_version: 1.0.0 - description: Control loop element for the K8S microservice for PMSH - properties: - provider: ONAP - participant_id: - name: K8sParticipant0 - version: 1.0.0 - participantType: - name: org.onap.k8s.controlloop.K8SControlLoopParticipant - version: 2.3.4 - chart: - chartId: - name: dcae-pmsh - version: 8.0.0 - namespace: onap - releaseName: pmshms - repository: - repoName: chartmuseum - protocol: http - address: chart-museum - port: 80 - userName: onapinitializer - password: demo123456! - overrideParams: - global.masterPassword: test - - org.onap.domain.database.Local_K8SMicroserviceControlLoopElement: - # Chart installation without passing repository info - version: 1.2.3 - type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement - type_version: 1.0.0 - description: Control loop element for the K8S microservice for local chart - properties: - provider: ONAP - participant_id: - name: K8sParticipant0 - version: 1.0.0 - participantType: - name: org.onap.k8s.controlloop.K8SControlLoopParticipant - version: 2.3.4 - chart: - chartId: - name: nginx-ingress - version: 0.9.1 - releaseName: nginxms - namespace: test - org.onap.domain.sample.GenericK8s_ControlLoopDefinition: - version: 1.2.3 - type: org.onap.policy.clamp.controlloop.ControlLoop - type_version: 1.0.0 - description: Control loop for Hello World - properties: - provider: ONAP - elements: - - name: org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement - version: 1.2.3 - - name: org.onap.domain.database.Local_K8SMicroserviceControlLoopElement - version: 1.2.3 diff --git a/docs/clamp/controlloop/files/ControlLoops.pdf b/docs/clamp/controlloop/files/ControlLoops.pdf Binary files differdeleted file mode 100644 index c5b978db..00000000 --- a/docs/clamp/controlloop/files/ControlLoops.pdf +++ /dev/null diff --git a/docs/clamp/controlloop/images/01-controlloop-overview.png b/docs/clamp/controlloop/images/01-controlloop-overview.png Binary files differdeleted file mode 100644 index ac4f1459..00000000 --- a/docs/clamp/controlloop/images/01-controlloop-overview.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/02-controlloop-concepts.png b/docs/clamp/controlloop/images/02-controlloop-concepts.png Binary files differdeleted file mode 100644 index b2469b90..00000000 --- a/docs/clamp/controlloop/images/02-controlloop-concepts.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/03-controlloop-instance-states.png b/docs/clamp/controlloop/images/03-controlloop-instance-states.png Binary files differdeleted file mode 100644 index 85e5aa8e..00000000 --- a/docs/clamp/controlloop/images/03-controlloop-instance-states.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/04-overview.png b/docs/clamp/controlloop/images/04-overview.png Binary files differdeleted file mode 100644 index 8f59bd15..00000000 --- a/docs/clamp/controlloop/images/04-overview.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/05-upgrade-states.png b/docs/clamp/controlloop/images/05-upgrade-states.png Binary files differdeleted file mode 100644 index a10538c9..00000000 --- a/docs/clamp/controlloop/images/05-upgrade-states.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/06-api-gateway-sandbox.png b/docs/clamp/controlloop/images/06-api-gateway-sandbox.png Binary files differdeleted file mode 100644 index b4dfe2ba..00000000 --- a/docs/clamp/controlloop/images/06-api-gateway-sandbox.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-depriming.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-depriming.png Binary files differdeleted file mode 100644 index 16a923b1..00000000 --- a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-depriming.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-monitoring.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-monitoring.png Binary files differdeleted file mode 100644 index f64fcd2e..00000000 --- a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-monitoring.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-priming.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-priming.png Binary files differdeleted file mode 100644 index fa17429d..00000000 --- a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-priming.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change-msg.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change-msg.png Binary files differdeleted file mode 100644 index dfcfe882..00000000 --- a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change-msg.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change.png Binary files differdeleted file mode 100644 index 9ce9e490..00000000 --- a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update-msg.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update-msg.png Binary files differdeleted file mode 100644 index e4c8ce84..00000000 --- a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update-msg.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update.png Binary files differdeleted file mode 100644 index be968dc7..00000000 --- a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/participant-deregistration.png b/docs/clamp/controlloop/images/clamp-cl-participants/participant-deregistration.png Binary files differdeleted file mode 100644 index bb2ec9a3..00000000 --- a/docs/clamp/controlloop/images/clamp-cl-participants/participant-deregistration.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/participant-registering.png b/docs/clamp/controlloop/images/clamp-cl-participants/participant-registering.png Binary files differdeleted file mode 100644 index eeae2e02..00000000 --- a/docs/clamp/controlloop/images/clamp-cl-participants/participant-registering.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png b/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png Binary files differdeleted file mode 100644 index e3e12538..00000000 --- a/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/defining-controlloops/fundamental-concepts.png b/docs/clamp/controlloop/images/defining-controlloops/fundamental-concepts.png Binary files differdeleted file mode 100644 index dc52a840..00000000 --- a/docs/clamp/controlloop/images/defining-controlloops/fundamental-concepts.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/defining-controlloops/gentle-guidance-controlloop.png b/docs/clamp/controlloop/images/defining-controlloops/gentle-guidance-controlloop.png Binary files differdeleted file mode 100644 index 3e0862fb..00000000 --- a/docs/clamp/controlloop/images/defining-controlloops/gentle-guidance-controlloop.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png b/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png Binary files differdeleted file mode 100644 index d23f89ab..00000000 --- a/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/gui/CamelDirectory.png b/docs/clamp/controlloop/images/gui/CamelDirectory.png Binary files differdeleted file mode 100644 index 798e24c1..00000000 --- a/docs/clamp/controlloop/images/gui/CamelDirectory.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/gui/ComponentFileStructure.png b/docs/clamp/controlloop/images/gui/ComponentFileStructure.png Binary files differdeleted file mode 100644 index 4e50be63..00000000 --- a/docs/clamp/controlloop/images/gui/ComponentFileStructure.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/gui/GUI-Architecture.png b/docs/clamp/controlloop/images/gui/GUI-Architecture.png Binary files differdeleted file mode 100644 index 9208b74e..00000000 --- a/docs/clamp/controlloop/images/gui/GUI-Architecture.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/gui/GUI-Flow.png b/docs/clamp/controlloop/images/gui/GUI-Flow.png Binary files differdeleted file mode 100644 index 8db058d1..00000000 --- a/docs/clamp/controlloop/images/gui/GUI-Flow.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/gui/ParticipantsDirectory.png b/docs/clamp/controlloop/images/gui/ParticipantsDirectory.png Binary files differdeleted file mode 100644 index 5c14e41d..00000000 --- a/docs/clamp/controlloop/images/gui/ParticipantsDirectory.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/gui/RuntimeControlloopDirectory.png b/docs/clamp/controlloop/images/gui/RuntimeControlloopDirectory.png Binary files differdeleted file mode 100644 index 10555037..00000000 --- a/docs/clamp/controlloop/images/gui/RuntimeControlloopDirectory.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/participants/http-participant.png b/docs/clamp/controlloop/images/participants/http-participant.png Binary files differdeleted file mode 100644 index 39dfdc46..00000000 --- a/docs/clamp/controlloop/images/participants/http-participant.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/participants/k8s-participant.png b/docs/clamp/controlloop/images/participants/k8s-participant.png Binary files differdeleted file mode 100644 index 55945bc3..00000000 --- a/docs/clamp/controlloop/images/participants/k8s-participant.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/participants/k8s-rest.png b/docs/clamp/controlloop/images/participants/k8s-rest.png Binary files differdeleted file mode 100644 index d08982a9..00000000 --- a/docs/clamp/controlloop/images/participants/k8s-rest.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/participants/participants.png b/docs/clamp/controlloop/images/participants/participants.png Binary files differdeleted file mode 100644 index 77b0b840..00000000 --- a/docs/clamp/controlloop/images/participants/participants.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/change-cl-instance-state-participants.png b/docs/clamp/controlloop/images/system-dialogues/change-cl-instance-state-participants.png Binary files differdeleted file mode 100644 index 8892f07d..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/change-cl-instance-state-participants.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/comissioning-clamp-gui.png b/docs/clamp/controlloop/images/system-dialogues/comissioning-clamp-gui.png Binary files differdeleted file mode 100644 index 473cf05b..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/comissioning-clamp-gui.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/comissioning-sdc.png b/docs/clamp/controlloop/images/system-dialogues/comissioning-sdc.png Binary files differdeleted file mode 100644 index 19f3f84d..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/comissioning-sdc.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/common-properties-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/common-properties-type-definition.png Binary files differdeleted file mode 100644 index 06fa8967..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/common-properties-type-definition.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/create-cl-instance.png b/docs/clamp/controlloop/images/system-dialogues/create-cl-instance.png Binary files differdeleted file mode 100644 index 88a67648..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/create-cl-instance.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/decommission-cl-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/decommission-cl-type-definition.png Binary files differdeleted file mode 100644 index c4051eee..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/decommission-cl-type-definition.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/deinstantiate-cl-from-participants.png b/docs/clamp/controlloop/images/system-dialogues/deinstantiate-cl-from-participants.png Binary files differdeleted file mode 100644 index 174250c0..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/deinstantiate-cl-from-participants.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/delete-cl-instance.png b/docs/clamp/controlloop/images/system-dialogues/delete-cl-instance.png Binary files differdeleted file mode 100644 index 8417017f..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/delete-cl-instance.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/depriming-cl-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/depriming-cl-type-definition.png Binary files differdeleted file mode 100644 index 60d97805..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/depriming-cl-type-definition.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/monitoring-by-participants.png b/docs/clamp/controlloop/images/system-dialogues/monitoring-by-participants.png Binary files differdeleted file mode 100644 index 69ceabf8..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/monitoring-by-participants.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/priming-cl-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/priming-cl-type-definition.png Binary files differdeleted file mode 100644 index 46f93480..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/priming-cl-type-definition.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/read-cl-instance.png b/docs/clamp/controlloop/images/system-dialogues/read-cl-instance.png Binary files differdeleted file mode 100644 index 611039b9..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/read-cl-instance.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/read-commision-cl-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/read-commision-cl-type-definition.png Binary files differdeleted file mode 100644 index 3a308787..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/read-commision-cl-type-definition.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/statistics-housekeeping.png b/docs/clamp/controlloop/images/system-dialogues/statistics-housekeeping.png Binary files differdeleted file mode 100644 index 6cbfda52..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/statistics-housekeeping.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/supervise-controlloops.png b/docs/clamp/controlloop/images/system-dialogues/supervise-controlloops.png Binary files differdeleted file mode 100644 index c24d3a09..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/supervise-controlloops.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/supervise-participants.png b/docs/clamp/controlloop/images/system-dialogues/supervise-participants.png Binary files differdeleted file mode 100644 index 2439d926..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/supervise-participants.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/update-cl-instance-config-participants.png b/docs/clamp/controlloop/images/system-dialogues/update-cl-instance-config-participants.png Binary files differdeleted file mode 100644 index f16ebc2b..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/update-cl-instance-config-participants.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/update-instance-params-cl.png b/docs/clamp/controlloop/images/system-dialogues/update-instance-params-cl.png Binary files differdeleted file mode 100644 index ec84ed35..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/update-instance-params-cl.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/view-monitoring-info.png b/docs/clamp/controlloop/images/system-dialogues/view-monitoring-info.png Binary files differdeleted file mode 100644 index 5937d2f1..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/view-monitoring-info.png +++ /dev/null diff --git a/docs/clamp/controlloop/images/system-dialogues/view-statistics.png b/docs/clamp/controlloop/images/system-dialogues/view-statistics.png Binary files differdeleted file mode 100644 index 451a5d92..00000000 --- a/docs/clamp/controlloop/images/system-dialogues/view-statistics.png +++ /dev/null |
