summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/api/api.rst30
-rw-r--r--docs/api/swagger/nodetemplates-api.json1742
-rw-r--r--docs/development/development.rst1
-rw-r--r--docs/development/devtools/clamp-smoke.rst125
-rw-r--r--docs/development/prometheus-metrics.rst13
-rw-r--r--integration/pom.xml13
-rw-r--r--pom.xml2
-rw-r--r--releases/3.5.1.yaml4
-rw-r--r--resources/pom.xml2
-rw-r--r--version.properties2
10 files changed, 1893 insertions, 41 deletions
diff --git a/docs/api/api.rst b/docs/api/api.rst
index 8b0ae3e8..5aa38853 100644
--- a/docs/api/api.rst
+++ b/docs/api/api.rst
@@ -181,6 +181,7 @@ Global API Table
"Statistics API", ":download:`link <swagger/statistics-api.json>`"
"Tosca Policy Type API", ":download:`link <swagger/policytype-api.json>`"
"Tosca Policy API", ":download:`link <swagger/policy-api.json>`"
+ "Tosca NodeTemplate API", ":download:`link <swagger/nodetemplates-api.json>`"
API Swagger
-----------
@@ -217,6 +218,35 @@ x-onap-requestid is used to track REST transactions for logging purpose, as desc
.. swaggerv2doc:: swagger/policy-api.json
+
+Creating MetadataSet for policy
+--------------------------------
+
+The policy type implementation in tosca policy can be independently persisted to the database as metadataSets via the Tosca node template Apis .
+The policy type implementation data can be excluded from the policy properties section of the tosca policy and the user can specify only the "metadataSetName" and "metadataSetVersion"
+fields under the policy "metadata" section to map a specific policy type implementation to the policy during the policy creation.
+
+The following sample tosca service template comprises a list of tosca node templates each containing a policy type implementation data in the form of metadataSet that can be persisted to the database independently using the policy node template Api.
+
+.. csv-table::
+ :header: "Tosca node template", "Payload"
+ :widths: 15,10
+
+ "sample.nodetemplates.metadatasets", `nodetemplates.metadatasets.input.tosca.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/nodetemplates/nodetemplates.metadatasets.input.tosca.yaml>`_ `nodetemplates.metadatasets.input.tosca.json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/nodetemplates/nodetemplates.metadatasets.input.tosca.json>`_
+
+
+The following sample tosca policy shows the policy metadata section that maps to one of the metadataSets stored in the database prior to the policy creation.
+
+.. csv-table::
+ :header: "Tosca policy", "Payload"
+ :widths: 15,10
+
+ "apex.decisionmaker.policy", `apex.policy.decisionmaker.input.tosca.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/apex.policy.decisionmaker.input.tosca.yaml>`_
+
+The following node template Apis are introduced to handle the policy metadataSets as independent entities that can be later mapped to a tosca policy during policy creation.
+
+.. swaggerv2doc:: swagger/nodetemplates-api.json
+
When making a POST policy API call, the client must not only provide well-formed JSON/YAML,
but also must conform to the TOSCA specification. For example. the "type" field for a TOSCA
policy should strictly match the policy type name it derives.
diff --git a/docs/api/swagger/nodetemplates-api.json b/docs/api/swagger/nodetemplates-api.json
new file mode 100644
index 00000000..bd8ed48e
--- /dev/null
+++ b/docs/api/swagger/nodetemplates-api.json
@@ -0,0 +1,1742 @@
+{
+ "swagger": "2.0",
+ "basePath": "/",
+ "tags": [
+ {
+ "name": "nodeTemplate"
+ }
+ ],
+ "schemes": [
+ "http",
+ "https"
+ ],
+ "paths": {
+ "/policy/api/v1/nodetemplates":{
+ "get":{
+ "tags":[
+ "nodeTemplates"
+ ],
+ "summary":"Retrieve all the available tosca node templates",
+ "description":"Returns all the node templates from the service template",
+ "operationId":"getAllNodeTemplatesUsingGET",
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "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":"Resource Not Found",
+ "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":"Jakarta"
+ }
+ },
+ "post":{
+ "tags":[
+ "nodeTemplate"
+ ],
+ "summary":"Create one or more new node templates",
+ "description":"Client should provide TOSCA body of the new node templates",
+ "operationId":"createToscaNodeTemplatesUsingPOST",
+ "consumes":[
+ "application/json"
+ ],
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "in":"body",
+ "name":"body",
+ "description":"Entity body of tosca node templates",
+ "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/ToscaServiceTemplateRes",
+ "originalRef":"ToscaServiceTemplateRes"
+ }
+ },
+ "201":{
+ "description":"Created"
+ },
+ "400":{
+ "description":"Invalid Body",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "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":"Resource Not Found",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "406":{
+ "description":"Not Acceptable Payload",
+ "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":"Jakarta"
+ }
+ },
+ "put":{
+ "tags":[
+ "nodeTemplate"
+ ],
+ "summary":"Updates one or more new node templates",
+ "description":"Client should provide TOSCA body of the updated node templates",
+ "operationId":"updateToscaNodeTemplatesUsingPUT",
+ "consumes":[
+ "application/json"
+ ],
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "in":"body",
+ "name":"body",
+ "description":"Entity body of tosca node templates",
+ "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/ToscaServiceTemplateRes",
+ "originalRef":"ToscaServiceTemplateRes"
+ }
+ },
+ "201":{
+ "description":"Created"
+ },
+ "400":{
+ "description":"Invalid Body",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "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":"Resource Not Found",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "406":{
+ "description":"Not Acceptable Payload",
+ "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":"Jakarta"
+ }
+ }
+ },
+ "/policy/api/v1/nodetemplates/{name}/versions/{version}":{
+ "get":{
+ "tags":[
+ "nodeTemplates"
+ ],
+ "summary":"Retrieve one version of a tosca node template",
+ "description":"Returns a particular version of a node template",
+ "operationId":"getSpecificVersionOfNodeTemplateUsingGET",
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "name":"name",
+ "in":"path",
+ "description":"Name of the node template",
+ "required":true,
+ "type":"string"
+ },
+ {
+ "name":"version",
+ "in":"path",
+ "description":"Version of the node template",
+ "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/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":"Resource Not Found",
+ "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":"Jakarta"
+ }
+ },
+ "delete":{
+ "tags":[
+ "nodeTemplate"
+ ],
+ "summary":"Deletes a specific node templates",
+ "description":"Client should provide the name and version of the node template to be deleted",
+ "operationId":"deleteToscaNodeTemplatesUsingDELETE",
+ "produces":[
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters":[
+ {
+ "name":"name",
+ "in":"path",
+ "description":"Name of the node template",
+ "required":true,
+ "type":"string"
+ },
+ {
+ "name":"version",
+ "in":"path",
+ "description":"Version of the node template",
+ "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/ToscaServiceTemplateRes",
+ "originalRef":"ToscaServiceTemplateRes"
+ }
+ },
+ "204":{
+ "description":"No Content"
+ },
+ "400":{
+ "description":"Invalid Body",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "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":"Resource Not Found",
+ "headers":{
+ "X-LatestVersion":{
+ "type":"string"
+ },
+ "X-PatchVersion":{
+ "type":"string"
+ },
+ "X-MinorVersion":{
+ "type":"string"
+ },
+ "X-ONAP-RequestID":{
+ "type":"string",
+ "format":"uuid"
+ }
+ }
+ },
+ "406":{
+ "description":"Not Acceptable Payload",
+ "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":"Jakarta"
+ }
+ }
+ }
+ },
+ "definitions": {
+
+ "ToscaCapabilityAssignmentReq":{
+ "type":"object",
+ "properties":{
+ "attributes":{
+ "type":"object"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "occurrences":{
+ "type":"array",
+ "items":{
+ "type":"object"
+ }
+ },
+ "properties":{
+ "type":"object"
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaCapabilityAssignmentReq"
+ },
+ "ToscaCapabilityAssignmentRes":{
+ "type":"object",
+ "properties":{
+ "attributes":{
+ "type":"object"
+ },
+ "definedName":{
+ "type":"string"
+ },
+ "definedVersion":{
+ "type":"string"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "identifier":{
+ "$ref":"#/definitions/ToscaConceptIdentifier",
+ "originalRef":"ToscaConceptIdentifier"
+ },
+ "key":{
+ "$ref":"#/definitions/ToscaEntityKey",
+ "originalRef":"ToscaEntityKey"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "occurrences":{
+ "type":"array",
+ "items":{
+ "type":"object"
+ }
+ },
+ "properties":{
+ "type":"object"
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeIdentifier":{
+ "$ref":"#/definitions/ToscaConceptIdentifier",
+ "originalRef":"ToscaConceptIdentifier"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaCapabilityAssignmentRes"
+ },
+ "ToscaCapabilityTypeReq":{
+ "type":"object",
+ "properties":{
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaProperty",
+ "originalRef":"ToscaProperty"
+ }
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaCapabilityTypeReq"
+ },
+ "ToscaCapabilityTypeRes":{
+ "type":"object",
+ "properties":{
+ "definedName":{
+ "type":"string"
+ },
+ "definedVersion":{
+ "type":"string"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "key":{
+ "$ref":"#/definitions/ToscaEntityKey",
+ "originalRef":"ToscaEntityKey"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaProperty",
+ "originalRef":"ToscaProperty"
+ }
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaCapabilityTypeRes"
+ },
+ "ToscaConceptIdentifier":{
+ "type":"object",
+ "properties":{
+ "name":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaConceptIdentifier"
+ },
+ "ToscaConstraint":{
+ "type":"object",
+ "properties":{
+ "equal":{
+ "type":"string"
+ },
+ "greaterOrEqual":{
+ "type":"string"
+ },
+ "greaterThan":{
+ "type":"string"
+ },
+ "lessOrEqual":{
+ "type":"string"
+ },
+ "lessThan":{
+ "type":"string"
+ },
+ "rangeValues":{
+ "type":"array",
+ "items":{
+ "type":"string"
+ }
+ },
+ "validValues":{
+ "type":"array",
+ "items":{
+ "type":"string"
+ }
+ }
+ },
+ "title":"ToscaConstraint"
+ },
+ "ToscaDataTypeReq":{
+ "type":"object",
+ "properties":{
+ "constraints":{
+ "type":"array",
+ "items":{
+ "$ref":"#/definitions/ToscaConstraint",
+ "originalRef":"ToscaConstraint"
+ }
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaProperty",
+ "originalRef":"ToscaProperty"
+ }
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaDataTypeReq"
+ },
+ "ToscaDataTypeRes":{
+ "type":"object",
+ "properties":{
+ "constraints":{
+ "type":"array",
+ "items":{
+ "$ref":"#/definitions/ToscaConstraint",
+ "originalRef":"ToscaConstraint"
+ }
+ },
+ "definedName":{
+ "type":"string"
+ },
+ "definedVersion":{
+ "type":"string"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "key":{
+ "$ref":"#/definitions/ToscaEntityKey",
+ "originalRef":"ToscaEntityKey"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaProperty",
+ "originalRef":"ToscaProperty"
+ }
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaDataTypeRes"
+ },
+ "ToscaEntityKey":{
+ "type":"object",
+ "properties":{
+ "name":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaEntityKey"
+ },
+ "ToscaNodeTemplateReq":{
+ "type":"object",
+ "properties":{
+ "capabilities":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaCapabilityAssignmentReq",
+ "originalRef":"ToscaCapabilityAssignmentReq"
+ }
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object"
+ },
+ "requirements":{
+ "type":"array",
+ "items":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaRequirementReq",
+ "originalRef":"ToscaRequirementReq"
+ }
+ }
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaNodeTemplateReq"
+ },
+ "ToscaNodeTemplateRes":{
+ "type":"object",
+ "properties":{
+ "capabilities":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaCapabilityAssignmentRes",
+ "originalRef":"ToscaCapabilityAssignmentRes"
+ }
+ },
+ "definedName":{
+ "type":"string"
+ },
+ "definedVersion":{
+ "type":"string"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "identifier":{
+ "$ref":"#/definitions/ToscaConceptIdentifier",
+ "originalRef":"ToscaConceptIdentifier"
+ },
+ "key":{
+ "$ref":"#/definitions/ToscaEntityKey",
+ "originalRef":"ToscaEntityKey"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object"
+ },
+ "requirements":{
+ "type":"array",
+ "items":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaRequirementRes",
+ "originalRef":"ToscaRequirementRes"
+ }
+ }
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeIdentifier":{
+ "$ref":"#/definitions/ToscaConceptIdentifier",
+ "originalRef":"ToscaConceptIdentifier"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaNodeTemplateRes"
+ },
+ "ToscaNodeTypeReq":{
+ "type":"object",
+ "properties":{
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaProperty",
+ "originalRef":"ToscaProperty"
+ }
+ },
+ "requirements":{
+ "type":"array",
+ "items":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaRequirementReq",
+ "originalRef":"ToscaRequirementReq"
+ }
+ }
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaNodeTypeReq"
+ },
+ "ToscaNodeTypeRes":{
+ "type":"object",
+ "properties":{
+ "definedName":{
+ "type":"string"
+ },
+ "definedVersion":{
+ "type":"string"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "key":{
+ "$ref":"#/definitions/ToscaEntityKey",
+ "originalRef":"ToscaEntityKey"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaProperty",
+ "originalRef":"ToscaProperty"
+ }
+ },
+ "requirements":{
+ "type":"array",
+ "items":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaRequirementRes",
+ "originalRef":"ToscaRequirementRes"
+ }
+ }
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaNodeTypeRes"
+ },
+ "ToscaParameter":{
+ "type":"object",
+ "properties":{
+ "name":{
+ "type":"string"
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "value":{
+ "type":"object"
+ }
+ },
+ "title":"ToscaParameter"
+ },
+ "ToscaProperty":{
+ "type":"object",
+ "properties":{
+ "constraints":{
+ "type":"array",
+ "items":{
+ "$ref":"#/definitions/ToscaConstraint",
+ "originalRef":"ToscaConstraint"
+ }
+ },
+ "defaultValue":{
+ "type":"object"
+ },
+ "description":{
+ "type":"string"
+ },
+ "entrySchema":{
+ "$ref":"#/definitions/ToscaSchemaDefinition",
+ "originalRef":"ToscaSchemaDefinition"
+ },
+ "keySchema":{
+ "$ref":"#/definitions/ToscaSchemaDefinition",
+ "originalRef":"ToscaSchemaDefinition"
+ },
+ "metadata":{
+ "type":"object",
+ "additionalProperties":{
+ "type":"string"
+ }
+ },
+ "name":{
+ "type":"string"
+ },
+ "required":{
+ "type":"boolean"
+ },
+ "status":{
+ "type":"string",
+ "enum":[
+ "DEPRECATED",
+ "EXPERIMENTAL",
+ "SUPPORTED",
+ "UNSUPPORTED"
+ ]
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaProperty"
+ },
+ "ToscaRelationshipTypeReq":{
+ "type":"object",
+ "properties":{
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaProperty",
+ "originalRef":"ToscaProperty"
+ }
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaRelationshipTypeReq"
+ },
+ "ToscaRelationshipTypeRes":{
+ "type":"object",
+ "properties":{
+ "definedName":{
+ "type":"string"
+ },
+ "definedVersion":{
+ "type":"string"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "key":{
+ "$ref":"#/definitions/ToscaEntityKey",
+ "originalRef":"ToscaEntityKey"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "properties":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaProperty",
+ "originalRef":"ToscaProperty"
+ }
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaRelationshipTypeRes"
+ },
+ "ToscaRequirementReq":{
+ "type":"object",
+ "properties":{
+ "capability":{
+ "type":"string"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "node":{
+ "type":"string"
+ },
+ "occurrences":{
+ "type":"array",
+ "items":{
+ "type":"object"
+ }
+ },
+ "properties":{
+ "type":"object"
+ },
+ "relationship":{
+ "type":"string"
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaRequirementReq"
+ },
+ "ToscaRequirementRes":{
+ "type":"object",
+ "properties":{
+ "capability":{
+ "type":"string"
+ },
+ "definedName":{
+ "type":"string"
+ },
+ "definedVersion":{
+ "type":"string"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "identifier":{
+ "$ref":"#/definitions/ToscaConceptIdentifier",
+ "originalRef":"ToscaConceptIdentifier"
+ },
+ "key":{
+ "$ref":"#/definitions/ToscaEntityKey",
+ "originalRef":"ToscaEntityKey"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "node":{
+ "type":"string"
+ },
+ "occurrences":{
+ "type":"array",
+ "items":{
+ "type":"object"
+ }
+ },
+ "properties":{
+ "type":"object"
+ },
+ "relationship":{
+ "type":"string"
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeIdentifier":{
+ "$ref":"#/definitions/ToscaConceptIdentifier",
+ "originalRef":"ToscaConceptIdentifier"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaRequirementRes"
+ },
+ "ToscaSchemaDefinition":{
+ "type":"object",
+ "properties":{
+ "constraints":{
+ "type":"array",
+ "items":{
+ "$ref":"#/definitions/ToscaConstraint",
+ "originalRef":"ToscaConstraint"
+ }
+ },
+ "description":{
+ "type":"string"
+ },
+ "name":{
+ "type":"string"
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaSchemaDefinition"
+ },
+ "ToscaServiceTemplateReq":{
+ "type":"object",
+ "properties":{
+ "capabilityTypes":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaCapabilityTypeReq",
+ "originalRef":"ToscaCapabilityTypeReq"
+ }
+ },
+ "dataTypes":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaDataTypeReq",
+ "originalRef":"ToscaDataTypeReq"
+ }
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "nodeTypes":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaNodeTypeReq",
+ "originalRef":"ToscaNodeTypeReq"
+ }
+ },
+ "relationshipTypes":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaRelationshipTypeReq",
+ "originalRef":"ToscaRelationshipTypeReq"
+ }
+ },
+ "toscaDefinitionsVersion":{
+ "type":"string"
+ },
+ "toscaTopologyTemplate":{
+ "$ref":"#/definitions/ToscaTopologyTemplateReq",
+ "originalRef":"ToscaTopologyTemplateReq"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaServiceTemplateReq"
+ },
+ "ToscaServiceTemplateRes":{
+ "type":"object",
+ "properties":{
+ "capabilityTypes":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaCapabilityTypeRes",
+ "originalRef":"ToscaCapabilityTypeRes"
+ }
+ },
+ "dataTypes":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaDataTypeRes",
+ "originalRef":"ToscaDataTypeRes"
+ }
+ },
+ "dataTypesAsMap":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaDataTypeRes",
+ "originalRef":"ToscaDataTypeRes"
+ }
+ },
+ "definedName":{
+ "type":"string"
+ },
+ "definedVersion":{
+ "type":"string"
+ },
+ "derivedFrom":{
+ "type":"string"
+ },
+ "description":{
+ "type":"string"
+ },
+ "key":{
+ "$ref":"#/definitions/ToscaEntityKey",
+ "originalRef":"ToscaEntityKey"
+ },
+ "metadata":{
+ "type":"object"
+ },
+ "name":{
+ "type":"string"
+ },
+ "nodeTypes":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaNodeTypeRes",
+ "originalRef":"ToscaNodeTypeRes"
+ }
+ },
+ "relationshipTypes":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaRelationshipTypeRes",
+ "originalRef":"ToscaRelationshipTypeRes"
+ }
+ },
+ "toscaDefinitionsVersion":{
+ "type":"string"
+ },
+ "toscaTopologyTemplate":{
+ "$ref":"#/definitions/ToscaTopologyTemplateRes",
+ "originalRef":"ToscaTopologyTemplateRes"
+ },
+ "type":{
+ "type":"string"
+ },
+ "typeVersion":{
+ "type":"string"
+ },
+ "version":{
+ "type":"string"
+ }
+ },
+ "title":"ToscaServiceTemplateRes"
+ },
+ "ToscaTopologyTemplateReq":{
+ "type":"object",
+ "properties":{
+ "description":{
+ "type":"string"
+ },
+ "inputs":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaParameter",
+ "originalRef":"ToscaParameter"
+ }
+ },
+ "nodeTemplates":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaNodeTemplateReq",
+ "originalRef":"ToscaNodeTemplateReq"
+ }
+ }
+ },
+ "title":"ToscaTopologyTemplateReq"
+ },
+ "ToscaTopologyTemplateRes":{
+ "type":"object",
+ "properties":{
+ "description":{
+ "type":"string"
+ },
+ "inputs":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaParameter",
+ "originalRef":"ToscaParameter"
+ }
+ },
+ "nodeTemplates":{
+ "type":"object",
+ "additionalProperties":{
+ "$ref":"#/definitions/ToscaNodeTemplateRes",
+ "originalRef":"ToscaNodeTemplateRes"
+ }
+ }
+ },
+ "title":"ToscaTopologyTemplateRes"
+ }
+ }
+}
diff --git a/docs/development/development.rst b/docs/development/development.rst
index 4da6f51a..2ae3d644 100644
--- a/docs/development/development.rst
+++ b/docs/development/development.rst
@@ -12,3 +12,4 @@ Policy Platform Development
pdp/pdp-pap-interaction.rst
actors/actors.rst
property-configuration.rst
+ prometheus-metrics.rst
diff --git a/docs/development/devtools/clamp-smoke.rst b/docs/development/devtools/clamp-smoke.rst
index 764c9ff2..80f8c3b7 100644
--- a/docs/development/devtools/clamp-smoke.rst
+++ b/docs/development/devtools/clamp-smoke.rst
@@ -4,14 +4,14 @@
.. _policy-clamp-runtime-smoke-label:
-CLAMP control loop runtime Smoke Tests
-######################################
+CLAMP Automation Composition Smoke Tests
+########################################
.. contents::
:depth: 3
-This article explains how to build the CLAMP control loop runtime for development purposes and how to run smoke tests for control loop runtime. To start, the developer should consult the latest ONAP Wiki to familiarize themselves with developer best practices and how-tos to setup their environment, see `https://wiki.onap.org/display/DW/Developer+Best+Practices`.
+This article explains how to build the CLAMP automation composition for development purposes and how to run smoke tests for automation composition. To start, the developer should consult the latest ONAP Wiki to familiarize themselves with developer best practices and how-tos to setup their environment, see `https://wiki.onap.org/display/DW/Developer+Best+Practices`.
This article assumes that:
@@ -24,10 +24,10 @@ This article assumes that:
The procedure documented in this article has been verified using Unbuntu 20.04 LTS VM.
-Cloning CLAMP control loop runtime and all dependency
-*****************************************************
+Cloning CLAMP automation composition and all dependency
+*******************************************************
-Run a script such as the script below to clone the required modules from the `ONAP git repository <https://gerrit.onap.org/r/#/admin/projects/?filter=policy>`_. This script clones CLAMP control loop runtime and all dependency.
+Run a script such as the script below to clone the required modules from the `ONAP git repository <https://gerrit.onap.org/r/#/admin/projects/?filter=policy>`_. This script clones CLAMP automation composition and all dependency.
ONAP Policy Framework has dependencies to the ONAP Parent *oparent* module, the ONAP ECOMP SDK *ecompsdkos* module, and the A&AI Schema module.
@@ -142,8 +142,8 @@ Execution of the script above results in the following directory hierarchy in yo
* ~/git/onap/policy/docker
-Building CLAMP control loop runtime and all dependency
-******************************************************
+Building CLAMP automation composition and all dependency
+********************************************************
**Step 1:** Optionally, for a completely clean build, remove the ONAP built modules from your local repository.
@@ -155,8 +155,8 @@ Building CLAMP control loop runtime and all dependency
**Step 2:** A pom such as the one below can be used to build the ONAP Policy Framework modules. Create the *pom.xml* file in the directory *~/git/onap/policy*.
.. code-block:: xml
- :caption: Typical pom.xml to build the ONAP Policy Framework
- :linenos:
+ :caption: Typical pom.xml to build the ONAP Policy Framework
+ :linenos:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
@@ -181,14 +181,14 @@ Building CLAMP control loop runtime and all dependency
**Step 3:** You can now build the Policy framework.
-Java artifacts only:
+Build java artifacts only:
.. code-block:: bash
cd ~/git/onap/policy
mvn -pl '!org.onap.policy.clamp:policy-clamp-runtime' install
-With docker images:
+Build with docker images:
.. code-block:: bash
@@ -201,16 +201,16 @@ Running MariaDb and DMaaP Simulator
Running a MariaDb Instance
++++++++++++++++++++++++++
-Assuming you have successfully built the codebase using the instructions above. There are two requirements for the Clamp controlloop runtime component to run, one of them is a
+Assuming you have successfully built the codebase using the instructions above. There are two requirements for the Clamp automation composition component to run, one of them is a
running MariaDb database instance. The easiest way to do this is to run the docker image locally.
An sql such as the one below can be used to build the SQL initialization. Create the *mariadb.sql* file in the directory *~/git*.
.. code-block:: SQL
- create database controlloop;
+ create database clampacm;
CREATE USER 'policy'@'%' IDENTIFIED BY 'P01icY';
- GRANT ALL PRIVILEGES ON controlloop.* TO 'policy'@'%';
+ GRANT ALL PRIVILEGES ON clampacm.* TO 'policy'@'%';
Execution of the command above results in the creation and start of the *mariadb-smoke-test* container.
@@ -227,7 +227,7 @@ Execution of the command above results in the creation and start of the *mariadb
Running the DMaaP Simulator during Development
++++++++++++++++++++++++++++++++++++++++++++++
-The second requirement for the Clamp controlloop runtime component to run is to run the DMaaP simulator. You can run it from the command line using Maven.
+The second requirement for the Clamp automation composition component to run is to run the DMaaP simulator. You can run it from the command line using Maven.
Change the local configuration file *src/test/resources/simParameters.json* using the below code:
@@ -258,8 +258,8 @@ Run the following commands:
mvn exec:java -Dexec.mainClass=org.onap.policy.models.simulators.Main -Dexec.args="src/test/resources/simParameters.json"
-Developing and Debugging CLAMP control loop runtime
-***************************************************
+Developing and Debugging CLAMP automation composition
+*****************************************************
Running on the Command Line using Maven
+++++++++++++++++++++++++++++++++++++++
@@ -268,7 +268,7 @@ Once the mariadb and DMaap simulator are up and running, run the following comma
.. code-block:: bash
- cd ~/git/onap/policy/clamp/runtime-controlloop
+ cd ~/git/onap/policy/clamp/runtime-acm
mvn spring-boot:run
@@ -277,19 +277,19 @@ Running on the Command Line
.. code-block:: bash
- cd ~/git/onap/policy/clamp/runtime-controlloop
- java -jar target/policy-clamp-runtime-controlloop-6.1.3-SNAPSHOT.jar
+ cd ~/git/onap/policy/clamp/runtime-acm
+ java -jar target/policy-clamp-runtime-acm-6.2.2-SNAPSHOT.jar
Running in Eclipse
++++++++++++++++++
1. Check out the policy models repository
-2. Go to the *policy-clamp-runtime-controlloop* module in the clamp repo
-3. Specify a run configuration using the class *org.onap.policy.clamp.controlloop.runtime.Application* as the main class
+2. Go to the *policy-clamp-runtime-acm* module in the clamp repo
+3. Specify a run configuration using the class *org.onap.policy.clamp.acm.runtime.Application* as the main class
4. Run the configuration
-Swagger UI of Control loop runtime is available at *http://localhost:6969/onap/controlloop/swagger-ui/*, and swagger JSON at *http://localhost:6969/onap/controlloop/v2/api-docs/*
+Swagger UI of Automation composition is available at *http://localhost:6969/onap/policy/clamp/acm/swagger-ui/*, and swagger JSON at *http://localhost:6969/onap/policy/clamp/acm/v2/api-docs/*
Running one or more participant simulators
@@ -301,24 +301,24 @@ Copy the file *src/main/resources/config/application.yaml* and paste into *src/t
.. code-block:: yaml
participantId:
- name: org.onap.policy.controlloop.PolicyControlLoopParticipant
- version: 2.3.1
- participantType:
name: org.onap.PM_Policy
version: 1.0.0
+ participantType:
+ name: org.onap.policy.clamp.acm.PolicyParticipant
+ version: 2.3.1
Run the following commands:
.. code-block:: bash
cd ~/git/onap/policy/clamp/participant/participant-impl/participant-impl-simulator
- java -jar target/policy-clamp-participant-impl-simulator-6.1.3-SNAPSHOT.jar --spring.config.location=src/test/resources/application.yaml
+ java -jar target/policy-clamp-participant-impl-simulator-6.2.2-SNAPSHOT.jar --spring.config.location=src/main/resources/config/application.yaml
Creating self-signed certificate
++++++++++++++++++++++++++++++++
-There is an additional requirement for the Clamp control loop runtime docker image to run, is creating the SSL self-signed certificate.
+There is an additional requirement for the Clamp automation composition docker image to run, is creating the SSL self-signed certificate.
Run the following commands:
@@ -338,8 +338,8 @@ Execution of the commands above results additional files into the following dire
* ~/git/onap/policy/docker/csit/config/ks.jks
-Running the CLAMP control loop runtime docker image
-+++++++++++++++++++++++++++++++++++++++++++++++++++
+Running the CLAMP automation composition docker image
++++++++++++++++++++++++++++++++++++++++++++++++++++++
Run the following command:
@@ -350,8 +350,65 @@ Run the following command:
-e mariadb.host=host.docker.internal \
-e topicServer=host.docker.internal \
--mount type=bind,source=~/git/onap/policy/docker/csit/config/ks.jks,target=/opt/app/policy/clamp/etc/ssl/policy-keystore \
- --mount type=bind,source=~/git/onap/policy/clamp/runtime-controlloop/src/main/resources/application.yaml,target=/opt/app/policy/clamp/etc/ClRuntimeParameters.yaml \
- onap/policy-clamp-cl-runtime
+ --mount type=bind,source=~/git/onap/policy/clamp/runtime-acm/src/main/resources/application.yaml,target=/opt/app/policy/clamp/etc/AcRuntimeParameters.yaml \
+ onap/policy-clamp-runtime-acm
+
+
+Swagger UI of automation composition is available at *https://localhost:6969/onap/policy/clamp/acm/swagger-ui/*, and swagger JSON at *https://localhost:6969/onap/policy/clamp/acm/v2/api-docs/*
-Swagger UI of Control loop runtime is available at *https://localhost:6969/onap/controlloop/swagger-ui/*, and swagger JSON at *https://localhost:6969/onap/controlloop/v2/api-docs/*
+Using CLAMP runtime to connect to CLAMP automation composition
+**************************************************************
+
+Build CLAMP runtime image:
+
+ .. code-block:: bash
+
+ cd ~/git/onap/policy/clamp/runtime
+ mvn clean install -P docker -DskipTests
+
+
+Run the following docker composition:
+
+ .. code-block:: yaml
+
+ version: '3.1'
+
+ services:
+ db:
+ image: mariadb:10.5.8
+ volumes:
+ - "~/git/onap/policy/clamp/runtime/extra/sql/:/docker-entrypoint-initdb.d:rw"
+ environment:
+ - MYSQL_ROOT_PASSWORD=strong_pitchou
+ ports:
+ - "3306:3306"
+
+ policy-clamp-backend:
+ image: onap/policy-clamp-backend
+ depends_on:
+ - db
+ - third-party-proxy
+ environment:
+ - SPRING_DATASOURCE_URL=jdbc:mariadb:sequential://db:3306/cldsdb4?autoReconnect=true&connectTimeout=10000&socketTimeout=10000&retriesAllDown=3
+ - SPRING_PROFILES_ACTIVE=clamp-default,clamp-default-user,clamp-sdc-controller,clamp-ssl-config,clamp-policy-controller,default-dictionary-elements
+ - CLAMP_CONFIG_POLICY_API_URL=http://third-party-proxy:8085
+ - CLAMP_CONFIG_ACM_RUNTIME_URL=http://host.docker.internal:6969
+ - CLAMP_CONFIG_POLICY_PAP_URL=http://third-party-proxy:8085
+ - CLAMP_CONFIG_DCAE_INVENTORY_URL=http://third-party-proxy:8085
+ - CLAMP_CONFIG_DCAE_DEPLOYMENT_URL=http://third-party-proxy:8085
+ - SPRING_CONFIG_LOCATION=classpath:/application.properties
+ ports:
+ - "10443:8443"
+
+ third-party-proxy:
+ image: python:2-slim
+ volumes:
+ - "~/git/onap/policy/clamp/runtime/src/test/resources/http-cache/example/:/thirdparty:rw"
+ - "~/git/onap/policy/clamp/runtime/src/test/resources/http-cache/:/script/:ro"
+ ports:
+ - "8085:8085"
+ command: /bin/sh -c "pip install --no-cache-dir requests && pip install --no-cache-dir simplejson && python -u /script/third_party_proxy.py -v true --port 8085 --root /thirdparty --proxyaddress third-party-proxy:8085"
+
+
+Run DMaaP simulator, and than run CLAMP Acm using java.
diff --git a/docs/development/prometheus-metrics.rst b/docs/development/prometheus-metrics.rst
new file mode 100644
index 00000000..7e9211ab
--- /dev/null
+++ b/docs/development/prometheus-metrics.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _prometheus-metrics:
+
+Prometheus Metrics support in Policy Framework Components
+#########################################################
+
+.. contents::
+ :depth: 3
+
+This page explains the prometheus metrics exposed by different Policy Framework components.
diff --git a/integration/pom.xml b/integration/pom.xml
index 872162da..b05d2ddd 100644
--- a/integration/pom.xml
+++ b/integration/pom.xml
@@ -1,7 +1,7 @@
<!--
============LICENSE_START=======================================================
Copyright (C) 2018 Ericsson. All rights reserved.
- Modifications Copyright (C) 2018-2021 AT&T. All rights reserved.
+ Modifications Copyright (C) 2018-2022 AT&T. All rights reserved.
Modifications Copyright (C) 2019-2022 Nordix Foundation.
Modifications Copyright (C) 2020-2022 Bell Canada.
================================================================================
@@ -27,7 +27,7 @@
<parent>
<groupId>org.onap.policy.parent</groupId>
<artifactId>policy-parent</artifactId>
- <version>3.5.1-SNAPSHOT</version>
+ <version>3.5.2-SNAPSHOT</version>
</parent>
<artifactId>integration</artifactId>
<packaging>pom</packaging>
@@ -37,12 +37,12 @@
<properties>
<java.version>11</java.version>
<!-- NOTE: For RELEASE/SNAPSHOT always set to the project version -->
- <version.parent.resources>3.5.1-SNAPSHOT</version.parent.resources>
+ <version.parent.resources>3.5.1</version.parent.resources>
<version.logback>1.2.10</version.logback>
<version.dmaap>1.1.12</version.dmaap>
<version.powermock>2.0.9</version.powermock>
<version.eclipselink>2.7.8</version.eclipselink>
- <version.drools>7.33.0.Final</version.drools>
+ <version.drools>7.66.0.Final</version.drools>
<version.jersey>2.34</version.jersey>
<version.jackson>2.12.3</version.jackson>
<version.ccsdk>1.1.5</version.ccsdk>
@@ -225,6 +225,11 @@
<artifactId>simpleclient_servlet</artifactId>
<version>${version.io.prometheus}</version>
</dependency>
+ <dependency>
+ <groupId>io.prometheus</groupId>
+ <artifactId>simpleclient_logback</artifactId>
+ <version>${version.io.prometheus}</version>
+ </dependency>
<!-- Swagger Jersey2 JAXRS -->
<dependency>
diff --git a/pom.xml b/pom.xml
index 8239d8ba..8cc29ae8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -29,7 +29,7 @@
</parent>
<groupId>org.onap.policy.parent</groupId>
<artifactId>policy-parent</artifactId>
- <version>3.5.1-SNAPSHOT</version>
+ <version>3.5.2-SNAPSHOT</version>
<packaging>pom</packaging>
<properties>
diff --git a/releases/3.5.1.yaml b/releases/3.5.1.yaml
new file mode 100644
index 00000000..6758bd53
--- /dev/null
+++ b/releases/3.5.1.yaml
@@ -0,0 +1,4 @@
+distribution_type: 'maven'
+version: '3.5.1'
+project: 'policy-parent'
+log_dir: 'policy-parent-maven-stage-master/1001/'
diff --git a/resources/pom.xml b/resources/pom.xml
index 3774a7e7..92286eff 100644
--- a/resources/pom.xml
+++ b/resources/pom.xml
@@ -23,7 +23,7 @@
<parent>
<groupId>org.onap.policy.parent</groupId>
<artifactId>policy-parent</artifactId>
- <version>3.5.1-SNAPSHOT</version>
+ <version>3.5.2-SNAPSHOT</version>
</parent>
<artifactId>policy-parent-resources</artifactId>
diff --git a/version.properties b/version.properties
index 8c5e39ab..d430d853 100644
--- a/version.properties
+++ b/version.properties
@@ -4,7 +4,7 @@
major=3
minor=5
-patch=1
+patch=2
base_version=${major}.${minor}.${patch}