What's on this page

API Definition

Resource Manager Configuration

Get Resource Manager Configuration Returns high-level information about the configuration of this Resource Manager. This endpoint is called when onboarding the Resource Manager. The supportedFeatures sections allows the Resource Manager to inform Stratoss LM whether a specific feature is supported by the Resource Manager. The only value supported at the moment is AsynchronousTransitionResponses. This informs Stratoss LM that the Resource Manager will be using the asynchronous response mechanism described later (see section 2. »

Resource Topology

List Deployment Locations Returns a list of all deployment locations available to this Resource Manager. Request Format Aspect Value Endpoint URL /topology/deployment-locations HTTP Method GET Parameters None Response Format Aspect Value Return Code 200 - OK Return Code 401 – Not Authorised Example Response An array of Deployment Location names and types expressed as JSON. »

Resource Type Configuration

List Resource Types Returns a list of all resource types managed by this Resource Manager. NOTE: The descriptor is not returned in this list. A resource type descriptor can only be obtained for a single resource type – see “Get the Descriptor of a Resource Type” below Allowable states for the resource types are as follows: UNPUBLISHED, PUBLISHED, DELETED Request Format Aspect Value Endpoint URL /types HTTP Method GET Parameters None Response Format Aspect Value Return Code 200 – OK Return Code 401 – Not Authorised Example Response An array of Resource Type summary information expressed as JSON. »

Resource Lifecycle Management

Create Resource Transition Requests that the Resource Manager performs a specific transition against a resource. Request Format Aspect Value Endpoint URL /lifecycle/transitions HTTP Method POST Parameters None Example Request Body { ​ “resourceManagerId”: “default-rm::dev”, ​ “deploymentLocation”: “dev-cloud”, ​ “resourceType”: “resource::openstack-network::1.0”, ​ “transitionName”: “Install”, ​ “resourceName”: “dev-network-c675e0bd”, ​ "metricKey" : "818127b3-1904-4737-a60c-8c7bab73532d" ​ “properties”: { ​ “propertyName”: “propertyValue” ​ }, ​ “context”: {} } Field Description Mandatory resourceManagerId The id of the Resource Manager instance Yes deploymentLocation The name of the deployment location where the resource will be created Yes resourceType The name of the resource type to be created Yes transitionName The name of the Transition to be enacted against the resource. »

Publishing Metrics

Resources publish metrics via Kakfa. Each of the two metrics described below are published to a separate Kafka topic. Integrity metrics are published to the alm__integrity topic and load metrics are published to the alm__load topic. The message contents are: Integrity Metrics { "metricKey" : "142971c5-a84b-4d34-af15-435ba8640aec", "metricName" : "h_integrity", “metricId” : "142971c5-a84b-4d34-af15-435ba8640aec.h_integrity", "integrity" : "OK", "message" : "Everything is working" } Field Description Mandatory metricKey The key provided when the resource was created Yes metricName The name of the metric as defined in the resource descriptor No metricId The unique ID for this metric value. »