Update CL TOSCA definitions, Add Guidance UC

This patch makes some minor updates to the TOSCA definitions, mainly the
introduction of common parameters.

It also introduces the first draft of a "Gentle Guidance" control loop
that can be used for testing, verification, documenting and explaining
the TOSCA control loop framework.

Issue-ID: POLICY-3341
Change-Id: Ie2d5379bd362f088d7c500402f83745cc7e6aca3
Signed-off-by: liamfallon <liam.fallon@est.tech>

3 files changed, 176 insertions, 9 deletions

diff --git a/common/src/test/resources/examples/controlloop/PMSubscriptionHandling.yaml b/common/src/test/resources/examples/controlloop/PMSubscriptionHandling.yaml
index f9f97420a..5c6883bee 100644
--- a/common/src/test/resources/examples/controlloop/PMSubscriptionHandling.yaml
+++ b/common/src/test/resources/examples/controlloop/PMSubscriptionHandling.yaml
@@ -309,24 +309,24 @@ node_types:
     properties:
       provider:
         type: string
-        requred: false
+        required: false
   org.onap.policy.clamp.controlloop.ControlLoopElement:
     version: 1.0.1
     derived_from: tosca.nodetypes.Root
     properties:
       provider:
         type: string
-        requred: false
+        required: false
       participant_id:
         type: onap.datatypes.ToscaConceptIdentifier
-        requred: true
+        required: true
   org.onap.policy.clamp.controlloop.ControlLoop:
     version: 1.0.1
     derived_from: tosca.nodetypes.Root
     properties:
       provider:
         type: string
-        requred: false
+        required: false
       elements:
         type: list
         required: true
@@ -338,10 +338,10 @@ node_types:
     properties:
       dcae_blueprint_id:
         type: onap.datatypes.ToscaConceptIdentifier
-        requred: false
+        required: false
       dcae_blueprint:
         type: onap.dcae.cloudify_blueprint
-        requred: false
+        required: false
       consul_info:
         type: list
         required: false
@@ -353,17 +353,17 @@ node_types:
     properties:
       policy_type_id:
         type: onap.datatypes.ToscaConceptIdentifier
-        requred: true
+        required: true
       policy_id:
         type: onap.datatypes.ToscaConceptIdentifier
-        requred: false
+        required: false
   org.onap.policy.clamp.controlloop.CDSControlLoopElement:
     version: 1.0.1
     derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement
     properties:
       cds_blueprint_id:
         type: onap.datatypes.ToscaConceptIdentifier
-        requred: true
+        required: true
 topology_template:
   inputs:
     pmsh_monitoring_policy:
