diff options
author | 2022-04-11 08:41:34 +0000 | |
---|---|---|
committer | 2022-04-11 08:41:34 +0000 | |
commit | 4236d55e6df1c17318995a65ad0a6e9411462456 (patch) | |
tree | c6a15d454197468cfe5a1335a5369bb7f4438296 /docs/clamp/acm | |
parent | c2e24ec6c9a3dab70f707744aa5bfda4f078b92e (diff) | |
parent | 12a315f76a189a4d3a00d6f0335dccf979b9608a (diff) |
Merge "Updating Clamp documentation"
Diffstat (limited to 'docs/clamp/acm')
17 files changed, 2046 insertions, 2172 deletions
diff --git a/docs/clamp/acm/acm-architecture.rst b/docs/clamp/acm/acm-architecture.rst index 6566a07a..ec2a656e 100644 --- a/docs/clamp/acm/acm-architecture.rst +++ b/docs/clamp/acm/acm-architecture.rst @@ -313,7 +313,7 @@ partake in automation compositions. 4. Other Considerations ======================= -.. _management-cl-instance-configs: +.. _management-acm-instance-configs: 4.1 Management of Automation Composition Instance Configurations ---------------------------------------------------------------- @@ -461,7 +461,7 @@ The APIs and Protocols used by CLAMP for Automation Compositions are described o The design and implementation of TOSCA Automation Compositions in CLAMP is described for each executable entity on the pages below: -#. :ref:`The CLAMP Automation Composition Runtime Server <clamp-acm-runtime>` +#. :ref:`The CLAMP Automation Composition Runtime Server <clamp-runtime-acm>` #. :ref:`CLAMP Automation Composition Participants <clamp-acm-participants>` #. :ref:`Managing Automation Compositions using The CLAMP GUI <clamp-gui-acm>` diff --git a/docs/clamp/acm/api-protocol/acm-rest-apis.rst b/docs/clamp/acm/api-protocol/acm-rest-apis.rst new file mode 100644 index 00000000..b71dae95 --- /dev/null +++ b/docs/clamp/acm/api-protocol/acm-rest-apis.rst @@ -0,0 +1,130 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _acm-rest-apis-label: + +REST APIs for CLAMP Automation Compositions +########################################### + + +Commissioning API +================= + +This API is a CRUD API that allows Automation Composition Type definitions created in a design +environment to be commissioned on the CLAMP runtime. It has endpoints that allow Automation +Composition 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 Automation Composition Type. The update and delete endpoints take a +reference to the Automation Composition Type. The incoming TOSCA is verified and checked for +referential integrity. On delete requests, a check is made to ensure that no Automation +Composition Instances exist for the Automation Composition Type to be deleted. + +.. swaggerv2doc:: swagger/acm-comissioning.json + + +Instantiation API +================= + +The instantiation API has two functions: + +#. Creation, Reading, Update, and Deletion of Automation Composition Instances. +#. Instantiation and lifecycle management of Automation Composition Instances on participants. + +The Instantiation API is used by the CLAMP GUI. + +Instantiation Automation Composition Instance CRUD +-------------------------------------------------- + +This sub API allows for the creation, read, update, and deletion of Automation Composition +Instances. The endpoints for create and update take a JSON body that describes the Automation +Composition Instance. The endpoints for read and delete take a Automation Composition Instance +ID to determine which Automation Composition Instance to act on. For the delete endpoint, a check +is made to ensure that the Automation Composition Instance is not instantiated on participants. + +A call to the update endpoint for a Automation Composition Instance follows the semantics described +here: :ref:`4.1 Management of Automation Composition Instance Configurations +<management-acm-instance-configs>`. + +.. swaggerv2doc:: swagger/acm-instantiation.json + + +Instantiation Automation Composition Instance Lifecycle Management +------------------------------------------------------------------ + +This sub API is used to manage the lifecycle of Automation Composition Instances. An Automation +Composition Instance can be in the states described here: :ref:`2.1 Automation Composition Instance +States <acm-instance-states>`. Managing the lifecycle of an Automation Composition Instance amounts +to steering the Automation Composition through its states. + +The sub API allows upgrades and downgrades of Automation Composition Instances to be pushed to +participants following the semantics described here: :ref:`4.1 Management of Automation Composition +Instance Configurations <management-acm-instance-configs>`. When the API is used to update the +participants on a Automation Composition Instance, the new/upgraded/downgraded definition of the +Automation Composition is pushed to the participants. Note that the API asks the participants in an +Automation Composition 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: :ref:`CLAMP +Participants <clamp-acm-participants>`. The progress and result of an update can be monitored +using the :ref:`Monitoring API <monitoring-api>`. + +The sub API also allows a state change of an Automation Composition Instance to be ordered. The +required state of the Automation Composition Instance is pushed to participants in an Automation +Composition Instance using the API. Note that the API asks the participants in an Automation +Composition 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: :ref:`CLAMP +Participants <clamp-acm-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, Automation Composition +Instances and their Automation Composition Elements to be monitored. This API is used by the CLAMP +GUI. The API provides filtering so that specific Participants and Automation Composition Instances +can be retrieved. In addition, the quantity of statistical information to be returned can be +scoped. + +.. swaggerv2doc:: swagger/acm-monitoring.json + +Pass Through API +================ + +This API allows information to be passed to Automation Composition Elements in an Automation +Composition. + +.. 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 Automation +Composition Elements. + +Kubernetes participant can also be deployed as a standalone application and provides REST endpoints +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 the local chart directory of Kubernetes participants. The onboarded charts can +be installed and uninstalled. The GET API fetches all the available helm charts from the chart +storage. + +.. swaggerv2doc:: swagger/k8sparticipant.json + + +Participant Simulator API +========================= + +This API allows a Participant Simulator to be started and run for test purposes. + +.. swaggerv2doc:: swagger/participant-sim.json + +End of Document diff --git a/docs/clamp/acm/api-protocol/api-protocol-tree.rst b/docs/clamp/acm/api-protocol/api-protocol-tree.rst index 95ce8f08..7cccf87b 100644 --- a/docs/clamp/acm/api-protocol/api-protocol-tree.rst +++ b/docs/clamp/acm/api-protocol/api-protocol-tree.rst @@ -12,4 +12,4 @@ The sections below describe the APIs and Protocols used in TOSCA Control Loops. system-level-dialogues acm-participant-protocol - controlloop-rest-apis + acm-rest-apis diff --git a/docs/clamp/acm/api-protocol/controlloop-rest-apis.rst b/docs/clamp/acm/api-protocol/controlloop-rest-apis.rst deleted file mode 100644 index cef2c2fb..00000000 --- a/docs/clamp/acm/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/acm/api-protocol/swagger/acm-comissioning.json b/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json new file mode 100644 index 00000000..ab77bd9e --- /dev/null +++ b/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json @@ -0,0 +1,815 @@ +{ + "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/automationcomposition/v2/commission": { + "get": { + "tags": [ + "Clamp Automation Composition Commissioning API" + ], + "summary": "Query details of the requested commissioned automation composition definitions", + "description": "Queries details of the requested commissioned automation composition definitions, returning all automation composition details", + "operationId": "queryUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Automation composition definition name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Automation composition 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": "Istanbul" + } + }, + "post": { + "tags": [ + "Clamp Automation Composition Commissioning API" + ], + "summary": "Commissions automation composition definitions", + "description": "Commissions automation composition definitions, returning commissioned definition IDs", + "operationId": "createUsingPOST", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Entity Body of Automation Composition", + "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": "Istanbul" + } + }, + "delete": { + "tags": [ + "Clamp Automation Composition Commissioning API" + ], + "summary": "Delete a commissioned automation composition", + "description": "Deletes a Commissioned Automation Composition, returning optional error details", + "operationId": "deleteUsingDELETE", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Automation composition definition name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Automation composition 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": "Istanbul" + } + } + }, + "/onap/automationcomposition/v2/commission/elements": { + "get": { + "tags": [ + "Clamp Automation Composition Commissioning API" + ], + "summary": "Query details of the requested commissioned automation composition element definitions", + "description": "Queries details of the requested commissioned automation composition element definitions, returning all automation composition elements' details", + "operationId": "queryElementsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Automation composition definition name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Automation composition 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": "Istanbul" + } + } + }, + "/onap/automationcomposition/v2/commission/getCommonOrInstanceProperties": { + "get": { + "tags": [ + "Clamp Automation Composition Commissioning API" + ], + "summary": "Query details of the requested tosca service template common or instance properties", + "description": "Queries details of the requested commissioned tosca service template json commonor instance properties, returning all tosca service template common or instance property details", + "operationId": "queryToscaServiceCommonOrInstancePropertiesUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "common", + "in": "query", + "description": "Flag, true for common properties, false for instance", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "name", + "in": "query", + "description": "Tosca service template name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Tosca service template 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": "object", + "additionalProperties": { + "$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": "Istanbul" + } + } + }, + "/onap/automationcomposition/v2/commission/toscaServiceTemplateSchema": { + "get": { + "tags": [ + "Clamp Automation Composition Commissioning API" + ], + "summary": "Query details of the requested tosca service template json schema", + "description": "Queries details of the requested commissioned tosca service template json schema, returning all tosca service template json schema details", + "operationId": "queryToscaServiceTemplateJsonSchemaUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "section", + "in": "query", + "description": "Section of Template schema is desired for", + "required": false, + "type": "string", + "default": "all" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "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": "Istanbul" + } + } + }, + "/onap/automationcomposition/v2/commission/toscaservicetemplate": { + "get": { + "tags": [ + "Clamp Automation Composition Commissioning API" + ], + "summary": "Query details of the requested tosca service templates", + "description": "Queries details of the requested commissioned tosca service template, returning all tosca service template details", + "operationId": "queryToscaServiceTemplateUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Tosca service template name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Tosca service template 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": "string" + } + }, + "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": "Istanbul" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json b/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json new file mode 100644 index 00000000..cdad2b61 --- /dev/null +++ b/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json @@ -0,0 +1,584 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/automationcomposition/v2/instantiation": { + "get": { + "tags": [ + "Clamp Automation Composition Instantiation API" + ], + "summary": "Query details of the requested automation compositions", + "description": "Queries details of the requested automation compositions, returning all composition details", + "operationId": "queryUsingGET_1", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Automation composition definition name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Automation composition 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/AutomationCompositionsRes", + "originalRef": "AutomationCompositionsRes" + } + }, + "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": "Istanbul" + } + }, + "post": { + "tags": [ + "Clamp Automation Composition Instantiation API" + ], + "summary": "Commissions automation composition definitions", + "description": "Commissions automation composition definitions, returning the automation composition IDs", + "operationId": "createUsingPOST_1", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "automationCompositions", + "description": "Entity Body of automation composition", + "required": true, + "schema": { + "$ref": "#/definitions/AutomationCompositionsReq", + "originalRef": "AutomationCompositionsReq" + } + }, + { + "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": "Istanbul" + } + }, + "put": { + "tags": [ + "Clamp Automation Composition Instantiation API" + ], + "summary": "Updates automation composition definitions", + "description": "Updates automation composition definitions, returning the updated composition definition IDs", + "operationId": "updateUsingPUT", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "automationCompositions", + "description": "Entity Body of Automation Composition", + "required": true, + "schema": { + "$ref": "#/definitions/AutomationCompositionsReq", + "originalRef": "AutomationCompositionsReq" + } + }, + { + "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": "Istanbul" + } + }, + "delete": { + "tags": [ + "Clamp Automation Composition Instantiation API" + ], + "summary": "Delete a automation composition", + "description": "Deletes a automation composition, returning optional error details", + "operationId": "deleteUsingDELETE_1", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Automation composition definition name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Automation composition 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/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": "Istanbul" + } + } + }, + "/onap/automationcomposition/v2/instantiation/command": { + "put": { + "tags": [ + "Clamp Automation Composition Instantiation API" + ], + "summary": "Issue a command to the requested automation compositions", + "description": "Issues a command to an automation composition, ordering a state change on the composition", + "operationId": "issueAutomationCompositionCommandUsingPUT", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "command", + "description": "Entity Body of automation composition 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": "Istanbul" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/clamp/acm/api-protocol/swagger/controlloop-monitoring.json b/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json index 84fbe7f0..2c177fa9 100644 --- a/docs/clamp/acm/api-protocol/swagger/controlloop-monitoring.json +++ b/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json @@ -12,13 +12,13 @@ } }, "paths": { - "/onap/controlloop/v2/monitoring/clelement": { + "/onap/automationcomposition/v2/monitoring/acelement": { "get": { "tags": [ - "Clamp Control Loop Monitoring API" + "Clamp Automation Composition Monitoring API" ], - "summary": "Query details of the requested cl element stats", - "description": "Queries details of the requested cl element stats, returning all clElement stats", + "summary": "Query details of the requested acElement stats", + "description": "Queries details of the requested acElement stats, returning all acElement stats", "operationId": "queryElementStatisticsUsingGET", "produces": [ "application/json", @@ -35,7 +35,7 @@ { "name": "id", "in": "query", - "description": "Control Loop element id", + "description": "Automation composition element id", "required": false, "type": "string" }, @@ -82,8 +82,8 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ClElementStatisticsList", - "originalRef": "ClElementStatisticsList" + "$ref": "#/definitions/AcElementStatisticsList", + "originalRef": "AcElementStatisticsList" } }, "401": { @@ -151,18 +151,18 @@ ], "x-interface info": { "api-version": "1.0.0", - "last-mod-release": "Dublin" + "last-mod-release": "Istanbul" } } }, - "/onap/controlloop/v2/monitoring/clelements/controlloop": { + "/onap/automationcomposition/v2/monitoring/acelements/automationcomposition": { "get": { "tags": [ - "Clamp Control Loop Monitoring API" + "Clamp Automation Composition 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", + "summary": "Query details of the requested acElement stats in a automation composition", + "description": "Queries details of the requested acElement stats, returning all acElement stats", + "operationId": "queryElementStatisticsPerAutomationCompositionUsingGET", "produces": [ "application/json", "application/yaml" @@ -171,14 +171,14 @@ { "name": "name", "in": "query", - "description": "Control Loop name", + "description": "Automation composition name", "required": true, "type": "string" }, { "name": "version", "in": "query", - "description": "Control Loop version", + "description": "Automation composition version", "required": true, "type": "string" }, @@ -195,8 +195,8 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ClElementStatisticsList", - "originalRef": "ClElementStatisticsList" + "$ref": "#/definitions/AcElementStatisticsList", + "originalRef": "AcElementStatisticsList" } }, "401": { @@ -264,14 +264,14 @@ ], "x-interface info": { "api-version": "1.0.0", - "last-mod-release": "Dublin" + "last-mod-release": "Istanbul" } } }, - "/onap/controlloop/v2/monitoring/participant": { + "/onap/automationcomposition/v2/monitoring/participant": { "get": { "tags": [ - "Clamp Control Loop Monitoring API" + "Clamp Automation Composition Monitoring API" ], "summary": "Query details of the requested participant stats", "description": "Queries details of the requested participant stats, returning all participant stats", @@ -291,7 +291,7 @@ { "name": "name", "in": "query", - "description": "Control Loop participant name", + "description": "Automation composition participant name", "required": false, "type": "string" }, @@ -314,7 +314,7 @@ { "name": "version", "in": "query", - "description": "Control Loop participant version", + "description": "Automation composition participant version", "required": false, "type": "string" }, @@ -400,18 +400,18 @@ ], "x-interface info": { "api-version": "1.0.0", - "last-mod-release": "Dublin" + "last-mod-release": "Istanbul" } } }, - "/onap/controlloop/v2/monitoring/participants/controlloop": { + "/onap/automationcomposition/v2/monitoring/participants/automationcomposition": { "get": { "tags": [ - "Clamp Control Loop Monitoring API" + "Clamp Automation Composition Monitoring API" ], - "summary": "Query details of all the participant stats in a control loop", + "summary": "Query details of all the participant stats in a automation composition", "description": "Queries details of the participant stats, returning all participant stats", - "operationId": "queryParticipantStatisticsPerControlLoopUsingGET", + "operationId": "queryParticipantStatisticsPerAutomationCompositionUsingGET", "produces": [ "application/json", "application/yaml" @@ -420,14 +420,14 @@ { "name": "name", "in": "query", - "description": "Control Loop name", + "description": "Automation composition name", "required": true, "type": "string" }, { "name": "version", "in": "query", - "description": "Control Loop version", + "description": "Automation composition version", "required": true, "type": "string" }, @@ -513,7 +513,7 @@ ], "x-interface info": { "api-version": "1.0.0", - "last-mod-release": "Dublin" + "last-mod-release": "Istanbul" } } } diff --git a/docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.json b/docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.json deleted file mode 100644 index 8fa09368..00000000 --- a/docs/clamp/acm/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/acm/api-protocol/swagger/controlloop-instantiation.json b/docs/clamp/acm/api-protocol/swagger/controlloop-instantiation.json deleted file mode 100644 index 12542425..00000000 --- a/docs/clamp/acm/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/acm/api-protocol/swagger/participant-sim.json b/docs/clamp/acm/api-protocol/swagger/participant-sim.json index 79fc3011..2111b607 100644 --- a/docs/clamp/acm/api-protocol/swagger/participant-sim.json +++ b/docs/clamp/acm/api-protocol/swagger/participant-sim.json @@ -1,478 +1,478 @@ { - "swagger": "2.0", - "info": { - "description": "Api Documentation", - "version": "1.0", - "title": "Api Documentation", - "termsOfService": "urn:tos", - "contact": {}, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" + "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 Automation Composition Participant Simulator API" + ], + "summary": "Updates simulated automation composition elements", + "description": "Updates simulated automation composition elements, returning the updated automation composition definition IDs", + "operationId": "updateUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Body of a automation composition element", + "required": true, + "schema": { + "$ref": "#/definitions/AutomationCompositionElementReq", + "originalRef": "AutomationCompositionElementReq" + } + }, + { + "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«AutomationCompositionElement»", + "originalRef": "TypedSimpleResponse«AutomationCompositionElement»" + } + }, + "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" } + } }, - "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 Automation Composition Participant Simulator API" + ], + "summary": "Query details of the requested simulated automation composition elements", + "description": "Queries details of the requested simulated automation composition elements, returning all automation composition element details", + "operationId": "elementsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Automation composition element name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Automation composition 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/AutomationCompositionElementRes", + "originalRef": "AutomationCompositionElementRes" + } } - }, - "/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" - } + }, + "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" + } + } + } }, - "/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" - } + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/participants": { + "put": { + "tags": [ + "Clamp Automation Composition Participant Simulator API" + ], + "summary": "Updates simulated participants", + "description": "Updates simulated participants, returning the updated automation composition 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" + } + } + } }, - "/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" - } + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/participants/{name}/{version}": { + "get": { + "tags": [ + "Clamp Automation Composition 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/acm/controlloop-architecture.rst b/docs/clamp/acm/controlloop-architecture.rst deleted file mode 100644 index 1c09bea0..00000000 --- a/docs/clamp/acm/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-runtime-acm>` -#. :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/acm/design-impl/clamp-gui-controlloop.rst b/docs/clamp/acm/design-impl/clamp-gui-controlloop.rst index 41e3558c..28bebe90 100644 --- a/docs/clamp/acm/design-impl/clamp-gui-controlloop.rst +++ b/docs/clamp/acm/design-impl/clamp-gui-controlloop.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. _clamp-gui-controlloop: +.. _clamp-gui-acm: The Policy GUI for Control Loops ******************************** diff --git a/docs/clamp/acm/design-impl/participants/http-participant.rst b/docs/clamp/acm/design-impl/participants/http-participant.rst index be0349ea..f58f03d2 100644 --- a/docs/clamp/acm/design-impl/participants/http-participant.rst +++ b/docs/clamp/acm/design-impl/participants/http-participant.rst @@ -35,7 +35,7 @@ participant is running two HTTP Automation Composition Elements, one for Automat Automation Composition B. Configuring a Automation Composition Element on the HTTP participant for a Automation Composition ------------------------------------------------------------------------------ +------------------------------------------------------------------------------------------------- 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 Automation Composition Element to manage and diff --git a/docs/clamp/acm/design-impl/participants/k8s-participant.rst b/docs/clamp/acm/design-impl/participants/k8s-participant.rst index 9de18070..366c8430 100644 --- a/docs/clamp/acm/design-impl/participants/k8s-participant.rst +++ b/docs/clamp/acm/design-impl/participants/k8s-participant.rst @@ -44,7 +44,7 @@ Sample tosca template defining a participant and a automation composition elemen Configuring a Automation Composition Element on the kubernetes participant for a Automation Composition ------------------------------------------------------------------------------------ +------------------------------------------------------------------------------------------------------- The user configures the following properties in the TOSCA template for the kubernetes participant: diff --git a/docs/clamp/acm/design-impl/participants/participant-intermediary.rst b/docs/clamp/acm/design-impl/participants/participant-intermediary.rst index 95c1a7ac..d9d24ceb 100644 --- a/docs/clamp/acm/design-impl/participants/participant-intermediary.rst +++ b/docs/clamp/acm/design-impl/participants/participant-intermediary.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. _clamp-clamp-acm-participant-intermediary: +.. _clamp-acm-participant-intermediary: Participant Intermediary ######################## @@ -58,55 +58,55 @@ Design of a PARTICIPANT_DEREGISTER message - Participant is not monitored. Design of a creation of an Automation Composition 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 an Automation Composition 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 Automation Composition 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 an Automation Composition --------------------------------------- +------------------------------------------------- - AUTOMATION_COMPOSITION_UPDATE message with instantiation details and UNINITIALISED state is sent to participants - Participant-intermediary validates the current state change - Participant-intermediary will recieve AUTOMATION_COMPOSITION_UPDATE message and sends the details of AutomationCompositionElements to participants - Each participant performs its designated job of deployment by interacting with respective frameworks Design of a deletion of an Automation Composition --------------------------------------- +------------------------------------------------- - AUTOMATION_COMPOSITION_STATE_CHANGE message with UNINITIALISED state is sent to participants - Participant-intermediary validates the current state change - Participant-intermediary will recieve AUTOMATION_COMPOSITION_STATE_CHANGE message and sends the details of AutomationCompositionElements to participants - Each participant performs its designated job of undeployment by interacting with respective frameworks Design of "issues automation composition commands to automation compositions" - case UNINITIALISED to PASSIVE ------------------------------------------------------------------------------------------ +------------------------------------------------------------------------------------------------------------- - AUTOMATION_COMPOSITION_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 AUTOMATION_COMPOSITION_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 automation composition commands to automation compositions" - case PASSIVE to UNINITIALISED ------------------------------------------------------------------------------------------ +------------------------------------------------------------------------------------------------------------- - AUTOMATION_COMPOSITION_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 AUTOMATION_COMPOSITION_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 automation composition commands to automation compositions" - case PASSIVE to RUNNING ------------------------------------------------------------------------------------ +------------------------------------------------------------------------------------------------------- - AUTOMATION_COMPOSITION_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 AUTOMATION_COMPOSITION_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 automation composition commands to automation compositions" - case RUNNING to PASSIVE ------------------------------------------------------------------------------------ +------------------------------------------------------------------------------------------------------- - AUTOMATION_COMPOSITION_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 AUTOMATION_COMPOSITION_STATE_CHANGE message and sends the details of state change to participants @@ -119,7 +119,7 @@ Design of a PARTICIPANT_STATUS message - 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 AUTOMATIONCOMPOSITION_UPDATE_ACK message ------------------------------------------- +---------------------------------------------------- - A participant sends AUTOMATIONCOMPOSITION_UPDATE_ACK message in response to a AUTOMATIONCOMPOSITION_UPDATE message. - For each CL-elements moved to the ordered state as indicated by the AUTOMATIONCOMPOSITION_UPDATE - AutomationCompositionUpdateAckListener in CL-runtime collects the messages from DMaap diff --git a/docs/clamp/acm/design-impl/participants/participants.rst b/docs/clamp/acm/design-impl/participants/participants.rst index 15aee04d..9cf38bc7 100644 --- a/docs/clamp/acm/design-impl/participants/participants.rst +++ b/docs/clamp/acm/design-impl/participants/participants.rst @@ -1,9 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. _clamp-controlloop-participants: +.. _clamp-acm-participants: -Control Loop Participants -######################### +Automation Composition Participants +################################### A Participant is a component that acts as a bridge between the CLAMP Automation Composition Management runtime and components such as the Policy Framework, DCAE, or a Kubernetes cluster that are taking part in automation composition management. It listens diff --git a/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst b/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst index 1ef38b3e..9ce120c0 100644 --- a/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst +++ b/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst @@ -54,7 +54,7 @@ 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 Automation Composition Element. #. It checks if a Policy Type with that Policy Type ID has been specified in the ToscaServiceTemplateFragment field in - the AutomationCompositionElement definition in the AutomationCompositionUpdate message, see :ref:`clampacm-participant-protocol-label`. + the AutomationCompositionElement definition in the AutomationCompositionUpdate message, see :ref:`acm-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. @@ -70,7 +70,7 @@ The Policy Participant uses the following steps for Policy References: #. The Policy Participant reads the Policy ID from the policyId property specified for the Automation Composition Element. #. It checks if a Policy with that Policy ID has been specified in the ToscaServiceTemplateFragment field in the - AutomationCompositionElement definition in the AutomationCompositionUpdate message, :ref:`clampacm-participant-protocol-label`. + AutomationCompositionElement definition in the AutomationCompositionUpdate message, :ref:`acm-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. |