What's on this page

API Definitions

Managing Assemblies

This section covers the API calls the manage assembly instances during their life. It is based around the state model for Stratoss™ Lifecycle Manager (LM). Associated with each example is a table explaining the fields in the example. This includes the name of the field, a brief description and whether the field is mandatory. Whether a field is required or not is based on the context of the examples. The underlying API definition may mark a field as optional, but in some contexts, the fields must be supplied. »

Resource Managers

Associated with each example is a table explaining the fields in the example. This includes the name of the field, a brief description and whether the field is mandatory. Whether a field is required or not is based on the context of the examples. The underlying API definition may mark a field as optional, but in some contexts, the fields must be supplied. In the examples below field names shown in italics are example names and not the real one to be used in messages. »

Asynchronous State Change Events

LM emits events when the state of an assembly and its components changes. Messages that are sent asynchronously are put onto a Kafka bus. The exact topics can be configured. These are emitted in response to Intent Requests causing the state of the Assembly Instance, or its associated components, to change. In the event of a failure to change state, an event will also be emitted. Associated with each example is a table explaining the fields in the example. »

Resource Health Events

Integrity Events These events are sent to enable a resource to indicate if a resource is working or broken. Example Integrity Metric Event { "metricKey" : "142971c5-a84b-4d34-af15-435ba8640aec", "metricName" : "h_integrity", "integrity" : "OK", "message" : "Everything is working" } Field Details Field Description Mandatory metricKey The key given to the resource manager when the resource was created as a token to be used within these messages Yes metricName The name of the metric as defined in the resource descriptor Yes integrity A value indicating if the resource associated with the metric Key is working allowed values are “OK” for working and “BROKEN” when healing is required Yes message An optional test string to include information about the integrity of the resource. »

Topology

Associated with each example is a table explaining the fields in the example. This includes the name of the field, a brief description and whether the field is mandatory. Whether a field is required or not is based on the context of the examples. The underlying API definition may mark a field as optional, but in some contexts, the fields must be supplied. In the examples below field names shown in italics are example names and not the real one to be used in messages. »

Catalog

The following is the details of the API the enables descriptors to be managed within the catalog. Assembly descriptors can be added, listed, updated and deleted from the catalog. Resource descriptors can be listed and deleted but can only be added or updated through the resource manager API above. Associated with each example is a table explaining the fields in the example. This includes the name of the field, a brief description and whether the field is mandatory. »

Deployment Location

A Deployment Location is an entity managed by a Resource Manager to which Services can be deployed. Associated with each example is a table explaining the fields in the example. This includes the name of the field, a brief description and whether the field is mandatory. Whether a field is required or not is based on the context of the examples. The underlying API definition may mark a field as optional, but in some contexts, the fields must be supplied. »

Process

Lifecycle changes within LM that move instances from one state to another are implemented by Processes. Associated with each example is a table explaining the fields in the example. This includes the name of the field, a brief description and whether the field is mandatory. Whether a field is required or not is based on the context of the examples. The underlying API definition may mark a field as optional, but in some contexts, the fields must be supplied. »