diff --git a/common/src/test/resources/gentleguidance/GentleGuidanceDefaultPropeties.yaml b/common/src/test/resources/gentleguidance/GentleGuidanceDefaultPropeties.yaml
new file mode 100644
index 000000000..d634a1fa5
--- /dev/null
+++ b/common/src/test/resources/gentleguidance/GentleGuidanceDefaultPropeties.yaml
@@ -0,0 +1,115 @@
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Nordix Foundation.
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+tosca_definitions_version: tosca_simple_yaml_1_3
+topology_template:
+  node_templates:
+    org.onap.domain.gentleguidance.KubernetesControlLoopElementDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.KubernetesControlLoopElement
+      type_version: 1.0.1
+      description: Control loop element for the Gentle Guidance Kubernetes Microservice
+      properties:
+        provider: Ericsson
+        participantType: org.onap.policy.controlloop.participant.Kubernetes:1.0.0
+        startPhase: 2
+        uninitializedToPassiveTimeout: 180
+        chart:
+            chartId: GentleGuidance:1.0.0
+            releaseName: Istanbul
+            namespace: org.onap.policy.controlloop.gentleguidance
+    org.onap.domain.gentleguidance.RestControlLoopElementDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.HttpControlLoopElement
+      type_version: 1.0.1
+      description: Control loop element for the Gentle Guidance Microservice REST configuration
+      properties:
+        provider: Ericsson
+        participantType: org.onap.policy.controlloop.participant.Http:1.0.0
+        startPhase: 1
+        baseUrl: https://10.10.10.10:12345/gentleguidancemicroservice
+        httpHeaders:
+          "Content-Type": "application/json"
+          "Accept": "application/json"
+        configurationEntities:
+          org.onap.policy.controlloop.gentleguidance.setGentleGuidanceConfig:1.0.0:
+            configurationEntityId: org.onap.policy.controlloop.gentleguidance.setGentleGuidanceConfig:1.0.0
+            restSequence:
+            - restRequestId: org.onap.policy.controlloop.gentleguidance.setGentleGuidanceConfig.CreateGentle:1.0.0
+              httpMethd: POST
+              path: "gentle/create"
+              body:
+                gentleLevel: veryGentle
+                gentleType: softAndFurry
+              expectedResponse: 200
+            - restRequestId: org.onap.policy.controlloop.gentleguidance.setGentleGuidanceConfig.CreateGuidance:1.0.0
+              httpMethd: POST
+              path: "guidance/create"
+              body:
+                guidanceLevel: high
+                guidanceType: subtle
+              expectedResponse: 200
+          org.onap.policy.controlloop.gentleguidance.updateGentleGuidanceConfig:1.0.0:
+            configurationEntityId: org.onap.policy.controlloop.gentleguidance.updateGentleGuidanceConfig:1.0.0
+            restSequence:
+            - restRequestId: org.onap.policy.controlloop.gentleguidance.updateGentleGuidanceConfig.CreateGentle:1.0.0
+              httpMethd: PUT
+              path: "gentle/update]"
+              body:
+                gentleLevel: robust
+                gentleType: hardAndGritty
+              expectedResponse: 200
+            - restRequestId: org.onap.policy.controlloop.gentleguidance.updateGentleGuidanceConfig.CreateGuidance:1.0.0
+              httpMethd: PUT
+              path: "guidance/update"
+              body:
+                guidanceLevel: low
+                guidanceType: terse
+              expectedResponse: 200
+    org.onap.domain.gentleguidance.PolicyControlLoopElementDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.PolicyControlLoopElement
+      type_version: 1.0.1
+      description: Control loop element for the Gentle Guidance Operational Policy
+      properties:
+        provider: Ericsson
+        participantType: org.onap.policy.controlloop.participant.Policy:1.0.0
+        startPhase: 0
+        policyType: onap.policies.controlloop.operational.common.Apex:1.0.0
+        policyId: org.onap.domain.gentleguidance.policy.GentleGuidanceAssertive:1.0.0
+    org.onap.domain.gentleguidance.CdsControlLoopElementDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.CDSControlLoopElement
+      type_version: 1.0.1
+      description: Control loop element for the Gentle Guidance CDS blueprint
+      properties:
+        provider: Ericsson
+        participantType: org.onap.policy.controlloop.participant.Cds:1.0.0
+        startPhase: 0
+        cdsBlueprint: "Placeholder for the CDS blueprint"
+    org.onap.domain.gentleguidance.ControlLoopDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.ControlLoop
+      type_version: 1.0.1
+      description: Control loop definition for the Gentle Guidance domain
+      properties:
+        provider: Ericsson
+        elements:
+        - org.onap.domain.gentleguidance.KubernetesControlLoopElementDefinition:1.0.0
+        - org.onap.domain.gentleguidance.RestControlLoopElementDefinition:1.0.0
+        - org.onap.domain.gentleguidance.PolicyControlLoopElementDefinition:1.0.0
+        - org.onap.domain.gentleguidance.CdsControlLoopElementDefinition:1.0.0
diff --git a/common/src/test/resources/gentleguidance/GentleGuidanceNoPropeties.yaml b/common/src/test/resources/gentleguidance/GentleGuidanceNoPropeties.yaml
new file mode 100644
index 000000000..d0222617d
--- /dev/null
+++ b/common/src/test/resources/gentleguidance/GentleGuidanceNoPropeties.yaml
@@ -0,0 +1,52 @@
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Nordix Foundation.
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+tosca_definitions_version: tosca_simple_yaml_1_3
+topology_template:
+  node_templates:
+    org.onap.domain.gentleguidance.KubernetesControlLoopElementDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.KubernetesControlLoopElement
+      type_version: 1.0.1
+      description: Control loop element for the Gentle Guidance Kubernetes Microservice
+    org.onap.domain.gentleguidance.RestControlLoopElementDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.HttpControlLoopElement
+      type_version: 1.0.1
+      description: Control loop element for the Gentle Guidance Microservice REST configuration
+    org.onap.domain.gentleguidance.PolicyControlLoopElementDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.PolicyControlLoopElement
+      type_version: 1.0.1
+      description: Control loop element for the Gentle Guidance Operational Policy
+    org.onap.domain.gentleguidance.CdsControlLoopElementDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.CDSControlLoopElement
+      type_version: 1.0.1
+      description: Control loop element for the Gentle Guidance CDS blueprint
+    org.onap.domain.gentleguidance.ControlLoopDefinition:
+      version: 1.0.0
+      type: org.onap.policy.clamp.controlloop.ControlLoop
+      type_version: 1.0.1
+      description: Control loop definition for the Gentle Guidance domain
+      properties:
+        provider: Ericsson
+        elements:
+        - org.onap.domain.gentleguidance.KubernetesControlLoopElementDefinition:1.0.0
+        - org.onap.domain.gentleguidance.RestControlLoopElementDefinition:1.0.0
+        - org.onap.domain.gentleguidance.PolicyControlLoopElementDefinition:1.0.0
+        - org.onap.domain.gentleguidance.CdsControlLoopElementDefinition:1.0.0