diff options
| author |   Chenfei Gao <cgao@research.att.com> | 2019-09-10 22:22:17 -0400 |
|---|---|---|
| committer | Chenfei Gao <cgao@research.att.com> | 2019-09-11 16:30:59 -0400 |
| commit | 0a85b8bac10f910fe433ee520ffe44a862515b51 (patch) | |
| tree | 8c3c5536c023d628a283cdb73b494a9bfd7d3b67 | |
| parent | c0784b571a00ff28117ae20d7e55cc885db71557 (diff) | |
Update api docs to reflect the most recent changes to policytypes
Issue-ID: POLICY-2073
Change-Id: I67bcd417329231d5297d8f7e9c982b788cb46928
Signed-off-by: Chenfei Gao <cgao@research.att.com>
25 files changed, 31 insertions, 1730 deletions
@@ -13,3 +13,4 @@ docs/conf.py docs/conf.pyc docs/html/ docs/_static/ +docs/__pycache__/ diff --git a/docs/api/api.rst b/docs/api/api.rst index ab91e635..928782fe 100644 --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -30,46 +30,47 @@ atop. In other words, different policies can match the same or different policy of creating such type of policies. In the payload body of each policy to create, policy type name and version should be indicated and the specified policy type should be valid and existing in policy database. -In Dublin release, to ease policy creation, we preload several widely used policy types in policy database. Below is a table summarizing +In El Alto release, to ease policy creation, we preload several widely used policy types in policy database. Below is a table summarizing preloaded policy types. .. csv-table:: - :header: "Policy Type Name", "Preloaded JSON" + :header: "Policy Type Name", "Payload" :widths: 15,10 - "Controlloop.Guard.Blacklist", ":download:`link <policytypes/onap.policies.controlloop.guard.Blacklist.json>`" - "Controlloop.Guard.FrequencyLimiter", ":download:`link <policytypes/onap.policies.controlloop.guard.FrequencyLimiter.json>`" - "Controlloop.Guard.MinMax", ":download:`link <policytypes/onap.policies.controlloop.guard.MinMax.json>`" - "Controlloop.Operational", ":download:`link <policytypes/onap.policies.controlloop.Operational.json>`" - "Monitoring.TCA", ":download:`link <policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.json>`" - "Monitoring.Collectors", ":download:`link <policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.json>`" - "Optimization.AffinityPolicy", ":download:`link <policytypes/onap.policies.optimization.AffinityPolicy.json>`" - "Optimization.DistancePolicy", ":download:`link <policytypes/onap.policies.optimization.DistancePolicy.json>`" - "Optimization.HpaPolicy", ":download:`link <policytypes/onap.policies.optimization.HpaPolicy.json>`" - "Optimization.OptimizationPolicy", ":download:`link <policytypes/onap.policies.optimization.OptimizationPolicy.json>`" - "Optimization.PciPolicy", ":download:`link <policytypes/onap.policies.optimization.PciPolicy.json>`" - "Optimization.QueryPolicy", ":download:`link <policytypes/onap.policies.optimization.QueryPolicy.json>`" - "Optimization.SubscriberPolicy", ":download:`link <policytypes/onap.policies.optimization.SubscriberPolicy.json>`" - "Optimization.Vim_fit", ":download:`link <policytypes/onap.policies.optimization.Vim_fit.json>`" - "Optimization.VnfPolicy", ":download:`link <policytypes/onap.policies.optimization.VnfPolicy.json>`" - - -Also, in Dublin release, We provide backward compatibility support for controlloop operational and guard + "Controlloop.Guard.Blacklist", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.guard.Blacklist.yaml>`_ + "Controlloop.Guard.FrequencyLimiter", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.guard.FrequencyLimiter.yaml>`_ + "Controlloop.Guard.MinMax", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.guard.MinMax.yaml>`_ + "Controlloop.Guard.Coordination.FirstBlocksSecond", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.guard.coordination.FirstBlocksSecond.yaml>`_ + "Controlloop.Operational", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.Operational.yaml>`_ + "Monitoring.TCA", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.yaml>`_ + "Monitoring.Collectors", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.yaml>`_ + "Optimization", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.Optimization.yaml>`_ + "Optimization.AffinityPolicy", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.optimization.AffinityPolicy.yaml>`_ + "Optimization.DistancePolicy", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.optimization.DistancePolicy.yaml>`_ + "Optimization.HpaPolicy", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.optimization.HpaPolicy.yaml>`_ + "Optimization.OptimizationPolicy", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.optimization.OptimizationPolicy.yaml>`_ + "Optimization.PciPolicy", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.optimization.PciPolicy.yaml>`_ + "Optimization.QueryPolicy", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.optimization.QueryPolicy.yaml>`_ + "Optimization.SubscriberPolicy", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.optimization.SubscriberPolicy.yaml>`_ + "Optimization.Vim_fit", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.optimization.Vim_fit.yaml>`_ + "Optimization.VnfPolicy", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.optimization.VnfPolicy.yaml>`_ + +Also, in El Alto release, We provide backward compatibility support for controlloop operational and guard policies encoded in legacy format. Below is a table containing sample legacy guard/operational policies and well-formed TOSCA monitoring policies. .. csv-table:: - :header: "Policy Name", "Policy JSON" + :header: "Policy Name", "Payload" :widths: 15,10 - "vCPE.Monitoring.Tosca", ":download:`link <policies/vCPE.policy.monitoring.input.tosca.json>`" - "vCPE.Operational.Legacy", ":download:`link <policies/vCPE.policy.operational.input.json>`" - "vDNS.Guard.FrequencyLimiting.Legacy", ":download:`link <policies/vDNS.policy.guard.frequency.input.json>`" - "vDNS.Guard.MinMax.Legacy", ":download:`link <policies/vDNS.policy.guard.minmax.input.json>`" - "vDNS.Monitoring.Tosca", ":download:`link <policies/vDNS.policy.monitoring.input.tosca.json>`" - "vDNS.Operational.Legacy", ":download:`link <policies/vDNS.policy.operational.input.json>`" - "vFirewall.Monitoring.Tosca", ":download:`link <policies/vFirewall.policy.monitoring.input.tosca.json>`" - "vFirewall.Operational.Legacy", ":download:`link <policies/vFirewall.policy.operational.input.json>`" + "vCPE.Monitoring.Tosca", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.policy.monitoring.input.tosca.yaml>`_ | `json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.policy.monitoring.input.tosca.json>`_ + "vCPE.Operational.Legacy", `json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.policy.operational.input.json>`_ + "vDNS.Guard.FrequencyLimiting.Legacy", `json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vDNS.policy.guard.frequency.input.json>`_ + "vDNS.Guard.MinMax.Legacy", `json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vDNS.policy.guard.minmax.input.json>`_ + "vDNS.Monitoring.Tosca", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vDNS.policy.monitoring.input.tosca.yaml>`_ | `json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vDNS.policy.monitoring.input.tosca.json>`_ + "vDNS.Operational.Legacy", `json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vDNS.policy.operational.input.json>`_ + "vFirewall.Monitoring.Tosca", `yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vFirewall.policy.monitoring.input.tosca.yaml>`_ | `json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vFirewall.policy.monitoring.input.tosca.json>`_ + "vFirewall.Operational.Legacy", `json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vFirewall.policy.operational.input.json>`_ Below is a global API table from where swagger JSON for different types of policy design API can be downloaded. diff --git a/docs/api/policies/vCPE.policy.monitoring.input.tosca.json b/docs/api/policies/vCPE.policy.monitoring.input.tosca.json deleted file mode 100644 index 7a63f658..00000000 --- a/docs/api/policies/vCPE.policy.monitoring.input.tosca.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "topology_template": { - "policies": [ - { - "onap.restart.tca": { - "type": "onap.policies.monitoring.cdap.tca.hi.lo.app", - "version": "1.0.0", - "type_version": "1.0.0", - "metadata": { - "policy-id": "onap.restart.tca" - }, - "properties": { - "tca_policy" : { - "domain": "measurementsForVfScaling", - "metricsPerEventName": [ - { - "eventName": "Measurement_vGMUX", - "controlLoopSchemaType": "VNF", - "policyScope": "DCAE", - "policyName": "DCAE.Config_tca-hi-lo", - "policyVersion": "v0.0.1", - "thresholds": [ - { - "closedLoopControlName": "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e", - "version": "1.0.2", - "fieldPath": "$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value", - "thresholdValue": 0, - "direction": "EQUAL", - "severity": "MAJOR", - "closedLoopEventStatus": "ABATED" - }, - { - "closedLoopControlName": "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e", - "version": "1.0.2", - "fieldPath": "$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value", - "thresholdValue": 0, - "direction": "GREATER", - "severity": "CRITICAL", - "closedLoopEventStatus": "ONSET" - } - ] - } - ] - } - } - } - } - ] - } -}
\ No newline at end of file diff --git a/docs/api/policies/vCPE.policy.operational.input.json b/docs/api/policies/vCPE.policy.operational.input.json deleted file mode 100644 index 393cb028..00000000 --- a/docs/api/policies/vCPE.policy.operational.input.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "policy-id" : "operational.restart", - "content" : "controlLoop%3A%0A%20%20version%3A%202.0.0%0A%20%20controlLoopName%3A%20ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e%0A%20%20trigger_policy%3A%20unique-policy-id-1-restart%0A%20%20timeout%3A%203600%0A%20%20abatement%3A%20true%0A%20%0Apolicies%3A%0A%20%20-%20id%3A%20unique-policy-id-1-restart%0A%20%20%20%20name%3A%20Restart%20the%20VM%0A%20%20%20%20description%3A%0A%20%20%20%20actor%3A%20APPC%0A%20%20%20%20recipe%3A%20Restart%0A%20%20%20%20target%3A%0A%20%20%20%20%20%20type%3A%20VM%0A%20%20%20%20retry%3A%203%0A%20%20%20%20timeout%3A%201200%0A%20%20%20%20success%3A%20final_success%0A%20%20%20%20failure%3A%20final_failure%0A%20%20%20%20failure_timeout%3A%20final_failure_timeout%0A%20%20%20%20failure_retries%3A%20final_failure_retries%0A%20%20%20%20failure_exception%3A%20final_failure_exception%0A%20%20%20%20failure_guard%3A%20final_failure_guard" -}
\ No newline at end of file diff --git a/docs/api/policies/vDNS.policy.guard.frequency.input.json b/docs/api/policies/vDNS.policy.guard.frequency.input.json deleted file mode 100644 index 442f3ec4..00000000 --- a/docs/api/policies/vDNS.policy.guard.frequency.input.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "policy-id" : "guard.frequency.scaleout", - "content" : { - "actor": "SO", - "recipe": "scaleOut", - "targets": ".*", - "clname": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3", - "limit": "1", - "timeWindow": "10", - "timeUnits": "minute", - "guardActiveStart": "00:00:01-05:00", - "guardActiveEnd": "23:59:59-05:00" - } -} diff --git a/docs/api/policies/vDNS.policy.guard.minmax.input.json b/docs/api/policies/vDNS.policy.guard.minmax.input.json deleted file mode 100644 index 45a7d41d..00000000 --- a/docs/api/policies/vDNS.policy.guard.minmax.input.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "policy-id" : "guard.minmax.scaleout", - "content" : { - "actor": "SO", - "recipe": "scaleOut", - "targets": ".*", - "clname": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3", - "min": "1", - "max": "5", - "guardActiveStart": "00:00:01-05:00", - "guardActiveEnd": "23:59:59-05:00" - } -}
\ No newline at end of file diff --git a/docs/api/policies/vDNS.policy.monitoring.input.tosca.json b/docs/api/policies/vDNS.policy.monitoring.input.tosca.json deleted file mode 100644 index d2f9584e..00000000 --- a/docs/api/policies/vDNS.policy.monitoring.input.tosca.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "topology_template": { - "policies": [ - { - "onap.scaleout.tca": { - "type": "onap.policies.monitoring.cdap.tca.hi.lo.app", - "version": "1.0.0", - "metadata": { - "policy-id": "onap.scaleout.tca" - }, - "properties": { - "tca_policy": { - "domain": "measurementsForVfScaling", - "metricsPerEventName": [ - { - "eventName": "vLoadBalancer", - "controlLoopSchemaType": "VNF", - "policyScope": "type=configuration", - "policyName": "onap.scaleout.tca", - "policyVersion": "v0.0.1", - "thresholds": [ - { - "closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3", - "closedLoopEventStatus": "ONSET", - "version": "1.0.2", - "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated", - "thresholdValue": 500, - "direction": "LESS_OR_EQUAL", - "severity": "MAJOR" - }, - { - "closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3", - "closedLoopEventStatus": "ONSET", - "version": "1.0.2", - "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated", - "thresholdValue": 5000, - "direction": "GREATER_OR_EQUAL", - "severity": "CRITICAL" - } - ] - } - ] - } - } - } - } - ] - } -}
\ No newline at end of file diff --git a/docs/api/policies/vDNS.policy.operational.input.json b/docs/api/policies/vDNS.policy.operational.input.json deleted file mode 100644 index dabde011..00000000 --- a/docs/api/policies/vDNS.policy.operational.input.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "policy-id" : "operational.scaleout", - "content" : "controlLoop%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20version%3A%202.0.0%0A%20%20%20%20%20%20%20%20%20%20%20%20%20controlLoopName%3A%20ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3%0A%20%20%20%20%20%20%20%20%20%20%20%20%20trigger_policy%3A%20unique-policy-id-1-scale-up%0A%20%20%20%20%20%20%20%20%20%20%20%20%20timeout%3A%201200%0A%20%20%20%20%20%20%20%20%20%20%20%20%20abatement%3A%20false%0A%20%20%20%20%20%20%20%20%20%20%20policies%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20-%20id%3A%20unique-policy-id-1-scale-up%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20name%3A%20Create%20a%20new%20VF%20Module%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20description%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20actor%3A%20SO%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20recipe%3A%20VF%20Module%20Create%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20target%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20type%3A%20VNF%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20payload%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20requestParameters%3A%20'%7B%22usePreload%22%3Atrue%2C%22userParams%22%3A%5B%5D%7D'%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20configurationParameters%3A%20'%5B%7B%22ip-addr%22%3A%22%24.vf-module-topology.vf-module-parameters.param%5B9%5D%22%2C%22oam-ip-addr%22%3A%22%24.vf-module-topology.vf-module-parameters.param%5B16%5D%22%2C%22enabled%22%3A%22%24.vf-module-topology.vf-module-parameters.param%5B23%5D%22%7D%5D'%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20retry%3A%200%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20timeout%3A%201200%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20success%3A%20final_success%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure%3A%20final_failure%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure_timeout%3A%20final_failure_timeout%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure_retries%3A%20final_failure_retries%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure_exception%3A%20final_failure_exception%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure_guard%3A%20final_failure_guard" -}
\ No newline at end of file diff --git a/docs/api/policies/vFirewall.policy.monitoring.input.tosca.json b/docs/api/policies/vFirewall.policy.monitoring.input.tosca.json deleted file mode 100644 index a0046fb5..00000000 --- a/docs/api/policies/vFirewall.policy.monitoring.input.tosca.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "topology_template": { - "policies": [ - { - "onap.vfirewall.tca": { - "type": "onap.policies.monitoring.cdap.tca.hi.lo.app", - "version": "1.0.0", - "metadata": { - "policy-id": "onap.vfirewall.tca" - }, - "properties": { - "tca_policy": { - "domain": "measurementsForVfScaling", - "metricsPerEventName": [ - { - "eventName": "vLoadBalancer", - "controlLoopSchemaType": "VNF", - "policyScope": "resource=vLoadBalancer;type=configuration", - "policyName": "onap.vfirewall.tca", - "policyVersion": "v0.0.1", - "thresholds": [ - { - "closedLoopControlName": "ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a", - "closedLoopEventStatus": "ONSET", - "version": "1.0.2", - "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated", - "thresholdValue": 500, - "direction": "LESS_OR_EQUAL", - "severity": "MAJOR" - }, - { - "closedLoopControlName": "ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a", - "closedLoopEventStatus": "ONSET", - "version": "1.0.2", - "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated", - "thresholdValue": 5000, - "direction": "GREATER_OR_EQUAL", - "severity": "CRITICAL" - } - ] - } - ] - } - } - } - } - ] - } -}
\ No newline at end of file diff --git a/docs/api/policies/vFirewall.policy.operational.input.json b/docs/api/policies/vFirewall.policy.operational.input.json deleted file mode 100644 index 623a6899..00000000 --- a/docs/api/policies/vFirewall.policy.operational.input.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "policy-id" : "operational.modifyconfig", - "content" : "controlLoop%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20version%3A%202.0.0%0A%20%20%20%20%20%20%20%20%20%20%20%20%20controlLoopName%3A%20ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a%0A%20%20%20%20%20%20%20%20%20%20%20%20%20trigger_policy%3A%20unique-policy-id-1-modifyConfig%0A%20%20%20%20%20%20%20%20%20%20%20%20%20timeout%3A%201200%0A%20%20%20%20%20%20%20%20%20%20%20%20%20abatement%3A%20false%0A%20%0A%20%20%20%20%20%20%20%20%20%20%20policies%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20-%20id%3A%20unique-policy-id-1-modifyConfig%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20name%3A%20modify%20packet%20gen%20config%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20description%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20actor%3A%20APPC%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20recipe%3A%20ModifyConfig%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20target%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%23%20TBD%20-%20Cannot%20be%20known%20until%20instantiation%20is%20done%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20resourceID%3A%20Eace933104d443b496b8.nodes.heat.vpg%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20type%3A%20VNF%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20retry%3A%200%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20timeout%3A%20300%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20success%3A%20final_success%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure%3A%20final_failure%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure_timeout%3A%20final_failure_timeout%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure_retries%3A%20final_failure_retries%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure_exception%3A%20final_failure_exception%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20failure_guard%3A%20final_failure_guard" -}
\ No newline at end of file diff --git a/docs/api/policytypes/onap.policies.controlloop.Operational.json b/docs/api/policytypes/onap.policies.controlloop.Operational.json deleted file mode 100644 index 2d36a258..00000000 --- a/docs/api/policytypes/onap.policies.controlloop.Operational.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.controlloop.Operational": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "Operational Policy for Control Loops" - } - } - ] -}
\ No newline at end of file diff --git a/docs/api/policytypes/onap.policies.controlloop.guard.Blacklist.json b/docs/api/policytypes/onap.policies.controlloop.guard.Blacklist.json deleted file mode 100644 index 9391496c..00000000 --- a/docs/api/policytypes/onap.policies.controlloop.guard.Blacklist.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.controlloop.Guard": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "Guard Policies for Control Loop Operational Policies" - } - }, - { - "onap.policies.controlloop.guard.Blacklist": { - "derived_from": "onap.policies.controlloop.Guard", - "version": "1.0.0", - "description": "Supports blacklist of VNF's from performing control loop actions on.", - "properties": { - "blacklist_policy": { - "type": "map", - "description": null, - "entry_schema": { - "type": "onap.datatypes.guard.Blacklist" - } - } - } - } - } - ], - "data_types": [ - { - "onap.datatypes.guard.Blacklist": { - "derived_from": "tosca.datatypes.Root", - "properties": { - "actor": { - "type": "string", - "description": "Specifies the Actor", - "required": true - }, - "recipe": { - "type": "string", - "description": "Specified the Recipe", - "required": true - }, - "time_range": { - "type": "tosca.datatypes.TimeInterval", - "description": "An optional range of time during the day the blacklist is valid for.", - "required": false - }, - "controlLoopName": { - "type": "string", - "description": "An optional specific control loop to apply this guard to.", - "required": false - }, - "blacklist": { - "type": "list", - "description": "List of VNF's", - "required": true - } - } - } - } - ] -}
\ No newline at end of file diff --git a/docs/api/policytypes/onap.policies.controlloop.guard.FrequencyLimiter.json b/docs/api/policytypes/onap.policies.controlloop.guard.FrequencyLimiter.json deleted file mode 100644 index 598bd3c7..00000000 --- a/docs/api/policytypes/onap.policies.controlloop.guard.FrequencyLimiter.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.controlloop.Guard": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "Guard Policies for Control Loop Operational Policies" - } - }, - { - "onap.policies.controlloop.guard.FrequencyLimiter": { - "derived_from": "onap.policies.controlloop.Guard", - "version": "1.0.0", - "description": "Supports limiting the frequency of actions being taken by a Actor.", - "properties": { - "frequency_policy": { - "type": "map", - "description": null, - "entry_schema": { - "type": "onap.datatypes.guard.FrequencyLimiter" - } - } - } - } - } - ], - "data_types": [ - { - "onap.datatypes.guard.FrequencyLimiter": { - "derived_from": "tosca.datatypes.Root", - "properties": { - "actor": { - "type": "string", - "description": "Specifies the Actor", - "required": true - }, - "recipe": { - "type": "string", - "description": "Specified the Recipe", - "required": true - }, - "time_window": { - "type": "scalar-unit.time", - "description": "The time window to count the actions against.", - "required": true - }, - "limit": { - "type": "integer", - "description": "The limit", - "required": true, - "constraints": [ - { - "greater_than": 0 - } - ] - }, - "time_range": { - "type": "tosca.datatypes.TimeInterval", - "description": "An optional range of time during the day the frequency is valid for.", - "required": false - }, - "controlLoopName": { - "type": "string", - "description": "An optional specific control loop to apply this guard to.", - "required": false - }, - "target": { - "type": "string", - "description": "An optional specific VNF to apply this guard to.", - "required": false - } - } - } - } - ] -}
\ No newline at end of file diff --git a/docs/api/policytypes/onap.policies.controlloop.guard.MinMax.json b/docs/api/policytypes/onap.policies.controlloop.guard.MinMax.json deleted file mode 100644 index 71658dd4..00000000 --- a/docs/api/policytypes/onap.policies.controlloop.guard.MinMax.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "policy_types": [ - { - "onap.policies.controlloop.Guard": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "Guard Policies for Control Loop Operational Policies" - } - }, - { - "onap.policies.controlloop.guard.MinMax": { - "derived_from": "onap.policies.controlloop.Guard", - "version": "1.0.0", - "description": "Supports Min/Max number of VF Modules", - "properties": { - "minmax_policy": { - "type": "map", - "description": null, - "entry_schema": { - "type": "onap.datatypes.guard.MinMax" - } - } - } - } - } - ], - "data_types": [ - { - "onap.datatypes.guard.MinMax": { - "derived_from": "tosca.datatypes.Root", - "properties": { - "actor": { - "type": "string", - "description": "Specifies the Actor", - "required": true - }, - "recipe": { - "type": "string", - "description": "Specified the Recipe", - "required": true - }, - "time_range": { - "type": "tosca.datatypes.TimeInterval", - "description": "An optional range of time during the day the Min/Max limit is valid for.", - "required": false - }, - "controlLoopName": { - "type": "string", - "description": "An optional specific control loop to apply this guard to.", - "required": false - }, - "min_vf_module_instances": { - "type": "integer", - "required": true, - "description": "The minimum instances of this VF-Module" - }, - "max_vf_module_instances": { - "type": "integer", - "required": false, - "description": "The maximum instances of this VF-Module" - } - } - } - } - ] -}
\ No newline at end of file diff --git a/docs/api/policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.json b/docs/api/policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.json deleted file mode 100644 index ce46dac8..00000000 --- a/docs/api/policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.json +++ /dev/null @@ -1,224 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Monitoring": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that governs monitoring provisioning" - } - }, - { - "onap.policies.monitoring.cdap.tca.hi.lo.app": { - "derived_from": "onap.policies.Monitoring", - "version": "1.0.0", - "properties": { - "tca_policy": { - "type": "map", - "description": "TCA Policy JSON", - "entry_schema": { - "type": "onap.datatypes.monitoring.tca_policy" - } - } - } - } - } - ], - "data_types": [ - { - "onap.datatypes.monitoring.metricsPerEventName": { - "derived_from": "tosca.datatypes.Root", - "properties": { - "controlLoopSchemaType": { - "type": "string", - "required": true, - "description": "Specifies Control Loop Schema Type for the event Name e.g. VNF, VM", - "constraints": [ - { - "valid_values": [ - "VM", - "VNF" - ] - } - ] - }, - "eventName": { - "type": "string", - "required": true, - "description": "Event name to which thresholds need to be applied" - }, - "policyName": { - "type": "string", - "required": true, - "description": "TCA Policy Scope Name" - }, - "policyScope": { - "type": "string", - "required": true, - "description": "TCA Policy Scope" - }, - "policyVersion": { - "type": "string", - "required": true, - "description": "TCA Policy Scope Version" - }, - "thresholds": { - "type": "list", - "required": true, - "description": "Thresholds associated with eventName", - "entry_schema": { - "type": "onap.datatypes.monitoring.thresholds" - } - } - } - } - }, - { - "onap.datatypes.monitoring.tca_policy": { - "derived_from": "tosca.datatypes.Root", - "properties": { - "domain": { - "type": "string", - "required": true, - "description": "Domain name to which TCA needs to be applied", - "default": "measurementsForVfScaling", - "constraints": [ - { - "equal": "measurementsForVfScaling" - } - ] - }, - "metricsPerEventName": { - "type": "list", - "required": true, - "description": "Contains eventName and threshold details that need to be applied to given eventName", - "entry_schema": { - "type": "onap.datatypes.monitoring.metricsPerEventName" - } - } - } - } - }, - { - "onap.datatypes.monitoring.thresholds": { - "derived_from": "tosca.datatypes.Root", - "properties": { - "closedLoopControlName": { - "type": "string", - "required": true, - "description": "Closed Loop Control Name associated with the threshold" - }, - "closedLoopEventStatus": { - "type": "string", - "required": true, - "description": "Closed Loop Event Status of the threshold", - "constraints": [ - { - "valid_values": [ - "ONSET", - "ABATED" - ] - } - ] - }, - "direction": { - "type": "string", - "required": true, - "description": "Direction of the threshold", - "constraints": [ - { - "valid_values": [ - "LESS", - "LESS_OR_EQUAL", - "GREATER", - "GREATER_OR_EQUAL", - "EQUAL" - ] - } - ] - }, - "fieldPath": { - "type": "string", - "required": true, - "description": "Json field Path as per CEF message which needs to be analyzed for TCA", - "constraints": [ - { - "valid_values": [ - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedOctetsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedUnicastPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedMulticastPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedErrorPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedOctetsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedUnicastPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedMulticastPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedErrorPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedTotalPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedOctetsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedUnicastPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedMulticastPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedBroadcastPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedDiscardedPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedErrorPacketsDelta", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedTotalPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedOctetsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedUnicastPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedMulticastPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedBroadcastPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedDiscardedPacketsAccumulated", - "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedErrorPacketsAccumulated", - "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuIdle", - "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageInterrupt", - "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageNice", - "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSoftIrq", - "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSteal", - "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSystem", - "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuWait", - "$.event.measurementsForVfScalingFields.cpuUsageArray[*].percentUsage", - "$.event.measurementsForVfScalingFields.meanRequestLatency", - "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryBuffered", - "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryCached", - "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryConfigured", - "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryFree", - "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryUsed", - "$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value" - ] - } - ] - }, - "severity": { - "type": "string", - "required": true, - "description": "Threshold Event Severity", - "constraints": [ - { - "valid_values": [ - "CRITICAL", - "MAJOR", - "MINOR", - "WARNING", - "NORMAL" - ] - } - ] - }, - "thresholdValue": { - "type": "integer", - "required": true, - "description": "Threshold value for the field Path inside CEF message" - }, - "version": { - "type": "string", - "required": true, - "description": "Version number associated with the threshold" - } - } - } - } - ] -} diff --git a/docs/api/policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.json b/docs/api/policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.json deleted file mode 100644 index 26f4c021..00000000 --- a/docs/api/policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Monitoring": { - "derived_from": "tosca.policies.Root", - "description": "a base policy type for all policies that govern monitoring provision", - "version": "1.0.0" - } - }, - { - "onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server": { - "derived_from": "policy.nodes.Root", - "version": "1.0.0", - "properties": { - "buscontroller_feed_publishing_endpoint": { - "type": "string", - "description": "DMAAP Bus Controller feed endpoint" - }, - "datafile.policy": { - "type": "string", - "description": "datafile Policy JSON as string" - } - } - } - } - ] -}
\ No newline at end of file diff --git a/docs/api/policytypes/onap.policies.optimization.AffinityPolicy.json b/docs/api/policytypes/onap.policies.optimization.AffinityPolicy.json deleted file mode 100644 index 62ad6efa..00000000 --- a/docs/api/policytypes/onap.policies.optimization.AffinityPolicy.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Optimization": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that govern optimization" - } - }, - { - "onap.policies.optimization.AffinityPolicy": { - "derived_from": "onap.policies.Optimization", - "version": "1.0.0", - "properties": { - "policyScope": { - "type": "list", - "description": "scope where the policy is applicable", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string" - } - }, - "policyType": { - "type": "list", - "description": "type of a policy", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "zone" - ] - } - ] - } - }, - "identity": { - "type": "string", - "required": true - }, - "applicableResources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "any", - "all" - ] - } - ] - } - }, - "affinityProperties": { - "type": "policy.data.affinityProperties_properties", - "required": true - }, - "resources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string" - } - } - } - } - } - ], - "data_types": [ - { - "policy.data.affinityProperties_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "qualifier": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "same", - "different" - ] - } - ] - } - }, - "category": { - "type": "string", - "required": true - } - } - } - } - ] -} diff --git a/docs/api/policytypes/onap.policies.optimization.DistancePolicy.json b/docs/api/policytypes/onap.policies.optimization.DistancePolicy.json deleted file mode 100644 index 16cd649f..00000000 --- a/docs/api/policytypes/onap.policies.optimization.DistancePolicy.json +++ /dev/null @@ -1,133 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Optimization": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that govern optimization" - } - }, - { - "onap.policies.optimization.DistancePolicy": { - "derived_from": "onap.policies.Optimization", - "version": "1.0.0", - "properties": { - "policyScope": { - "type": "list", - "description": "scope where the policy is applicable", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string" - } - }, - "policyType": { - "type": "list", - "description": "type of a policy", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "distance_to_location" - ] - } - ] - } - }, - "identity": { - "type": "string", - "required": true - }, - "resources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string" - } - }, - "applicableResources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "any", - "all" - ] - } - ] - } - }, - "distanceProperties": { - "type": "policy.data.distanceProperties_properties", - "required": true - } - } - } - } - ], - "data_types": [ - { - "policy.data.distanceProperties_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "locationInfo": { - "type": "string", - "required": true - }, - "distance": { - "type": "policy.data.distance_properties", - "required": true - } - } - }, - "policy.data.distance_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "value": { - "type": "string", - "required": true - }, - "operator": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "<", - "<=", - ">", - ">=", - "=" - ] - } - ] - } - }, - "unit": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "km" - ] - } - ] - } - } - } - } - } - ] -} diff --git a/docs/api/policytypes/onap.policies.optimization.HpaPolicy.json b/docs/api/policytypes/onap.policies.optimization.HpaPolicy.json deleted file mode 100644 index b02e17c4..00000000 --- a/docs/api/policytypes/onap.policies.optimization.HpaPolicy.json +++ /dev/null @@ -1,205 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Optimization": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that govern optimization" - } - }, - { - "onap.policies.optimization.HpaPolicy": { - "derived_from": "onap.policies.Optimization", - "version": "1.0.0", - "properties": { - "policyScope": { - "type": "list", - "description": "scope where the policy is applicable", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string" - } - }, - "policyType": { - "type": "list", - "description": "type of a policy", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "hpa" - ] - } - ] - } - }, - "resources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string" - } - }, - "identity": { - "type": "string", - "required": true - }, - "flavorFeatures": { - "type": "list", - "required": true, - "entry_schema": { - "type": "policy.data.flavorFeatures_properties" - } - } - } - } - } - ], - "data_types": [ - { - "policy.data.flavorFeatures_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "id": { - "type": "string", - "required": true - }, - "type": { - "type": "string", - "required": true - }, - "directives": { - "type": "list", - "required": true, - "entry_schema": { - "type": "policy.data.directives_properties" - } - }, - "flavorProperties": { - "type": "list", - "required": true, - "entry_schema": { - "type": "policy.data.flavorProperties_properties" - } - } - } - } - }, - { - "policy.data.directives_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "type": { - "type": "string" - }, - "attributes": { - "type": "list", - "entry_schema": { - "type": "policy.data.directives_attributes_properties" - } - } - } - } - }, - { - "policy.data.directives_attributes_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "attribute_name": { - "type": "string" - }, - "attribute_value": { - "type": "string" - } - } - } - }, - { - "policy.data.flavorProperties_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "hpa-feature": { - "type": "string", - "required": true - }, - "mandatory": { - "type": "string", - "required": true - }, - "score": { - "type": "string", - "required": false - }, - "architecture": { - "type": "string", - "required": true - }, - "hpa-version": { - "type": "string", - "required": true - }, - "directives": { - "type": "list", - "required": true, - "entry_schema": { - "type": "policy.data.directives_properties" - } - }, - "hpa-feature-attributes": { - "type": "list", - "required": true, - "entry_schema": { - "type": "policy.data.hpa-feature-attributes_properties" - } - } - } - } - }, - { - "policy.data.hpa-feature-attributes_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "hpa-attribute-key": { - "type": "string", - "required": true - }, - "hpa-attribute-value": { - "type": "string", - "required": true - }, - "operator": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "<", - "<=", - ">", - ">=", - "=", - "!=", - "any", - "all", - "subset" - ] - } - ] - } - }, - "unit": { - "type": "string", - "required": false - } - } - } - } - ] -} diff --git a/docs/api/policytypes/onap.policies.optimization.OptimizationPolicy.json b/docs/api/policytypes/onap.policies.optimization.OptimizationPolicy.json deleted file mode 100644 index 153b1e30..00000000 --- a/docs/api/policytypes/onap.policies.optimization.OptimizationPolicy.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Optimization": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that govern optimization" - } - }, - { - "onap.policies.optimization.OptimizationPolicy": { - "derived_from": "onap.policies.Optimization", - "version": "1.0.0", - "properties": { - "policyScope": { - "type": "list", - "description": "scope where the policy is applicable", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string" - } - }, - "policyType": { - "type": "list", - "description": "type of a policy", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "placement_optimization" - ] - } - ] - } - }, - "identity": { - "type": "string", - "required": true - }, - "objective": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "minimize", - "maximize" - ] - } - ] - } - }, - "objectiveParameter": { - "type": "policy.data.objectiveParameter_properties", - "required": true - } - } - } - } - ], - "data_types": [ - { - "policy.data.objectiveParameter_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "parameterAttributes": { - "type": "list", - "required": true, - "entry_schema": { - "type": "policy.data.parameterAttributes_properties" - } - }, - "operator": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "*", - "+", - "-", - "/", - "%" - ] - } - ] - } - } - } - }, - "policy.data.parameterAttributes_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "resources": { - "type": "string", - "required": true - }, - "customerLocationInfo": { - "type": "string", - "required": true - }, - "parameter": { - "type": "string", - "required": true - }, - "weight": { - "type": "string", - "required": true - }, - "operator": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "*", - "+", - "-", - "/", - "%" - ] - } - ] - } - } - } - } - } - ] -} diff --git a/docs/api/policytypes/onap.policies.optimization.PciPolicy.json b/docs/api/policytypes/onap.policies.optimization.PciPolicy.json deleted file mode 100644 index 4adb631d..00000000 --- a/docs/api/policytypes/onap.policies.optimization.PciPolicy.json +++ /dev/null @@ -1,92 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Optimization": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that govern optimization" - } - }, - { - "onap.policies.optimization.PciPolicy": { - "derived_from": "onap.policies.Optimization", - "version": "1.0.0", - "properties": { - "policyScope": { - "type": "list", - "description": "scope where the policy is applicable", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string" - } - }, - "policyType": { - "type": "list", - "description": "type of a policy", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "pciPolicy" - ] - } - ] - } - }, - "identity": { - "type": "string", - "required": true - }, - "resources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string" - } - }, - "pciProperties": { - "type": "list", - "required": false, - "entry_schema": { - "type": "policy.data.pciProperties_properties" - } - } - } - } - } - ], - "data_types": [ - { - "policy.data.pciProperties_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "algoCategory": { - "type": "string", - "required": false - }, - "pciOptmizationAlgoName": { - "type": "string", - "required": false - }, - "pciOptimizationNwConstraint": { - "type": "string", - "required": false - }, - "pciOptimizationPriority": { - "type": "string", - "required": false - }, - "pciOptimizationTimeConstraint": { - "type": "string", - "required": false - } - } - } - } - ] -} diff --git a/docs/api/policytypes/onap.policies.optimization.QueryPolicy.json b/docs/api/policytypes/onap.policies.optimization.QueryPolicy.json deleted file mode 100644 index 98bd3408..00000000 --- a/docs/api/policytypes/onap.policies.optimization.QueryPolicy.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Optimization": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that govern optimization" - } - }, - { - "onap.policies.optimization.QueryPolicy": { - "derived_from": "onap.policies.Optimization", - "version": "1.0.0", - "properties": { - "policyScope": { - "type": "list", - "description": "scope where the policy is applicable", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string" - } - }, - "policyType": { - "type": "list", - "description": "type of a policy", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "request_param_query" - ] - } - ] - } - }, - "identity": { - "type": "string", - "required": true - }, - "queryProperties": { - "type": "list", - "required": true, - "entry_schema": { - "type": "policy.data.queryProperties_properties" - } - } - } - } - } - ], - "data_types": [ - { - "policy.data.queryProperties_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "attribute": { - "type": "string", - "required": true - }, - "value": { - "type": "string", - "required": true - }, - "attribute_location": { - "type": "string", - "required": true - } - } - } - } - ] -} diff --git a/docs/api/policytypes/onap.policies.optimization.SubscriberPolicy.json b/docs/api/policytypes/onap.policies.optimization.SubscriberPolicy.json deleted file mode 100644 index 81e0b0a7..00000000 --- a/docs/api/policytypes/onap.policies.optimization.SubscriberPolicy.json +++ /dev/null @@ -1,83 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Optimization": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that govern optimization" - } - }, - { - "onap.policies.optimization.SubscriberPolicy": { - "derived_from": "onap.policies.Optimization", - "version": "1.0.0", - "properties": { - "policyScope": { - "type": "list", - "description": "scope where the policy is applicable", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string" - } - }, - "policyType": { - "type": "list", - "description": "type of a policy", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "subscriberPolicy" - ] - } - ] - } - }, - "identity": { - "type": "string", - "required": true - }, - "properties": { - "type": "policy.data.properties_properties", - "required": true - } - } - } - } - ], - "data_types": [ - { - "policy.data.properties_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "subscriberName": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string" - } - }, - "subscriberRole": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string" - } - }, - "provStatus": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string" - } - } - } - } - } - ] -} diff --git a/docs/api/policytypes/onap.policies.optimization.Vim_fit.json b/docs/api/policytypes/onap.policies.optimization.Vim_fit.json deleted file mode 100644 index a7894b3f..00000000 --- a/docs/api/policytypes/onap.policies.optimization.Vim_fit.json +++ /dev/null @@ -1,92 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Optimization": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that govern optimization" - } - }, - { - "onap.policies.optimization.Vim_fit": { - "derived_from": "onap.policies.Optimization", - "version": "1.0.0", - "properties": { - "policyScope": { - "type": "list", - "description": "scope where the policy is applicable", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string" - } - }, - "policyType": { - "type": "list", - "description": "type of a policy", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "vim_fit" - ] - } - ] - } - }, - "identity": { - "type": "string", - "required": true - }, - "applicableResources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "any", - "all" - ] - } - ] - } - }, - "resources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string" - } - }, - "capacityProperties": { - "type": "policy.data.capacityProperties_properties", - "required": true - } - } - } - } - ], - "data_types": [ - { - "policy.data.capacityProperties_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "controller": { - "type": "string", - "required": true - }, - "request": { - "type": "string", - "required": true - } - } - } - } - ] -} diff --git a/docs/api/policytypes/onap.policies.optimization.VnfPolicy.json b/docs/api/policytypes/onap.policies.optimization.VnfPolicy.json deleted file mode 100644 index 8c7c1be4..00000000 --- a/docs/api/policytypes/onap.policies.optimization.VnfPolicy.json +++ /dev/null @@ -1,116 +0,0 @@ -{ - "tosca_definitions_version": "tosca_simple_yaml_1_0_0", - "policy_types": [ - { - "onap.policies.Optimization": { - "derived_from": "tosca.policies.Root", - "version": "1.0.0", - "description": "a base policy type for all policies that govern optimization" - } - }, - { - "onap.policies.optimization.VnfPolicy": { - "derived_from": "onap.policies.Optimization", - "version": "1.0.0", - "properties": { - "policyScope": { - "type": "list", - "description": "scope where the policy is applicable", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string" - } - }, - "policyType": { - "type": "list", - "description": "type of a policy", - "required": true, - "matchable": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "vnfPolicy" - ] - } - ] - } - }, - "identity": { - "type": "string", - "required": true - }, - "resources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string" - } - }, - "applicableResources": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "any", - "all" - ] - } - ] - } - }, - "vnfProperties": { - "type": "list", - "required": true, - "entry_schema": { - "type": "policy.data.vnfProperties_properties" - } - } - } - } - } - ], - "data_types": [ - { - "policy.data.vnfProperties_properties": { - "derived_from": "tosca.nodes.Root", - "properties": { - "inventoryProvider": { - "type": "string", - "required": true - }, - "serviceType": { - "type": "string", - "required": true - }, - "inventoryType": { - "type": "list", - "required": true, - "entry_schema": { - "type": "string", - "constraints": [ - { - "valid_values": [ - "serviceInstanceId", - "vnfName", - "cloudRegionId", - "vimId" - ] - } - ] - } - }, - "customerId": { - "type": "string", - "required": true - } - } - } - } - ] -} |