Commissioning API

This API is a CRUD API that allows Automation Composition Type definitions created in a design environment to be commissioned on the CLAMP runtime. It has endpoints that allow Automation Composition Types to be created, read, updated, and deleted.

The body of the create and update endpoints is a TOSCA Service/Topology template that defines the new or changed Automation Composition Type. The update and delete endpoints take a reference to the Automation Composition Type. The incoming TOSCA is verified and checked for referential integrity. On delete requests, a check is made to ensure that no Automation Composition Instances exist for the Automation Composition Type to be deleted.

Instantiation API

The instantiation API has two functions:

...

The Instantiation API is used by the CLAMP GUI.

Instantiation Automation Composition Instance CRUD

This sub API allows for the creation, read, update, and deletion of Automation Composition Instances. The endpoints for create and update take a JSON body that describes the Automation Composition Instance. The endpoints for read and delete take an Automation Composition Instance ID to determine which Automation Composition Instance to act on. For the delete endpoint, a check is made to ensure that the Automation Composition Instance is not instantiated on participants.

A call to the update endpoint for an Automation Composition Instance follows the semantics described here: TOSCA Defined Automation Compositions: Architecture and Design#4.1Upgrade.

Instantiation Automation Composition Instance Lifecycle Management

This sub API is used to manage the life cycle of Automation Composition Instances. An Automation Composition Instance can be in the states described here: TOSCA Defined Automation Compositions: Architecture and Design#2.1:ACMInstanceStates. Managing the life cycle of an Automation Composition Instance amounts to steering the Automation Composition through its states.

The sub API allows upgrades and downgrades of Automation Composition Instances to be pushed to participants following the semantics described here: TOSCA Defined Automation Compositions: Architecture and Design#4.1Upgrade. When the API is used to update the participants on an Automation Composition Instance, the new/upgraded/downgraded definition of the Automation Composition is pushed to the participants. Note that the API asks the participants in an Automation Composition Instance to perform the update, it is the responsibility of the participants to execute the update and report the result using the protocols described here: CLAMP Participants. The progress and result of an update can be monitored using the REST APIs for CLAMP Control Loops MonitoringAPI.

The sub API also allows a state change of an Automation Composition Instance to be ordered. The required state of the Automation Composition Instance is pushed to participants in an Automation Composition Instance using the API. Note that the API asks the participants in an Automation Composition Instance to perform the state change, it is the responsibility of the participants to execute the state change and report the result using the protocols described here: CLAMP Participants. The progress and result of a state change can be monitored using the REST APIs for CLAMP Control Loops MonitoringAPI.

Monitoring API

The Monitoring API allows the state and statistics of Participants, Automation Composition Instances, and their Automation Composition Elements to be monitored. This API is used by the CLAMP GUI. The API provides filtering so that specific Participants and Automation Composition Instances can be retrieved. In addition, the quantity of statistical information to be returned can be scoped.

Pass Through API

This API allows information to be passed to Automation Composition Elements in an Automation Composition.

...

Participant Standalone API

This API allows a Participant to run in standalone mode and to run standalone Automation Composition Elements.

Kubernetes participant can also be deployed as a standalone application and provides REST endpoints for onboarding helm charts to its local chart storage, installing and uninstalling of helm charts to a Kubernetes cluster. It also allows to configure a remote repository in Kubernetes participant for installing helm charts. User can onboard a helm chart along with the overrides YAML file, the chart gets stored in the local chart directory of Kubernetes participant. The onboarded charts can be installed and uninstalled. The GET API fetches all the available helm charts from the chart storage.

Participant Simulator API

This API allows a Participant Simulator to be started and run for test purposes.

...