Removed participant simulator and k8s ppnt standalone endpoints.
Updated REST endpoints of ACM
Issue-ID: POLICY-4382
Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech>
Change-Id: Ib31253952a32b33b2e193293b0b1775fcb35054b
The Swagger for the Pass Through API will appear here.
-Participant Standalone API
-==========================
-
-This API allows a Participant to run in standalone mode and to run standalone Automation
-Composition Elements.
-
-Kubernetes participant can also be deployed as a standalone application and provides REST endpoints
-for onboarding helm charts to its local chart storage, installing and uninstalling of helm charts
-to a Kubernetes cluster. It also allows to configure a remote repository in Kubernetes participant
-for installing helm charts. User can onboard a helm chart along with the overrides YAML file, the
-chart gets stored in the local chart directory of Kubernetes participants. The onboarded charts can
-be installed and uninstalled. The GET API fetches all the available helm charts from the chart
-storage.
-
-.. swaggerv2doc:: swagger/k8sparticipant.json
-
-
-Participant Simulator API
-=========================
-
-This API allows a Participant Simulator to be started and run for test purposes.
-
-.. swaggerv2doc:: swagger/participant-sim.json
-
End of Document
}
},
"paths": {
- "/onap/automationcomposition/v2/commission": {
+ "/onap/policy/clamp/acm/v2/commission": {
"get": {
"tags": [
"Clamp Automation Composition Commissioning API"
}
}
},
- "/onap/automationcomposition/v2/commission/elements": {
+ "/onap/policy/clamp/acm/v2/commission/elements": {
"get": {
"tags": [
"Clamp Automation Composition Commissioning API"
}
}
},
- "/onap/automationcomposition/v2/commission/getCommonOrInstanceProperties": {
+ "/onap/policy/clamp/acm/v2/commission/getCommonOrInstanceProperties": {
"get": {
"tags": [
"Clamp Automation Composition Commissioning API"
}
}
},
- "/onap/automationcomposition/v2/commission/toscaServiceTemplateSchema": {
- "get": {
- "tags": [
- "Clamp Automation Composition Commissioning API"
- ],
- "summary": "Query details of the requested tosca service template json schema",
- "description": "Queries details of the requested commissioned tosca service template json schema, returning all tosca service template json schema details",
- "operationId": "queryToscaServiceTemplateJsonSchemaUsingGET",
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "section",
- "in": "query",
- "description": "Section of Template schema is desired for",
- "required": false,
- "type": "string",
- "default": "all"
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "string"
- }
- },
- "401": {
- "description": "Authentication Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "403": {
- "description": "Authorization Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "404": {
- "description": "Not Found"
- },
- "500": {
- "description": "Internal Server Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Istanbul"
- }
- }
- },
- "/onap/automationcomposition/v2/commission/toscaservicetemplate": {
+ "/onap/policy/clamp/acm/v2/commission/toscaservicetemplate": {
"get": {
"tags": [
"Clamp Automation Composition Commissioning API"
}
},
"paths": {
- "/onap/automationcomposition/v2/instantiation": {
+ "/onap/policy/clamp/acm/v2/instantiation": {
"get": {
"tags": [
"Clamp Automation Composition Instantiation API"
}
}
},
- "/onap/automationcomposition/v2/instantiation/command": {
+ "/onap/policy/clamp/acm/v2/instantiation/command": {
"put": {
"tags": [
"Clamp Automation Composition Instantiation API"
"last-mod-release": "Istanbul"
}
}
+ },
+ "/onap/policy/clamp/acm/v2/instantiationState":{
+ "get":{
+ "tags":[
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary":"Query details of the requested automation compositions",
+ "description":"Queries details of requested automation compositions, returning all automation composition details",
+ "operationId":"getInstantiationOrderStateUsingGET",
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "name":"name",
+ "in":"query",
+ "description":"Automation composition name",
+ "required":false,
+ "type":"string"
+ },
+ {
+ "name":"version",
+ "in":"query",
+ "description":"Automation composition 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/AutomationCompositionOrderStateResponse",
+ "originalRef":"AutomationCompositionOrderStateResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "responsesObject":{
+ "200":{
+ "description":"OK",
+ "schema":{
+ "$ref":"#/definitions/AutomationCompositionOrderStateResponse",
+ "originalRef":"AutomationCompositionOrderStateResponse"
+ }
+ },
+ "401":{
+ "description":"Authentication Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "403":{
+ "description":"Authorization Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "404":{
+ "description":"Not Found"
+ },
+ "500":{
+ "description":"Internal Server Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ }
+ },
+ "security":[
+ {
+ "basicAuth":[
+
+ ]
+ }
+ ],
+ "x-interface info":{
+ "api-version":"1.0.0",
+ "last-mod-release":"Istanbul"
+ }
+ }
+ },
+ "/onap/policy/clamp/acm/v2/instanceProperties":{
+ "post":{
+ "tags":[
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary":"Saves instance properties",
+ "description":"Saves instance properties, returning the saved instances properties and it's version",
+ "operationId":"createInstancePropertiesUsingPOST",
+ "consumes":[
+ "application/json",
+ "application/yaml"
+ ],
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "in":"body",
+ "name":"body",
+ "description":"Body of instance properties",
+ "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/InstancePropertiesResponse",
+ "originalRef":"InstancePropertiesResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "responsesObject":{
+ "200":{
+ "description":"OK",
+ "schema":{
+ "$ref":"#/definitions/InstancePropertiesResponse",
+ "originalRef":"InstancePropertiesResponse"
+ }
+ },
+ "201":{
+ "description":"Created"
+ },
+ "401":{
+ "description":"Authentication Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "403":{
+ "description":"Authorization Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "404":{
+ "description":"Not Found"
+ },
+ "500":{
+ "description":"Internal Server Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ }
+ },
+ "security":[
+ {
+ "basicAuth":[
+
+ ]
+ }
+ ],
+ "x-interface info":{
+ "api-version":"1.0.0",
+ "last-mod-release":"Istanbul"
+ }
+ },
+ "put":{
+ "tags":[
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary":"Updates instance properties",
+ "description":"Updates instance properties, returning the saved instances properties and it's version",
+ "operationId":"updatesInstancePropertiesUsingPUT",
+ "consumes":[
+ "application/json",
+ "application/yaml"
+ ],
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "in":"body",
+ "name":"body",
+ "description":"Body of instance properties",
+ "required":true,
+ "schema":{
+ "$ref":"#/definitions/ToscaServiceTemplateReq",
+ "originalRef":"ToscaServiceTemplateReq"
+ }
+ },
+ {
+ "name":"name",
+ "in":"query",
+ "description":"Automation composition definition name",
+ "required":true,
+ "type":"string"
+ },
+ {
+ "name":"version",
+ "in":"query",
+ "description":"Automation composition definition version",
+ "required":true,
+ "type":"string"
+ },
+ {
+ "name":"X-ONAP-RequestID",
+ "in":"header",
+ "description":"RequestID for http transaction",
+ "required":false,
+ "type":"string",
+ "format":"uuid"
+ }
+ ],
+ "responses":{
+ "200":{
+ "description":"OK",
+ "schema":{
+ "$ref":"#/definitions/InstancePropertiesResponse",
+ "originalRef":"InstancePropertiesResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "responsesObject":{
+ "200":{
+ "description":"OK",
+ "schema":{
+ "$ref":"#/definitions/InstancePropertiesResponse",
+ "originalRef":"InstancePropertiesResponse"
+ }
+ },
+ "201":{
+ "description":"Created"
+ },
+ "401":{
+ "description":"Authentication Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "403":{
+ "description":"Authorization Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "404":{
+ "description":"Not Found"
+ },
+ "500":{
+ "description":"Internal Server Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ }
+ },
+ "security":[
+ {
+ "basicAuth":[
+
+ ]
+ }
+ ],
+ "x-interface info":{
+ "api-version":"1.0.0",
+ "last-mod-release":"Istanbul"
+ }
+ },
+ "delete":{
+ "tags":[
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary":"Delete a automation composition and instance properties",
+ "description":"Deletes a automation composition and instance properties, returning optional error details",
+ "operationId":"deleteInstancePropertiesUsingDELETE",
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "name":"name",
+ "in":"query",
+ "description":"Automation composition definition name",
+ "required":true,
+ "type":"string"
+ },
+ {
+ "name":"version",
+ "in":"query",
+ "description":"Automation composition definition version",
+ "required":true,
+ "type":"string"
+ },
+ {
+ "name":"X-ONAP-RequestID",
+ "in":"header",
+ "description":"RequestID for http transaction",
+ "required":false,
+ "type":"string",
+ "format":"uuid"
+ }
+ ],
+ "responses":{
+ "200":{
+ "description":"OK",
+ "schema":{
+ "$ref":"#/definitions/InstantiationResponse",
+ "originalRef":"InstantiationResponse"
+ }
+ },
+ "204":{
+ "description":"No Content"
+ },
+ "401":{
+ "description":"Authentication Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "403":{
+ "description":"Authorization Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "500":{
+ "description":"Internal Server Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ }
+ },
+ "responsesObject":{
+ "200":{
+ "description":"OK",
+ "schema":{
+ "$ref":"#/definitions/InstantiationResponse",
+ "originalRef":"InstantiationResponse"
+ }
+ },
+ "204":{
+ "description":"No Content"
+ },
+ "401":{
+ "description":"Authentication Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "403":{
+ "description":"Authorization Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "500":{
+ "description":"Internal Server Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ }
+ },
+ "security":[
+ {
+ "basicAuth":[
+
+ ]
+ }
+ ],
+ "x-interface info":{
+ "api-version":"1.0.0",
+ "last-mod-release":"Istanbul"
+ }
+ }
+ },
+ "/onap/policy/clamp/acm/v2/automationCompositionPriming":{
+ "get":{
+ "tags":[
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary":"Query priming details of the requested automation compositions",
+ "description":"Queries priming details of requested automation compositions, returning primed/deprimed compositions",
+ "operationId":"getAutomationCompositionPrimingUsingGET",
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "name":"name",
+ "in":"query",
+ "description":"Automation composition definition name",
+ "required":false,
+ "type":"string"
+ },
+ {
+ "name":"version",
+ "in":"query",
+ "description":"Automation composition definition version",
+ "required":false,
+ "type":"string"
+ },
+ {
+ "name":"X-ONAP-RequestID",
+ "in":"header",
+ "description":"RequestID for http transaction",
+ "required":false,
+ "type":"string",
+ "format":"uuid"
+ }
+ ],
+ "responses":{
+ "200":{
+ "description":"OK",
+ "schema":{
+ "$ref":"#/definitions/AutomationCompositionPrimedResponse",
+ "originalRef":"AutomationCompositionPrimedResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "responsesObject":{
+ "200":{
+ "description":"OK",
+ "schema":{
+ "$ref":"#/definitions/AutomationCompositionPrimedResponse",
+ "originalRef":"AutomationCompositionPrimedResponse"
+ }
+ },
+ "401":{
+ "description":"Authentication Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "403":{
+ "description":"Authorization Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "404":{
+ "description":"Not Found"
+ },
+ "500":{
+ "description":"Internal Server Error",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ }
+ },
+ "security":[
+ {
+ "basicAuth":[
+
+ ]
+ }
+ ],
+ "x-interface info":{
+ "api-version":"1.0.0",
+ "last-mod-release":"Istanbul"
+ }
+ }
}
}
}
\ No newline at end of file
}
},
"paths": {
- "/onap/automationcomposition/v2/monitoring/acelement": {
+ "/onap/policy/clamp/acm/v2/monitoring/acelement": {
"get": {
"tags": [
"Clamp Automation Composition Monitoring API"
}
}
},
- "/onap/automationcomposition/v2/monitoring/acelements/automationcomposition": {
+ "/onap/policy/clamp/acm/v2/monitoring/acelements/automationcomposition": {
"get": {
"tags": [
"Clamp Automation Composition Monitoring API"
}
}
},
- "/onap/automationcomposition/v2/monitoring/participant": {
+ "/onap/policy/clamp/acm/v2/monitoring/participant": {
"get": {
"tags": [
"Clamp Automation Composition Monitoring API"
}
}
},
- "/onap/automationcomposition/v2/monitoring/participants/automationcomposition": {
+ "/onap/policy/clamp/acm/v2/monitoring/participants/automationcomposition": {
"get": {
"tags": [
"Clamp Automation Composition Monitoring API"
+++ /dev/null
-{
- "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
+++ /dev/null
-{
- "swagger": "2.0",
- "info": {
- "description": "Api Documentation",
- "version": "1.0",
- "title": "Api Documentation",
- "termsOfService": "urn:tos",
- "contact": {},
- "license": {
- "name": "Apache 2.0",
- "url": "http://www.apache.org/licenses/LICENSE-2.0"
- }
- },
- "paths": {
- "/onap/participantsim/v2/elements": {
- "put": {
- "tags": [
- "Clamp Automation Composition Participant Simulator API"
- ],
- "summary": "Updates simulated automation composition elements",
- "description": "Updates simulated automation composition elements, returning the updated automation composition definition IDs",
- "operationId": "updateUsingPUT",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "body",
- "description": "Body of a automation composition element",
- "required": true,
- "schema": {
- "$ref": "#/definitions/AutomationCompositionElementReq",
- "originalRef": "AutomationCompositionElementReq"
- }
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/TypedSimpleResponse«AutomationCompositionElement»",
- "originalRef": "TypedSimpleResponse«AutomationCompositionElement»"
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Authentication Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "403": {
- "description": "Authorization Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "404": {
- "description": "Not Found"
- },
- "500": {
- "description": "Internal Server Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Dublin"
- }
- }
- },
- "/onap/participantsim/v2/elements/{name}/{version}": {
- "get": {
- "tags": [
- "Clamp Automation Composition Participant Simulator API"
- ],
- "summary": "Query details of the requested simulated automation composition elements",
- "description": "Queries details of the requested simulated automation composition elements, returning all automation composition element details",
- "operationId": "elementsUsingGET",
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "name",
- "in": "path",
- "description": "Automation composition element name",
- "required": true,
- "type": "string"
- },
- {
- "name": "version",
- "in": "path",
- "description": "Automation composition element version",
- "required": true,
- "type": "string"
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/AutomationCompositionElementRes",
- "originalRef": "AutomationCompositionElementRes"
- }
- }
- },
- "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 Automation Composition Participant Simulator API"
- ],
- "summary": "Updates simulated participants",
- "description": "Updates simulated participants, returning the updated automation composition definition IDs",
- "operationId": "updateUsingPUT_1",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "body",
- "description": "Body of a participant",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ParticipantReq",
- "originalRef": "ParticipantReq"
- }
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/TypedSimpleResponse«Participant»",
- "originalRef": "TypedSimpleResponse«Participant»"
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Authentication Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "403": {
- "description": "Authorization Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "404": {
- "description": "Not Found"
- },
- "500": {
- "description": "Internal Server Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Dublin"
- }
- }
- },
- "/onap/participantsim/v2/participants/{name}/{version}": {
- "get": {
- "tags": [
- "Clamp Automation Composition Participant Simulator API"
- ],
- "summary": "Query details of the requested simulated participants",
- "description": "Queries details of the requested simulated participants, returning all participant details",
- "operationId": "participantsUsingGET",
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "name",
- "in": "path",
- "description": "Participant name",
- "required": true,
- "type": "string"
- },
- {
- "name": "version",
- "in": "path",
- "description": "Participant version",
- "required": true,
- "type": "string"
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ParticipantRes",
- "originalRef": "ParticipantRes"
- }
- }
- },
- "401": {
- "description": "Authentication Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "403": {
- "description": "Authorization Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "404": {
- "description": "Not Found"
- },
- "500": {
- "description": "Internal Server Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Dublin"
- }
- }
- }
- }
-}
\ No newline at end of file
The kubernetes participant also exposes REST endpoints for onboarding, installing and uninstalling of helm charts from the
local chart database which facilitates the user to also use this component as a standalone application for helm operations.
-In Istanbul version, the kubernetes participant supports the following methods of installation of helm charts.
+In Kohn version, the kubernetes participant supports the following methods of installation of helm charts.
- Installation of helm charts from configured helm repositories and remote repositories passed via TOSCA in CLAMP.
-- Installation of helm charts from the local chart database via the participant's REST Api.
Prerequisites for using Kubernetes participant in Istanbul version:
-------------------------------------------------------------------
* - repoName
- String
- The name of the helm repository that needs to be configured on the helm client
- * - protocol
- - String
- - Specifies http/https protocols to connect with repository url
* - address
- String
- - Specifies the ip address or the host name
- * - port (optional)
- - String
- - Specifies the port where the repository service is running
+ - Specifies the url of the hem repository
* - userName (optional)
- String
- The username to login the helm repository
When the state of the Automation Composition is changed from "UNINITIALISED" to "PASSIVE" from the Policy Gui, the kubernetes participant receives the automation composition state change event from the runtime and
deploys the helm charts associated with each Automation Composition Elements by creating appropriate namespace on the cluster.
If the repository of the helm chart is not passed via TOSCA, the participant looks for the helm chart in the configured helm repositories of helm client.
-It also performs a chart look up on the local chart database where the helm charts are onboarded via the participant's REST Api.
-The participant also monitors the deployed pods for the next 3 minutes until the pods comes to RUNNING state.
+The participant also monitors the deployed pods for the configured time until the pods comes to RUNNING state.
It holds the deployment information of the pods including the current status of the pods after the deployment.
When the state of the Automation Composition is changed from "PASSIVE" to "UNINITIALISED" back, the participant also undeploys the helm charts from the cluster that are part of the Automation Composition Element.
-
-REST APIs on Kubernetes participant
------------------------------------
-
-Kubernetes participant can also be installed as a standalone application which exposes REST endpoints for onboarding,
-installing, uninstalling helm charts from local chart database.
-
-
-.. image:: ../../images/participants/k8s-rest.png
-
-:download:`Download Kubernetes participant API Swagger <swagger/k8s-participant-swagger.json>`
\ No newline at end of file
+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-.. _clamp-acm-participant-simulator:
-
-Participant Simulator
-#####################
-
-This can be used for simulation testing purpose when there are no actual frameworks or a full deployment.
-Participant simulator can edit the states of AutomationCompositionElements and Participants for verification of other clamp-acm components
-for early testing.
-All clamp-acm components should be setup, except participant frameworks (for example, no policy framework components
-are needed) and participant simulator acts as respective participant framework, and state changes can be done with following REST APIs
-
-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
http-participant
k8s-participant
policy-framework-participant
- participant-simulator
Code Review / policy / parent.git / commitdiff