diff options
50 files changed, 3618 insertions, 122 deletions
@@ -14,3 +14,4 @@ docs/conf.pyc docs/html/ docs/_static/ docs/__pycache__/ +.vscode/ diff --git a/docs/clamp/clamp.rst b/docs/clamp/clamp.rst index 0b270d3e..3c6a9105 100644 --- a/docs/clamp/clamp.rst +++ b/docs/clamp/clamp.rst @@ -12,4 +12,7 @@ CLAMP handles control loops in two ways, either using built in ONAP Control Loop clamp/clamp controlloop/controlloop - + controlloop/system-level-dialogues + controlloop/defining-controlloops + controlloop/controlloop-participant-protocol + controlloop/controlloop-rest-apis diff --git a/docs/clamp/controlloop/controlloop-participant-protocol.rst b/docs/clamp/controlloop/controlloop-participant-protocol.rst new file mode 100644 index 00000000..208c5659 --- /dev/null +++ b/docs/clamp/controlloop/controlloop-participant-protocol.rst @@ -0,0 +1,472 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _controlloop-participant-protocol-label: + +The CLAMP Control Loop Participant Protocol +########################################### + +The CLAMP Control Loop Participant protocol is an asynchronous protocol that is used by the +CLAMP runtime to coordinate life cycle management of Control Loop instances. The protocol +supports the functions described in the sections below. + + +Protocol Dialogues +================== + +The protocol supports the dialogues described below. + +Participant Registration and De-Registration +-------------------------------------------- + +Registration when a participant comes up and update of participant with control loop type +information and common parameter values for its control loop types. + +.. image:: images/clamp-cl-participants/participant-registering.png + + +De-registration is executed as a participant goes down. + +.. image:: images/clamp-cl-participants/participant-deregistration.png + + +Control Loop Priming and De-Priming +----------------------------------- + +When a control loop is primed, the portion of the Control Loop Type Definition and Common +Property values for the participants of each participant type mentioned in the Control Loop +Definition are sent to the participants. + +.. image:: images/clamp-cl-participants/controlloop-priming.png + +When a control loop is de-primed, the portion of the Control Loop Type Definition and Common +Property values for the participants of each participant type mentioned in the Control Loop +Definition are deleted on participants. + +.. image:: images/clamp-cl-participants/controlloop-depriming.png + + +Control Loop Update +------------------- + +Control Loop Update handles creation, change, and deletion of control loops on participants. +Change of control loops uses a semantic versioning approach and follow the semantics described +on the page `4.1 Management of Control Loop Instance Configurations <management-cl-instance-configs>`. + +.. image:: images/clamp-cl-participants/controlloop-update.png + +The handling of a ControlLoopUpdate message in each participant is as shown below. + +.. image:: images/clamp-cl-participants/controlloop-update-msg.png + +Control Loop State Change +------------------------- + +This dialogue is used to change the state of Control Loops and their Control Loop Elements. The +CLAMP Runtime sends a Control Loop State Change message on the control loop to all participants. +Participants that have Control Loop Elements in that Control Loop attempt an update on the state +of the control loop elements they have for that control loop, and report the result back. + +The *startPhase* in the `Definition of TOSCA fundamental Control Loop Types +<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/ControlLoopTOSCAServiceTemplateTypes.yaml>`_ +is particularly important in control loop state changes because sometime the user wishes to control +the order in which the state changes in Control Loop Elements in a control loop. In state changes +from *UNITITIALISED* → *PASSIVE* and from *PASSIVE* → *RUNNING*, control loop elements are started in +increasing order of their *startPhase*. In state changes from *RUNNING* → *PASSIVE* and from *PASSIVE* +→ *UNITITIALISED*, control loop elements are started in decreasing order of their *startPhase*. + +The CLAMP runtime controls the state change process described in the diagram below. The CLAMP runtime +sends a Control Loop State Change message on DMaaP to all participants in a particular Start Phase so, +in each state change multiple Control Loop State Change messages are sent, one for each Start Phase in +the control loop. If more than one Control Loop Element has the same Start Phase, those Control Loop +Elements receive the same Control Loop State Change message from DMaaP and start in parallel. + +The Participant reads each State Change Message it sees on DMaaP. If the Start Phase on the Control +Loop State Change message matches the Start Phase of the Control Loop Element, the participant processes +the State Change message. Otherwise the participant ignores the message. + +.. image:: images/clamp-cl-participants/controlloop-state-change.png + +The handling of a ControlLoopStateChange message in each participant is as shown below. + +.. image:: images/clamp-cl-participants/controlloop-state-change-msg.png + +Control Loop Monitoring and Reporting +------------------------------------- + +This dialogue is used as a heartbeat mechanism for participants, to monitor the status of Control Loop +Elements, and to gather statistics on control loops. The ParticipantStatus message is sent periodically +by each participant. The reporting interval for sending the message is configurable. + +.. image:: images/clamp-cl-participants/controlloop-monitoring.png + + +Messages +======== + +The CLAMP Control Loop Participant Protocol uses the following messages. The descriptions below give +an overview of each message. For the precise definition of the messages, see the `CLAMP code at Github +<https://github.com/onap/policy-clamp/tree/master/models/src/main/java/org/onap/policy/clamp/controlloop/models/messages/dmaap/participant>`_ +. All messages are carried on DMaaP. + + +.. list-table:: + :widths: 15 10 10 15 15 35 + :header-rows: 1 + + * - Message + - Source + - Target + - Purpose + - Important Fields + - Field Descriptions + * - ParticipantRegister + - Participant + - CLAMP Runtime + - Participant registers with the CLAMP runtime + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - ParticipantRegisterAck + - CLAMP Runtime + - Participant + - Acknowledgement of Participant Registration + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ParticipantUpdate + - CLAMP Runtime + - Participant + - CLAMP Runtime sends Control Loop Element Definitions and Common Parameter Values to Participants + - ParticipantDefinitionUpdateMap + - Map with Participant ID as its key, each value on the map is a ControlLoopElementDefintionMap + * - + - + - + - + - ControlLoopElementDefintionMap + - List of ControlLoopElementDefinition values for a particular participant, keyed by its Control + Loop Element Definition ID + * - + - + - + - + - ControlLoopElementDefinition + - A ControlLoopElementToscaServiceTemplate containing the definition of the Control Loop Element + and a CommonPropertiesMap with the values of the common property values for Control Loop Elements + of this type + * - + - + - + - + - ControlLoopElementToscaServiceTemplate + - The definition of the Control Loop Element in TOSCA + * - + - + - + - + - CommonPropertiesMap + - A <String, String> map indexed by the property name. Each map entry is the serialized value of + the property, which can be deserialized into an instance of the type of the property. + * - ParticipantUpdateAck + - Participant + - CLAMP Runtime + - Acknowledgement of Participant Update + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ParticipantDeregister + - Participant + - CLAMP Runtime + - Participant deregisters with the CLAMP runtime + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - ParticipantDeregisterAck + - CLAMP Runtime + - Participant + - Acknowledgement of Participant Deegistration + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ControlLoopUpdate + - CLAMP Runtime + - Participant + - CLAMP Runtime sends Control Loop Element instances and Instance Specific Parameter Values for + a Control Loop Instance to Participants + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - ParticipantUpdateMap + - Map with Participant ID as its key, each value on the map is a ControlLoopElementList + * - + - + - + - + - ControlLoopElementList + - List of ControlLoopElement values for the Control Loop + * - + - + - + - + - ControlLoopElement + - A ControlLoopElement, which contains among other things a PropertiesMap with the values of the + property values for this Control Loop Element instance and a ToscaServiceTemplateFragment with + extra concept definitions and instances that a participant may need. + * - + - + - + - + - PropertiesMap + - A <String, String> map indexed by the property name. Each map entry is the serialized value of + the property, which can be deserialized into an instance of the type of the property. + * - + - + - + - + - ToscaServiceTemplateFragment + - A well-formed TOSCA service template containing extra concept definitions and instances that a + participant may need. For example, the Policy Participant may need policy type definitions or + policy instances to be provided if they are not already stored in the Policy Framework. + * - ControlLoopUpdateAck + - Participant + - CLAMP Runtime + - Acknowledgement of Control Loop Update + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - ControlLoopResult + - Holds a Result and Message for the overall operation on the participant and a map of Result + and Message fields for each Control Loop Element of the control loop on this participant + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ControlLoopStateChange + - CLAMP Runtime + - Participant + - CLAMP Runtime asks Participants to change the state of a Control Loop + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - currentState + - The current state of the Control Loop + * - + - + - + - + - orderedState + - The state that the Control Loop should transition to + * - + - + - + - + - startPhase + - The start phase to which this ControLoopStateChange message applies + * - ControlLoopStateChangeAck + - Participant + - CLAMP Runtime + - Acknowledgement of Control Loop State Change + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - startPhase + - The start phase to which this ControLoopStateChangeAck message applies + * - + - + - + - + - ControlLoopResult + - Holds a Result and Message for the overall operation on the participant and a map of Result and + Message fields for each Control Loop Element of the control loop on this participant + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ParticipantStatusReq + - CLAMP Runtime + - Participant + - Request that the specified participants return a ParticipantStatus message immediately + - ParticipantId + - The ID of this participant, if not specified, all participants respond. + * - ParticipantStatus + - Participant + - CLAMP Runtime + - Periodic or on-demand report for heartbeat, Participant Status, Control Loop Status, and Control + Loop Statistics + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop + Type Definitions + * - + - + - + - + - ParticipantDefinitionUpdateMap (returned in repsonse to ParticipantStatusReq only) + - See ParticipantUpdate message above for definition of this field + * - + - + - + - + - ParticipantStatus + - The current status of the participant for monitoring + * - + - + - + - + - ParticipantStatistics + - Statistics on the participant such as up time, or messages processed. Can include participant + specific data in a string blob that is opaque to CLAMP + * - + - + - + - + - ControlLoopInfoMap + - A map of ControlLoopInfo types indexed by ControlLoopId, one entry for each control loop + running on the participant + * - + - + - + - + - ControlLoopInfo + - The ControlLoopStatus and ControlLoopStatistics for a given control loop + * - + - + - + - + - ControlLoopStatus + - The current status of the control loop for monitoring + * - + - + - + - + - ControlLoopStatistics + - Statistics on the control loop such as up time, or messages processed. Can include participant + specific data in a string blob that is opaque to CLAMP + + +End of Document diff --git a/docs/clamp/controlloop/controlloop-rest-apis.rst b/docs/clamp/controlloop/controlloop-rest-apis.rst new file mode 100644 index 00000000..1012e53f --- /dev/null +++ b/docs/clamp/controlloop/controlloop-rest-apis.rst @@ -0,0 +1,130 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _controlloop-rest-apis-label: + +REST APIs for CLAMP Control Loops +################################# + + +Commissioning API +================= + +This API is a CRUD API that allows Control Loop Type definitions created in a design +environment to be commissioned on the CLAMP runtime. It has endpoints that allow Control +Loop Types to be created, read, updated, and deleted. + +The body of the create and update end points is a TOSCA Service/Topology template that +defines the new or changed Control Loop Type. The update and delete endpoints take a +reference to the Control Loop Type. The incoming TOSCA is verified and checked for +referential integrity. On delete requests, a check is made to ensure that no Control +Loop Instances exist for the Control Loop Type to be deleted. + +:download:`Download Policy Control Loop Commissioning API Swagger <swagger/controlloop-comissioning.json.json>` + +.. swaggerv2doc:: swagger/controlloop-comissioning.json + + +Instantiation API +================= + +The instantiation API has two functions: + +#. Creation, Reading, Update, and Deletion of Control Loop Instances. +#. Instantiation and lifecycle management of Control Loop Instances on participants + +The Instantiation API is used by the CLAMP GUI. + +Instantiation Control Loop Instance CRUD +---------------------------------------- + +This sub API allows for the creation, read, update, and deletion of Control Loop Instances. +The endpoints for create and update take a JSON body that describes the Control Loop Instance. +The endpoints for read and delete take a Control Loop Instance ID to determine which Control +Loop Instance to act on. For the delete endpoint, a check is made to ensure that the Control +Loop Instance is not instantiated on participants. + +A call to the update endpoint for a Control Loop Instance follow the semantics described here: +`4.1 Management of Control Loop Instance Configurations <management-cl-instance-configs>`. + +:download:`Download Policy Control Loop Instantiation API Swagger <swagger/controlloop-instantiation.json>` + +.. swaggerv2doc:: swagger/controlloop-instantiation.json + + +Instantiation Control Loop Instance Lifecycle Management +-------------------------------------------------------- + +This sub API is used to manage the life cycle of Control Loop Instances. A Control Loop Instance +can be in the states described here: `2.1 Control Loop Instance States <controlloop-instance-states>`. +Managing the life cycle of a Control Loop Instance amounts to steering the Control Loop through +its states. + +The sub API allows upgrades and downgrades of Control Loop Instances to be pushed to participants +following the semantics described here: `4.1 Management of Control Loop Instance Configurations +<management-cl-instance-configs>`. When the API is used to update the participants on a Control +Loop Instance, the new/upgraded/downgraded definition of the Control Loop is pushed to the +participants. Note that the API asks the participants in a Control Loop Instance to perform the +update, it is the responsibility of the participants to execute the update and report the result +using the protocols described here: `CLAMP Participants <#>`_. The progress and result of an update +can be monitored using the `Monitoring API <monitoring-api>`. + +The sub API also allows a state change of a Control Loop Instance to be ordered. The required state +of the Control Loop Instance is pushed to participants in a Control Loop Instance using the API. +Note that the API asks the participants in a Control Loop Instance to perform the state change, it +is the responsibility of the participants to execute the state change and report the result using +the protocols described here: CLAMP Participants. The progress and result of a state change can be +monitored using the `Monitoring API <monitoring-api>`. + +.. warning:: + The Swagger for the Instantiation Lifecycle Management API will appear here. + +.. _monitoring-api: + +Monitoring API +============== + +The Monitoring API allows the state and statistics of Participants, Control Loop Instances and their Control Loop Elements to be monitored. This API is used by the CLAMP GUI. The API provides filtering so that specific Participants and Control Loop Instances can be retrieved. In addition, the quantity of statistical information to be returned can be scoped. + +:download:`Download Policy Control Loop Monitoring API Swagger <swagger/controlloop-monitoring.json>` + +.. swaggerv2doc:: swagger/controlloop-monitoring.json + +Pass Through API +================ + +This API allows information to be passed to Control Loop Elements in a control loop. + +.. warning:: + The requirements on this API are still under discussion. + +.. warning:: + The Swagger for the Pass Through API will appear here. + + +Participant Standalone API +========================== + +This API allows a Participant to run in standalone mode and to run standalone Control Loop Elements. + +Kubernetes participant can also be deployed as a standalone application and provides REST end points +for onboarding helm charts to its local chart storage, installing and uninstalling of helm charts to +a kubernetes cluster. It also allows to configure a remote repository in kubernetes participant for +installing helm charts. User can onboard a helm chart along with the overrides yaml file, the chart +gets stored in to the local chart directory of kubernetes participant. The onboarded charts can be +installed, uninstalled. The GET API fetches all the available helm charts from the chart storage. + +:download:`Download Policy Control Loop Participant Standalone API Swagger <swagger/k8sparticipant.json>` + +.. swaggerv2doc:: swagger/k8sparticipant.json + + +Participant Simulator API +========================= + +This API allows a Participant Simulator to be started and run for test purposes. + +:download:`Download Policy Participant Simulator API Swagger <swagger/participant-sim.json>` + +.. swaggerv2doc:: swagger/participant-sim.json + +End of Document diff --git a/docs/clamp/controlloop/controlloop.rst b/docs/clamp/controlloop/controlloop.rst index db438e02..4cf242ba 100644 --- a/docs/clamp/controlloop/controlloop.rst +++ b/docs/clamp/controlloop/controlloop.rst @@ -10,21 +10,23 @@ CLAMP Metadata Control Loop Automation Management using TOSCA :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 this -paper for some background. However, it is only with the advent of ONAP that we have a platform -that supports control loops for network management. Before ONAP, Control Loops have been -implemented by hard-coding components together and hard coding logic into components. ONAP -has taken a step forward towards automatic implementation of Control Loops by allowing -parameterization of Control Loops that work on the premise that the Control Loops use a set -of analytic, policy, and control components connected together in set ways. +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. The TOSCA description is then used to commission, instantiate, and manage -the Control Loops in the run time system. +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 @@ -92,6 +94,7 @@ concepts are defined at design time and are passed to the runtime in a TOSCA doc 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 ============== @@ -217,8 +220,9 @@ At Run Time, the following Control Loop Life Cycle management capabilities are s .. note:: The system dialogues for run time capabilities are described in detail on the - System Level Dialogues page. + :ref:`System Level Dialogues <system-level-label>` page. +.. _controlloop-instance-states: 2.1 Control Loop Instance States -------------------------------- @@ -293,7 +297,8 @@ A Participant runs Control Loop Elements and manages and reports on their life c 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 +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 @@ -308,6 +313,8 @@ partake in control loops. 4. Other Considerations ======================= +.. _management-cl-instance-configs: + 4.1 Management of Control Loop Instance Configurations ------------------------------------------------------ @@ -315,33 +322,34 @@ In order to keep management of versions of the configuration of control loop ins 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. +the **major.minor.patch** number of the version. -Note that a configuration means a full set of parameter values for a Control Loop Instance. +.. 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 **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 **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. +#. 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 **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. +#. If a Control Loop Element has a **major** version change, then its Control Loop Instance + must have a **major** version change. 4.2 Scalability --------------- @@ -389,15 +397,18 @@ of many types across themselves using a mechanism such as a Kubernetes cluster. At runtime, interaction between ONAP platform services and application microservices are relatively unconstrained, so interactions between Control Loop Elements for a given Control -Loop Instance remain relatively unconstrained. A proposal to support access-controlled access -to and between ONAP services will improve this. This can be complemented by intercepting and -controlling services accesses between Control Loop Elements for Control Loop Instances for -some/all Control Loop types. - -API gateways such as Kong have emerged as a useful technology for exposing and controlling -service endpoint access for applications and services. When a Control Loop Type is onboarded, -or when Control Loop Instances are created in the Participants, CLAMP can configure service -endpoints between Control Loop Elements to redirect through an API Gateway. +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. @@ -440,10 +451,10 @@ in isolated namespaces or in dedicated workers/clusters; etc.. The APIs and Protocols used by CLAMP for Control Loops are described on the pages below: -#. System Level Dialogues -#. Defining Control Loops in TOSCA for CLAMP -#. REST APIs for CLAMP Control Loops -#. The CLAMP Control Loop Participant Protocol +#. :ref:`System Level Dialogues <system-level-label>` +#. :ref:`Defining Control Loops in TOSCA for CLAMP <defining-controlloops-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 @@ -456,3 +467,5 @@ The design and implementation of TOSCA Control Loops in CLAMP is described for e #. The CLAMP GUI #. Building and running CLAMP #. Testing CLAMP + +End of Document diff --git a/docs/clamp/controlloop/defining-controlloops.rst b/docs/clamp/controlloop/defining-controlloops.rst new file mode 100644 index 00000000..dad5ff1a --- /dev/null +++ b/docs/clamp/controlloop/defining-controlloops.rst @@ -0,0 +1,294 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _defining-controlloops-label: + +Defining Control Loops in TOSCA for CLAMP +######################################### + + +.. contents:: + :depth: 4 + + +A Control Loop Type is defined in a TOSCA service template. A TOSCA Service Template has +two parts: a definition part in the service template itself, which contains the definitions +of concepts that can be used to define the types of concepts that can appear on a Toplogy +Template and a Topology Template that defines a topology. See the `Oasis Open TOSCA +<https://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.3/>`_ web page +for more details on TOSCA. + +Unsurprisingly, to define a Control Loop Type in TOSCA, of Control Loop related concepts +that we can use in all control loops exist. They are described in Section 1. Section 2 +describes how properties are managed. Properties are the configuration parameters that are +provided to Control Loops and the Control Loop Elements they use. Section 3 describes how to +define a Control Loop using the predefined Control Loop concepts. + + +1 Standard TOSCA Service Template Concepts for Control Loops +============================================================ + +These concepts are the base concepts available to users who write definitions for control +loops in TOSCA. TOSCA control loop definitions are written using these concepts. + +1.1 Fundamental TOSCA Concepts for Control Loops +------------------------------------------------ + +The following TOSCA concepts are the fundamental concepts in a TOSCA Service Template for +defining control loops. + +.. image:: images/defining-controlloops/fundamental-concepts.png + +The TOSCA concepts above may be declared in the TOSCA Service Template of a control loop. +If the concepts already exist in the Design Time Catalogue or the Runtime Inventory, they +may be omitted from a TOSCA service template that defines a control loop type. + +The *start_phase* is a value indicating the start phase in which this control loop element +will be started, the first start phase is zero. Control Loop Elements are started in their +start_phase order and stopped in reverse start phase order. Control Loop Elements with the +same start phase are started and stopped simultaneously. + +The Yaml file that holds the Definition of `TOSCA fundamental Control Loop Types is available in Github +<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/ControlLoopTOSCAServiceTemplateTypes.yaml>`_ +and is the canonical definition of the Control Loop concepts. + +1.2 TOSCA Concepts for Control Loop Elements delivered by ONAP +-------------------------------------------------------------- + +TOSCA Standard Control Loop Elements + +.. image:: images/defining-controlloops/standard-cle.png + +1.2.1 Policy Control Loop Element +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Policy Participant runs Policy Control Loop Elements. Each Policy Control Loop Element +manages the deployment of the policy specified in the Policy Control Loop Element definition. +The Yaml file that holds the `Policy Control Loop Element Type definition is available in Github +<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/PolicyControlLoopElementType.yaml>`_ +and is the canonical definition of the Policy Control Loop Element type. For a description of +the Policy Control Loop Element and Policy Participant, please see `The CLAMP Policy Framework +Participant <#>`_ page. + +1.2.2 HTTP Control Loop Element +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The HTTP Participant runs HTTP Control Loop Elements. Each HTTP Control Loop Element manages +REST communication towards a REST endpoint using the REST calls a user has specified in the +configuration of the HTTP Control Loop Element. The Yaml file that holds the +`HTTP Control Loop Element Type definition is available in Github +<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/HttpControlLoopElementType.yaml>`_ +and is the canonical definition of the HTTP Control Loop Element type. For a description of +the HTTP Control Loop Element and HTTP Participant, please see `The CLAMP HTTP Participant <#>`_ page. + +.. _kubernetes-cl-element: + +1.2.3 Kubernetes Control Loop Element +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Kubernetes Participant runs Kubernetes Control Loop Elements. Each Kubernetes Control Loop +Element manages a Kubernetes microservice using Helm. The user defines the Helm chart for the +Kubernetes microservice as well as other properties that the microservice requires in order to +execute. The Yaml file that holds the +`Kubernetes Control Loop Element Type defintion is available in Github +<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/KubernetesControlLoopElementType.yaml>`_ +and is the canonical definition of the Kubernetes Control Loop Element type. For a description +of the Kubernetes Control Loop Element and Kubernetes Participant,please see +`The CLAMP Kubernetes Participant <#>`_ page. + +1.2.4 CDS Control Loop Element +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The CDS Participant runs CDS Control Loop Elements. Each CDS Control Loop Element manages the +deployment of the CDS blueprint specified in the CDS Control Loop Element definition. The Yaml +file that holds the `CDS Control Loop Element Type definition is available in Github +<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/CdsControlLoopElementType.yaml>`_ +and is the canonical definition of the CDS Control Loop Element type. For a description of the +CDS Control Loop Element and CDS Participant, please see `The CLAMP CDS Participant page <#>`_. + +1.2.5 DCAE Participant +~~~~~~~~~~~~~~~~~~~~~~ + +The DCAE Participant runs DCAE Control Loop Elements. Each DCAE Control Loop Element manages +a DCAE microservice on DCAE. The user defines the DCAE blueprint for the DCAE microservice as +well as other properties that the microservice requires in order to execute. The Yaml file that +holds the `DCAE Control Loop Type definition is available in Github +<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/DcaeControlLoopElementType.yaml>`_ +and is the canonical definition of the DCAE Control Loop Element type. For a description of +the DCAE Control Loop Element and DCAE Participant, please see `The CLAMP DCAE Participant <#>`_ page. + + +2 Common and Instance Specific Properties +========================================= + +Properties are used to define the configuration for Control Loops and Control Loop Elements. +At design time, the types, constraints, and descriptions of the properties are specified. +The values for properties are specified in the CLAMP GUI at runtime. TOSCA provides support +for defining properties, see `Section 3.6.10: TOSCA Property Definition +<https://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.3/os/TOSCA-Simple-Profile-YAML-v1.3-os.html#DEFN_ELEMENT_PROPERTY_DEFN>`_ +in the TOSCA documentation. + +2.1 Terminology for Properties +------------------------------ + +**Property:** Metadata defined in TOSCA that is associated with a Control Loop, a Control +Loop Element, or a Participant. + +**TOSCA Property Type:** The TOSCA definition of the type of a property. A property can have +a generic type such as string or integer or can have a user defined TOSCA data type. + +**TOSCA Property Value:** The value of a Property Type. Property values are assigned at run +time in CLAMP. + +**Common Property Type:** Property Types that apply to all instances of a Control Loop Type. + +**Common Property Value:** The value of a Property Type. It is assigned at run time once for +all instances of a Control Loop Type. + +**Instance Specific Property Type:** Property Types that apply to an individual instance of +a Control Loop Type. + +**Instance Specific Property Value:** The value of a Property Type that applies to an +individual instance of a Control Loop Type. The value is assigned at run time for each +control loop instance. + +Control Loop Properties can be *common* or *instance specific*. See Section 2 of +:ref:`TOSCA Defined Control Loops: Architecture and Design <controlloop-capabilities>` +for a detailed description of the usage of common and instance specific properties. + +2.2 Common Properties +--------------------- + +Common properties apply to all instances of a control loop. Common properties are identified +by a special metadata flag in Control Loop and Control Loop Element definitions. For example, +the startPhase parameter on any Control Loop Element has the same value for any instance of +that control loop element, so it is defined as shown below in the +`Definition of TOSCA fundamental Control Loop Types +<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/ControlLoopTOSCAServiceTemplateTypes.yaml>`_ +yaml file. + +.. code-block:: yaml + + startPhase: + type: integer + required: false + constraints: + - greater-or-equal: 0 + description: A value indicating the start phase in which this control loop element will be started, the + first start phase is zero. Control Loop Elements are started in their start_phase order and stopped + in reverse start phase order. Control Loop Elements with the same start phase are started and + stopped simultaneously + metadata: + common: true + +The "common: true" value in the metadata of the startPhase property identifies that property +as being a common property. This property will be set on the CLAMP GUI during control loop +commissioning. + +2.3 Instance Specific Properties +-------------------------------- + +Instance Specific properties apply to individual instances of a Control Loop and/or Control +Loop Element and must be set individually for Control Loop and Control Loop Element instance. +Properties are instance specific by default, but can be identified by a special metadata flag +in Control Loop and Control Loop Element definitions. For example, the chart parameter on a +Kubernetes Control Loop Element has a different value for every instance of a Kubernetes Control +Loop Element, so it can be defined as shown below in the :ref:`Kubernetes Control Loop Type definition +<_kubernetes-cl-element>` yaml file. + + +.. code-block:: yaml + + # Definition that omits the common flag metadata + chart: + type: org.onap.datatypes.policy.clamp.controlloop.kubernetesControlLoopElement.Chart + typeVersion: 1.0.0 + description: The helm chart for the microservice + required: true + + # Definition that specifies the common flag metadata + chart: + type: org.onap.datatypes.policy.clamp.controlloop.kubernetesControlLoopElement.Chart + typeVersion: 1.0.0 + description: The helm chart for the microservice + required: true + metadata: + common: false + +The "common: false" value in the metadata of the chart property identifies that property as +being an instance specific property. This property will be set on the CLAMP GUI during control +loop instantiation. + + +3 Writing a Control Loop Type Definition +========================================= + +The TOSCA definition of a control loop contains a TOSCA Node Template for the control loop +itself, which contains TOSCA Node Templates for each Control Loop Element that makes up the +Control Loop. + +.. image:: images/defining-controlloops/controlloop-node-template.png + +To create a control loop, a user creates a TOSCA Topology Template. In the Topology Template, +the user creates a TOSCA Node Template for each Control Loop Element that will be in the +Control Loop Definition. Finally, the user creates the Node Template that defines the Control +Loop itself, and references the Control Loop Element definitions that make up the Control Loop +Definition. + +3.1 The Gentle Guidance Control Loop +------------------------------------ + +The best way to explain how to create a Control Loop Definition is by example. + +.. image:: images/defining-controlloops/gentle-guidance-controlloop.png + +The example Gentle Guidance control loop is illustrated in the diagram above. The domain logic +for the control loop is implemented in a microservice running in Kubernetes, a policy, a CDS +blueprint, and some configuration that is passed to the microservice over a REST endpoint. +We want to manage the life cycle of the domain logic for our Gentle Guidance control loop using +our TOSCA based Control Loop Life Cycle Management approach. To do this we create four Control +Loop Element definitions, one for the Kubernetes microservice, one for the policy, one for the +CDS blueprint and one or the REST configuration. + +3.2 The TOSCA Control Loop Definition +------------------------------------- + +We use a TOSCA Topology Template to specify a Control Loop definition and the definitions of +its Control Loop Elements. Optionally, we can specify default parameter values in the TOSCA +Topology Template. The actual values of Control Loop common and instance specific parameters +are set at run time in the CLAMP GUI. + +In the case of the Gentle Guidance control loop, we define a Control Loop Element Node Template +for each part of the domain logic we are managing. We then define the Control Loop Node Template +for the control loop itself. + +Please refer to the `No Properties yaml file in Github +<https://github.com/onap/policy-clamp/blob/master/common/src/test/resources/gentleguidance/GentleGuidanceNoPropeties.yaml>`_ +for the definitive Yaml specification for the TOSCA Topology Template for the Gentle Guidance +domain when no parameters are defined. + +Please refer to the `Default Properties yaml file in Github +<https://github.com/onap/policy-clamp/blob/master/common/src/test/resources/gentleguidance/GentleGuidanceDefaultPropeties.yaml>`_ +for the definitive Yaml specification for the TOSCA Topology Template for the Gentle Guidance +domain when the default values of parameters are defined. + + +4 Creating Custom Control Loop Elements +======================================== + +Any organization can include their own component in the framework and use the framework and have +the Policy Framework CLAMP manage the lifecycle of domain logic in their component as part of a +Control Loop. To do this, a participant for the component must be developed that allows Control +Loop Elements for that component to be run. To develop a participant, the participant must comply +with the `CLAMP Participants <#>`_ +framework and in particular comply with `The CLAMP Control Loop Participant Protocol <#>`_. +The organization must also specify a new Control Loop Element type definition in TOSCA similar to +those supplied in ONAP and described in Section 1.2. This Control Loop Element type tells the +CLAMP Control Loop Lifecycle management that the Control Loop Element exists and can be included +in control loops. It also specifies the properties that can be specified for the Control Loop Element. + +An organization can supply the code for the Participant (for example as a Java jar file) and a +TOSCA artifact with the Control Loop Element definition and it can be added to the platform. In +future releases, support will be provided to include participants and their Control Loop Element +definitions as packaged plugins that can be installed on the platform. + +End of document diff --git a/docs/clamp/controlloop/files/ControlLoops.pdf b/docs/clamp/controlloop/files/ControlLoops.pdf Binary files differnew file mode 100644 index 00000000..c5b978db --- /dev/null +++ b/docs/clamp/controlloop/files/ControlLoops.pdf diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-depriming.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-depriming.png Binary files differnew file mode 100644 index 00000000..16a923b1 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-depriming.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-monitoring.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-monitoring.png Binary files differnew file mode 100644 index 00000000..f64fcd2e --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-monitoring.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-priming.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-priming.png Binary files differnew file mode 100644 index 00000000..fa17429d --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-priming.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change-msg.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change-msg.png Binary files differnew file mode 100644 index 00000000..dfcfe882 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change-msg.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change.png Binary files differnew file mode 100644 index 00000000..9ce9e490 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update-msg.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update-msg.png Binary files differnew file mode 100644 index 00000000..e4c8ce84 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update-msg.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update.png Binary files differnew file mode 100644 index 00000000..be968dc7 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/participant-deregistration.png b/docs/clamp/controlloop/images/clamp-cl-participants/participant-deregistration.png Binary files differnew file mode 100644 index 00000000..bb2ec9a3 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/participant-deregistration.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/participant-registering.png b/docs/clamp/controlloop/images/clamp-cl-participants/participant-registering.png Binary files differnew file mode 100644 index 00000000..eeae2e02 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/participant-registering.png diff --git a/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png b/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png Binary files differnew file mode 100644 index 00000000..f8721299 --- /dev/null +++ b/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png diff --git a/docs/clamp/controlloop/images/defining-controlloops/fundamental-concepts.png b/docs/clamp/controlloop/images/defining-controlloops/fundamental-concepts.png Binary files differnew file mode 100644 index 00000000..dc52a840 --- /dev/null +++ b/docs/clamp/controlloop/images/defining-controlloops/fundamental-concepts.png diff --git a/docs/clamp/controlloop/images/defining-controlloops/gentle-guidance-controlloop.png b/docs/clamp/controlloop/images/defining-controlloops/gentle-guidance-controlloop.png Binary files differnew file mode 100644 index 00000000..3e0862fb --- /dev/null +++ b/docs/clamp/controlloop/images/defining-controlloops/gentle-guidance-controlloop.png diff --git a/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png b/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png Binary files differnew file mode 100644 index 00000000..038549e0 --- /dev/null +++ b/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png diff --git a/docs/clamp/controlloop/images/system-dialogues/change-cl-instance-state-participants.png b/docs/clamp/controlloop/images/system-dialogues/change-cl-instance-state-participants.png Binary files differnew file mode 100644 index 00000000..8892f07d --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/change-cl-instance-state-participants.png diff --git a/docs/clamp/controlloop/images/system-dialogues/comissioning-clamp-gui.png b/docs/clamp/controlloop/images/system-dialogues/comissioning-clamp-gui.png Binary files differnew file mode 100644 index 00000000..473cf05b --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/comissioning-clamp-gui.png diff --git a/docs/clamp/controlloop/images/system-dialogues/comissioning-sdc.png b/docs/clamp/controlloop/images/system-dialogues/comissioning-sdc.png Binary files differnew file mode 100644 index 00000000..19f3f84d --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/comissioning-sdc.png diff --git a/docs/clamp/controlloop/images/system-dialogues/common-properties-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/common-properties-type-definition.png Binary files differnew file mode 100644 index 00000000..06fa8967 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/common-properties-type-definition.png diff --git a/docs/clamp/controlloop/images/system-dialogues/create-cl-instance.png b/docs/clamp/controlloop/images/system-dialogues/create-cl-instance.png Binary files differnew file mode 100644 index 00000000..88a67648 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/create-cl-instance.png diff --git a/docs/clamp/controlloop/images/system-dialogues/decommission-cl-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/decommission-cl-type-definition.png Binary files differnew file mode 100644 index 00000000..c4051eee --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/decommission-cl-type-definition.png diff --git a/docs/clamp/controlloop/images/system-dialogues/deinstantiate-cl-from-participants.png b/docs/clamp/controlloop/images/system-dialogues/deinstantiate-cl-from-participants.png Binary files differnew file mode 100644 index 00000000..174250c0 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/deinstantiate-cl-from-participants.png diff --git a/docs/clamp/controlloop/images/system-dialogues/delete-cl-instance.png b/docs/clamp/controlloop/images/system-dialogues/delete-cl-instance.png Binary files differnew file mode 100644 index 00000000..8417017f --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/delete-cl-instance.png diff --git a/docs/clamp/controlloop/images/system-dialogues/depriming-cl-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/depriming-cl-type-definition.png Binary files differnew file mode 100644 index 00000000..60d97805 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/depriming-cl-type-definition.png diff --git a/docs/clamp/controlloop/images/system-dialogues/monitoring-by-participants.png b/docs/clamp/controlloop/images/system-dialogues/monitoring-by-participants.png Binary files differnew file mode 100644 index 00000000..69ceabf8 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/monitoring-by-participants.png diff --git a/docs/clamp/controlloop/images/system-dialogues/priming-cl-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/priming-cl-type-definition.png Binary files differnew file mode 100644 index 00000000..46f93480 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/priming-cl-type-definition.png diff --git a/docs/clamp/controlloop/images/system-dialogues/read-cl-instance.png b/docs/clamp/controlloop/images/system-dialogues/read-cl-instance.png Binary files differnew file mode 100644 index 00000000..611039b9 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/read-cl-instance.png diff --git a/docs/clamp/controlloop/images/system-dialogues/read-commision-cl-type-definition.png b/docs/clamp/controlloop/images/system-dialogues/read-commision-cl-type-definition.png Binary files differnew file mode 100644 index 00000000..3a308787 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/read-commision-cl-type-definition.png diff --git a/docs/clamp/controlloop/images/system-dialogues/statistics-housekeeping.png b/docs/clamp/controlloop/images/system-dialogues/statistics-housekeeping.png Binary files differnew file mode 100644 index 00000000..6cbfda52 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/statistics-housekeeping.png diff --git a/docs/clamp/controlloop/images/system-dialogues/supervise-controlloops.png b/docs/clamp/controlloop/images/system-dialogues/supervise-controlloops.png Binary files differnew file mode 100644 index 00000000..c24d3a09 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/supervise-controlloops.png diff --git a/docs/clamp/controlloop/images/system-dialogues/supervise-participants.png b/docs/clamp/controlloop/images/system-dialogues/supervise-participants.png Binary files differnew file mode 100644 index 00000000..2439d926 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/supervise-participants.png diff --git a/docs/clamp/controlloop/images/system-dialogues/update-cl-instance-config-participants.png b/docs/clamp/controlloop/images/system-dialogues/update-cl-instance-config-participants.png Binary files differnew file mode 100644 index 00000000..f16ebc2b --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/update-cl-instance-config-participants.png diff --git a/docs/clamp/controlloop/images/system-dialogues/update-instance-params-cl.png b/docs/clamp/controlloop/images/system-dialogues/update-instance-params-cl.png Binary files differnew file mode 100644 index 00000000..ec84ed35 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/update-instance-params-cl.png diff --git a/docs/clamp/controlloop/images/system-dialogues/view-monitoring-info.png b/docs/clamp/controlloop/images/system-dialogues/view-monitoring-info.png Binary files differnew file mode 100644 index 00000000..5937d2f1 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/view-monitoring-info.png diff --git a/docs/clamp/controlloop/images/system-dialogues/view-statistics.png b/docs/clamp/controlloop/images/system-dialogues/view-statistics.png Binary files differnew file mode 100644 index 00000000..451a5d92 --- /dev/null +++ b/docs/clamp/controlloop/images/system-dialogues/view-statistics.png diff --git a/docs/clamp/controlloop/swagger/controlloop-comissioning.json b/docs/clamp/controlloop/swagger/controlloop-comissioning.json new file mode 100644 index 00000000..8fa09368 --- /dev/null +++ b/docs/clamp/controlloop/swagger/controlloop-comissioning.json @@ -0,0 +1,473 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/controlloop/v2/commission": { + "get": { + "tags": [ + "Clamp Control Loop Commissioning API" + ], + "summary": "Query details of the requested commissioned control loop definitions", + "description": "Queries details of the requested commissioned control loop definitions, returning all control loop details", + "operationId": "queryUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ToscaNodeTemplateRes", + "originalRef": "ToscaNodeTemplateRes" + } + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "post": { + "tags": [ + "Clamp Control Loop Commissioning API" + ], + "summary": "Commissions control loop definitions", + "description": "Commissions control loop definitions, returning the commissioned control loop definition IDs", + "operationId": "createUsingPOST", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Entity Body of Control Loop", + "required": true, + "schema": { + "$ref": "#/definitions/ToscaServiceTemplateReq", + "originalRef": "ToscaServiceTemplateReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommissioningResponse", + "originalRef": "CommissioningResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "delete": { + "tags": [ + "Clamp Control Loop Commissioning API" + ], + "summary": "Delete a commissioned control loop", + "description": "Deletes a Commissioned Control Loop, returning optional error details", + "operationId": "deleteUsingDELETE", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommissioningResponse", + "originalRef": "CommissioningResponse" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/commission/elements": { + "get": { + "tags": [ + "Clamp Control Loop Commissioning API" + ], + "summary": "Query details of the requested commissioned control loop element definitions", + "description": "Queries details of the requested commissioned control loop element definitions, returning all control loop elements' details", + "operationId": "queryElementsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ToscaNodeTemplateRes", + "originalRef": "ToscaNodeTemplateRes" + } + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/controlloop-instantiation.json b/docs/clamp/controlloop/swagger/controlloop-instantiation.json new file mode 100644 index 00000000..12542425 --- /dev/null +++ b/docs/clamp/controlloop/swagger/controlloop-instantiation.json @@ -0,0 +1,584 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/controlloop/v2/instantiation": { + "get": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Query details of the requested control loops", + "description": "Queries details of the requested control loops, returning all control loop details", + "operationId": "queryUsingGET_1", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ControlLoopsRes", + "originalRef": "ControlLoopsRes" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "post": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Commissions control loop definitions", + "description": "Commissions control loop definitions, returning the control loop IDs", + "operationId": "createUsingPOST_1", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "controlLoops", + "description": "Entity Body of Control Loop", + "required": true, + "schema": { + "$ref": "#/definitions/ControlLoopsReq", + "originalRef": "ControlLoopsReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InstantiationResponse", + "originalRef": "InstantiationResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "put": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Updates control loop definitions", + "description": "Updates control loop definitions, returning the updated control loop definition IDs", + "operationId": "updateUsingPUT", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "controlLoops", + "description": "Entity Body of Control Loop", + "required": true, + "schema": { + "$ref": "#/definitions/ControlLoopsReq", + "originalRef": "ControlLoopsReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InstantiationResponse", + "originalRef": "InstantiationResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + }, + "delete": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Delete a control loop", + "description": "Deletes a control loop, returning optional error details", + "operationId": "deleteUsingDELETE_1", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop definition name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop definition version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InstantiationResponse", + "originalRef": "InstantiationResponse" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/instantiation/command": { + "put": { + "tags": [ + "Clamp Control Loop Instantiation API" + ], + "summary": "Issue a command to the requested control loops", + "description": "Issues a command to a control loop, ordering a state change on the control loop", + "operationId": "issueControlLoopCommandUsingPUT", + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "command", + "description": "Entity Body of control loop command", + "required": true, + "schema": { + "$ref": "#/definitions/InstantiationCommand", + "originalRef": "InstantiationCommand" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InstantiationResponse", + "originalRef": "InstantiationResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/controlloop-monitoring.json b/docs/clamp/controlloop/swagger/controlloop-monitoring.json new file mode 100644 index 00000000..84fbe7f0 --- /dev/null +++ b/docs/clamp/controlloop/swagger/controlloop-monitoring.json @@ -0,0 +1,521 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/controlloop/v2/monitoring/clelement": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of the requested cl element stats", + "description": "Queries details of the requested cl element stats, returning all clElement stats", + "operationId": "queryElementStatisticsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "endTime", + "in": "query", + "description": "end time", + "required": false, + "type": "string" + }, + { + "name": "id", + "in": "query", + "description": "Control Loop element id", + "required": false, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "Participant name", + "required": true, + "type": "string" + }, + { + "name": "recordCount", + "in": "query", + "description": "Record count", + "required": false, + "type": "integer", + "default": 0, + "format": "int32" + }, + { + "name": "startTime", + "in": "query", + "description": "start time", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Participant version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClElementStatisticsList", + "originalRef": "ClElementStatisticsList" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/monitoring/clelements/controlloop": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of the requested cl element stats in a control loop", + "description": "Queries details of the requested cl element stats, returning all clElement stats", + "operationId": "queryElementStatisticsPerControlLoopUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClElementStatisticsList", + "originalRef": "ClElementStatisticsList" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/monitoring/participant": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of the requested participant stats", + "description": "Queries details of the requested participant stats, returning all participant stats", + "operationId": "queryParticipantStatisticsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "endTime", + "in": "query", + "description": "end time", + "required": false, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "Control Loop participant name", + "required": false, + "type": "string" + }, + { + "name": "recordCount", + "in": "query", + "description": "Record count", + "required": false, + "type": "integer", + "default": 0, + "format": "int32" + }, + { + "name": "startTime", + "in": "query", + "description": "start time", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop participant version", + "required": false, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ParticipantStatisticsList", + "originalRef": "ParticipantStatisticsList" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/controlloop/v2/monitoring/participants/controlloop": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of all the participant stats in a control loop", + "description": "Queries details of the participant stats, returning all participant stats", + "operationId": "queryParticipantStatisticsPerControlLoopUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ParticipantStatisticsList", + "originalRef": "ParticipantStatisticsList" + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/k8sparticipant.json b/docs/clamp/controlloop/swagger/k8sparticipant.json new file mode 100644 index 00000000..ae06b06d --- /dev/null +++ b/docs/clamp/controlloop/swagger/k8sparticipant.json @@ -0,0 +1,392 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/k8sparticipant/helm/chart/{name}/{version}": { + "delete": { + "tags": [ + "k8s-participant" + ], + "summary": "Delete the chart", + "operationId": "deleteChartUsingDELETE", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "204": { + "description": "Chart Deleted" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/onap/k8sparticipant/helm/charts": { + "get": { + "tags": [ + "k8s-participant" + ], + "summary": "Return all Charts", + "operationId": "getAllChartsUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "chart List", + "schema": { + "$ref": "#/definitions/ChartList", + "originalRef": "ChartList" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/install": { + "post": { + "tags": [ + "k8s-participant" + ], + "summary": "Install the chart", + "operationId": "installChartUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "info", + "description": "info", + "required": true, + "schema": { + "$ref": "#/definitions/InstallationInfo", + "originalRef": "InstallationInfo" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "201": { + "description": "chart Installed", + "schema": { + "type": "object" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/onboard/chart": { + "post": { + "tags": [ + "k8s-participant" + ], + "summary": "Onboard the Chart", + "operationId": "onboardChartUsingPOST", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "chart", + "in": "formData", + "required": false, + "type": "file" + }, + { + "name": "info", + "in": "formData", + "required": false, + "type": "string" + }, + { + "in": "body", + "name": "values", + "description": "values", + "required": false, + "schema": { + "type": "string", + "format": "binary" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Chart Onboarded", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/repo": { + "post": { + "tags": [ + "k8s-participant" + ], + "summary": "Configure helm repository", + "operationId": "configureRepoUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "repo", + "description": "repo", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "201": { + "description": "Repository added", + "schema": { + "type": "object" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/uninstall/{name}/{version}": { + "delete": { + "tags": [ + "k8s-participant" + ], + "summary": "Uninstall the Chart", + "operationId": "uninstallChartUsingDELETE", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "201": { + "description": "chart Uninstalled", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + } + } + }, + "definitions": { + "ChartInfo": { + "type": "object", + "properties": { + "chartId": { + "$ref": "#/definitions/ToscaConceptIdentifier", + "originalRef": "ToscaConceptIdentifier" + }, + "namespace": { + "type": "string" + }, + "overrideParams": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "releaseName": { + "type": "string" + }, + "repository": { + "$ref": "#/definitions/HelmRepository", + "originalRef": "HelmRepository" + } + }, + "title": "ChartInfo" + }, + "ChartList": { + "type": "object", + "properties": { + "charts": { + "type": "array", + "items": { + "$ref": "#/definitions/ChartInfo", + "originalRef": "ChartInfo" + } + } + }, + "title": "ChartList" + }, + "HelmRepository": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "password": { + "type": "string" + }, + "port": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "repoName": { + "type": "string" + }, + "userName": { + "type": "string" + } + }, + "title": "HelmRepository" + }, + "InstallationInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "title": "InstallationInfo" + }, + "ToscaConceptIdentifier": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "title": "ToscaConceptIdentifier" + } + } +}
\ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/participant-sim.json b/docs/clamp/controlloop/swagger/participant-sim.json new file mode 100644 index 00000000..79fc3011 --- /dev/null +++ b/docs/clamp/controlloop/swagger/participant-sim.json @@ -0,0 +1,478 @@ +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "paths": { + "/onap/participantsim/v2/elements": { + "put": { + "tags": [ + "Clamp Control Loop Participant Simulator API" + ], + "summary": "Updates simulated control loop elements", + "description": "Updates simulated control loop elements, returning the updated control loop definition IDs", + "operationId": "updateUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Body of a control loop element", + "required": true, + "schema": { + "$ref": "#/definitions/ControlLoopElementReq", + "originalRef": "ControlLoopElementReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TypedSimpleResponse«ControlLoopElement»", + "originalRef": "TypedSimpleResponse«ControlLoopElement»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/elements/{name}/{version}": { + "get": { + "tags": [ + "Clamp Control Loop Participant Simulator API" + ], + "summary": "Query details of the requested simulated control loop elements", + "description": "Queries details of the requested simulated control loop elements, returning all control loop element details", + "operationId": "elementsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Control loop element name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Control loop element version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ControlLoopElementRes", + "originalRef": "ControlLoopElementRes" + } + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/participants": { + "put": { + "tags": [ + "Clamp Control Loop Participant Simulator API" + ], + "summary": "Updates simulated participants", + "description": "Updates simulated participants, returning the updated control loop definition IDs", + "operationId": "updateUsingPUT_1", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Body of a participant", + "required": true, + "schema": { + "$ref": "#/definitions/ParticipantReq", + "originalRef": "ParticipantReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TypedSimpleResponse«Participant»", + "originalRef": "TypedSimpleResponse«Participant»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/participants/{name}/{version}": { + "get": { + "tags": [ + "Clamp Control Loop Participant Simulator API" + ], + "summary": "Query details of the requested simulated participants", + "description": "Queries details of the requested simulated participants, returning all participant details", + "operationId": "participantsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Participant name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Participant version", + "required": true, + "type": "string" + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ParticipantRes", + "originalRef": "ParticipantRes" + } + } + }, + "401": { + "description": "Authentication Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "403": { + "description": "Authorization Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error", + "headers": { + "X-LatestVersion": { + "type": "string" + }, + "X-PatchVersion": { + "type": "string" + }, + "X-MinorVersion": { + "type": "string" + }, + "X-ONAP-RequestID": { + "type": "string", + "format": "uuid" + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/clamp/controlloop/system-level-dialogues.rst b/docs/clamp/controlloop/system-level-dialogues.rst new file mode 100644 index 00000000..4392e1e8 --- /dev/null +++ b/docs/clamp/controlloop/system-level-dialogues.rst @@ -0,0 +1,198 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _system-level-label: + +System Level Dialogues +###################### + + +.. contents:: + :depth: 4 + + +The CLAMP Control Loop Runtime Lifecycle Management uses the following system level dialogues. +These dialogues enable the CLAMP runtime capabilities described in :ref:`Section 2 of +TOSCA Defined Control Loops: Architecture and Design <controlloop-capabilities>`. +Design Time dialogues will be described in future releases of the system. + + +1 Commissioning Dialogues +========================= + +Commissioning dialogues are used to commission and decommission Control Loop Type definitions +and to set the values of Common Parameters. + +Commissioning a Control Loop Type is a three-step process: + +#. The Control Loop Type must be created, that is the Control Loop Type definition must be + loaded and stored in the database. This step may be carried out over the REST interface or + using SDC distribution. + +#. The Common Properties of the Control Loop type must be assigned values and those values + must be stored in the database. This step is optional only if all mandatory common properties + have default values. The Common Property values may be set and amended over and over again + in multiple sessions until the Control Loop Type is primed. + +#. The Control Loop Type Definition and the Common Property values must be primed, that is + sent to the concerned participants. Once a Control Loop Type is primed, its Common Property + values can no longer be changed. To change Common Properties on a primed Control Loop Type, + all instances of the Control Loop Type must be removed and the Control Loop Type must be + de-primed. + +1.1 Commissioning a Control Loop Type Definition using the CLAMP GUI +-------------------------------------------------------------------- + +This dialogue corresponds to a "File → Import" menu on the CLAMP GUI. The documentation of +future releases of the system will describe how the Design Time functionality interacts +with the Runtime commissioning API. + +.. image:: images/system-dialogues/comissioning-clamp-gui.png + +1.2 Commissioning a Control Loop Type Definition using SDC +---------------------------------------------------------- + +.. image:: images/system-dialogues/comissioning-sdc.png + +1.3 Setting Common Properties for a Control Loop Type Definition +---------------------------------------------------------------- + +This dialogue sets the values of common properties. The values of the common properties +may be set, updated, or deleted at will, as this dialogue saves the properties to the +database but does not send the definitions or properties to the participants. However, +once a Control Loop Type Definition and its properties are primed (See :ref:`Section 1.4 +<_priming-cl-label>`), the properties cannot be changed until the control loop type +definition is de-primed (See :ref:`Section 1.5 <depriming-cl-label>`). + +.. image:: images/system-dialogues/common-properties-type-definition.png + +.. _priming-cl-label: + +1.4 Priming a Control Loop Type Definition on Participants +---------------------------------------------------------- +The Priming operation sends Control Loop Type definitions and common property values +to participants. Once a Control Loop Type definition is primed, its property values +can on longer be changed until it is de-primed. + +.. image:: images/system-dialogues/priming-cl-type-definition.png + +.. _depriming-cl-label: + +1.5 De-Prime a Control Loop Type Definition on Participants +----------------------------------------------------------- + +This dialogue allows a Control Loop Type Definition to be de-primed so that it can be +deleted or its common parameter values can be altered. + +.. image:: images/system-dialogues/depriming-cl-type-definition.png + +1.6 Decommissioning a Control Loop Type Definition in CLAMP +----------------------------------------------------------- + +.. image:: images/system-dialogues/decommission-cl-type-definition.png + +1.7 Reading Commissioned Control Loop Type Definitions +------------------------------------------------------ + +.. image:: images/system-dialogues/read-commision-cl-type-definition.png + + +2. Instantiation Dialogues +========================== + +Instantiation dialogues are used to create, set parameters on, instantiate, update, +and remove Control Loop instances. + +Assume a suitable Control Loop Definition exists in the Commissioned Control Loop Inventory. +To get a Control Loop instance running one would, for example, execute dialogues +:ref:`2.1 <creating-cl-instance>`, :ref:`2.3 <updating-cl-instance-config>`, and +:ref:`2.4 <changing-cl-instance-state>`. + +.. _creating-cl-instance: + +2.1 Creating a Control Loop Instance +------------------------------------ + +.. image:: images/system-dialogues/create-cl-instance.png + +.. note:: + This dialogue creates the Control Loop Instance in the Instantiated Control Loop Inventory. + The instance is sent to the participants using the process described in the dialogue in + :ref:`Section 2.3 <updating-cl-instance-config>`. + +2.2 Updating Instance Specific Parameters on a Control Loop Instance +-------------------------------------------------------------------- + +.. image:: images/system-dialogues/update-instance-params-cl.png + +.. _updating-cl-instance-config: + +2.3 Updating a Control Loop Instance with a Configuration on Participants +------------------------------------------------------------------------- + +.. image:: images/system-dialogues/update-cl-instance-config-participants.png + +.. _changing-cl-instance-state: + +2.4 Changing the state of a Control Loop Instance on Participants +----------------------------------------------------------------- + +.. image:: images/system-dialogues/change-cl-instance-state-participants.png + +2.5 De-instantiating a Control Loop Instance from Participants +-------------------------------------------------------------- + +.. image:: images/system-dialogues/deinstantiate-cl-from-participants.png + +2.6 Deleting a Control Loop Instance +------------------------------------ + +.. image:: images/system-dialogues/delete-cl-instance.png + +2.7 Reading Control Loop Instances +---------------------------------- + +.. image:: images/system-dialogues/read-cl-instance.png + + +1. Monitoring Dialogues +======================= + +Monitoring dialogues are used to monitor and to read statistics on Control Loop Instances. + +3.1 Reporting of Monitoring Information and Statistics by Participants +---------------------------------------------------------------------- + +.. image:: images/system-dialogues/monitoring-by-participants.png + +3.2 Viewing of Monitoring Information +------------------------------------- + +.. image:: images/system-dialogues/view-monitoring-info.png + +3.2 Viewing of Statistics +------------------------- + +.. image:: images/system-dialogues/view-statistics.png + +3.3 Statistics Housekeeping +--------------------------- + +.. image:: images/system-dialogues/statistics-housekeeping.png + + +4. Supervision Dialogues +======================== + +Supervision dialogues are used to check the state of Control Loop Instances and Participants. + +4.1 Supervise Participants +-------------------------- + +.. image:: images/system-dialogues/supervise-participants.png + +4.2 Supervise Control Loops +--------------------------- + +.. image:: images/system-dialogues/supervise-controlloops.png + +End of Document diff --git a/docs/conf.py b/docs/conf.py index 11918233..8f01b443 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,3 @@ -from docutils.parsers.rst import directives from docs_conf.conf import * branch = 'latest' @@ -120,63 +119,3 @@ html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): app.add_css_file("css/ribbon.css") - - -needs_extra_options = { - "target": directives.unchanged, - "keyword": directives.unchanged, - "introduced": directives.unchanged, - "updated": directives.unchanged, - "impacts": directives.unchanged, - "validation_mode": directives.unchanged, - "validated_by": directives.unchanged, - "test": directives.unchanged, - "test_case": directives.unchanged, - "test_file": directives.unchanged, - "notes": directives.unchanged, -} - -needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+" -needs_id_required = True -needs_title_optional = True - -needs_template_collapse = """ -.. _{{id}}: - -{% if hide == false -%} -.. role:: needs_tag -.. role:: needs_status -.. role:: needs_type -.. role:: needs_id -.. role:: needs_title - -.. rst-class:: need -.. rst-class:: need_{{type_name}} - -.. container:: need - - `{{id}}` - {{content|indent(4)}} - - .. container:: toggle - - .. container:: header - - Details - -{% if status and status|upper != "NONE" and not hide_status %} | status: :needs_status:`{{status}}`{% endif %} -{% if tags and not hide_tags %} | tags: :needs_tag:`{{tags|join("` :needs_tag:`")}}`{% endif %} -{% if keyword %} | keyword: `{{keyword}}` {% endif %} -{% if target %} | target: `{{target}}` {% endif %} -{% if introduced %} | introduced: `{{introduced}}` {% endif %} -{% if updated %} | updated: `{{updated}}` {% endif %} -{% if impacts %} | impacts: `{{impacts}}` {% endif %} -{% if validation_mode %} | validation mode: `{{validation_mode}}` {% endif %} -{% if validated_by %} | validated by: `{{validated_by}}` {% endif %} -{% if test %} | test: `{{test}}` {% endif %} -{% if test_case %} | test case: {{test_case}} {% endif %} -{% if test_file %} | test file: `{{test_file}}` {% endif %} -{% if notes %} | notes: `{{notes}}` {% endif %} - | children: :need_incoming:`{{id}}` - | parents: :need_outgoing:`{{id}}` -{% endif -%} -""" diff --git a/docs/development/actors/cds/cds.rst b/docs/development/actors/cds/cds.rst index eea6247b..d991f6c5 100644 --- a/docs/development/actors/cds/cds.rst +++ b/docs/development/actors/cds/cds.rst @@ -153,7 +153,7 @@ REST equivalent of the gRPC request from Policy to CDS to execute a CBA. curl -X POST \ 'http://{{ip}}:{{port}}/api/v1/execution-service/process' \ - -H 'Authorization: Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==' \ + -u 'ccsdkapps:ccsdkapps' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ @@ -193,7 +193,7 @@ Sample CBA execute request generated by Policy for PNF target type when "data" f curl -X POST \ 'http://{{ip}}:{{port}}/api/v1/execution-service/process' \ - -H 'Authorization: Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==' \ + -u 'ccsdkapps:ccsdkapps' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ @@ -236,7 +236,7 @@ Sample CBA execute request generated by Policy for VNF target type when "data" f curl -X POST \ 'http://{{ip}}:{{port}}/api/v1/execution-service/process' \ - -H 'Authorization: Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==' \ + -u 'ccsdkapps:ccsdkapps' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ @@ -342,7 +342,7 @@ In the below rest endpoint, the hostname points to K8S service "policy-api" and curl POST 'https://{$POLICY_API_URL}:{$POLICY_API_SERVICE_PORT}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies/operational.modifyconfig/versions/1.0.0' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ - -H 'Authorization: Basic aGVhbHRoY2hlY2s6ZmlyZWFudHNfZGV2QHBvbGljeSE=' \ + -u 'healthcheck:zb!XztG34' \ -d '{$vfw-tosca-policy} Note: In order to create an operational policy when using APEX PDP use the policy-type: @@ -359,7 +359,7 @@ In the rest endpoint URI, the hostname points to the service "policy-pap" and in curl POST 'https://{$POLICY_PAP_URL}:{$POLICY_PAP_SERVICE_PORT}/policy/pap/v1/pdps/deployments/batch' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ - -H 'Authorization: Basic {$auth}' \ + -u 'healthcheck:zb!XztG34' \ -d '{ "groups": [ { @@ -384,10 +384,10 @@ To view the configured policies use the below REST API. curl GET 'https://{$POLICY_API_URL}:{$POLICY_API_SERVICE_PORT}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies/operational.modifyconfig/versions/1.0.0' \ -H 'Accept: application/json' \ - -H 'Authorization: Basic {$auth}' + -u 'healthcheck:zb!XztG34' .. code-block:: bash curl --location --request GET 'https://{$POLICY_PAP_URL}:{$POLICY_PAP_SERVICE_PORT}/policy/pap/v1/pdps' \ -H 'Accept: application/json' \ - -H 'Authorization: Basic {$auth}' + -u 'healthcheck:zb!XztG34' diff --git a/docs/release-notes.rst b/docs/release-notes.rst index a0fc0ea6..f63bc8bb 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -244,8 +244,6 @@ Key Updates - All components return with non-zero exit code in case of application failure - All components log to standard out (i.e., k8s logs) by default - Continue to write log files inside individual pods, as well -* Multi-tenancy - - Basic initial support using the existing features * E2E Network Slicing - Added ModifyNSSI operation to SO actor * Consolidated health check diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index a743c226..12c4de1a 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -4,12 +4,12 @@ doc8 docutils setuptools six -sphinx_rtd_theme>=0.4.3 -sphinxcontrib-blockdiag -sphinxcontrib-needs>=0.2.3 -sphinxcontrib-nwdiag -sphinxcontrib-seqdiag -sphinxcontrib-swaggerdoc -sphinxcontrib-plantuml -sphinx_bootstrap_theme -lfdocs-conf +lfdocs-conf~=0.7.5 +funcparserlib~=1.0.0a0 +sphinxcontrib.blockdiag~=2.0.0 +sphinxcontrib-needs<0.6.0 +sphinxcontrib.plantuml~=0.21 +sphinxcontrib.nwdiag~=2.0.0 +sphinxcontrib-seqdiag~=2.0.0 +sphinxcontrib-swaggerdoc~=0.1.7 +sphinx-rtd-theme~=1.0.0 |
