diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/clamp/acm/acm-user-guide.rst | 6 | ||||
| -rwxr-xr-x | docs/clamp/acm/design-impl/clamp-runtime-acm.rst | 28 |
2 files changed, 32 insertions, 2 deletions
diff --git a/docs/clamp/acm/acm-user-guide.rst b/docs/clamp/acm/acm-user-guide.rst index 6e247f7c..e14492e9 100755 --- a/docs/clamp/acm/acm-user-guide.rst +++ b/docs/clamp/acm/acm-user-guide.rst @@ -75,7 +75,8 @@ org.onap.policy.clamp.acm.AutomationCompositionElement: the ACM elements. Here we are defining various timeout properties and startPhase parameter that are common for all the AC elements. - Note: This node type value should not be changed as the ACM framework identifies the AC elements based on this type. + Note: This node type value can be customised if the user wants to change the default name. Please refer the + "Configure custom namings for TOSCA node types" section of the Automation Composition Runtime design and implementation. org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement: This node type is used to define AC elements that are associated with kubernetes operations. It is further derived from the @@ -92,7 +93,8 @@ org.onap.policy.clamp.acm.AutomationComposition: Primitive node type for defining Automation composition definitions that comprises one or more AC elements in it. The AC definition of this type will be created under the Node templates. - Note: This node type value should not be changed as the ACM framework identifies the AC definitions based on this type. + Note: This node type value can be customised if the user wants to change the default name. Please refer the + "Configure custom namings for TOSCA node types" section of the Automation Composition Runtime design and implementation. .. literalinclude:: files/acm-nodetypes.yaml :language: yaml diff --git a/docs/clamp/acm/design-impl/clamp-runtime-acm.rst b/docs/clamp/acm/design-impl/clamp-runtime-acm.rst index 215ddc59..96dbc212 100755 --- a/docs/clamp/acm/design-impl/clamp-runtime-acm.rst +++ b/docs/clamp/acm/design-impl/clamp-runtime-acm.rst @@ -210,6 +210,34 @@ Example of DEPLOY order with Http_PMSHMicroserviceAutomationCompositionElement w In that scenario the message AUTOMATION_COMPOSITION_DEPLOY has been sent two times. +Configure custom namings for TOSCA node types ++++++++++++++++++++++++++++++++++++++++++++++ + +The node type of the AC element and the Automation composition can be customised as per the user requirement. +These customised names can be used in the TOSCA node type definitions of AC element and composition. All the +AC element and composition definitions (node templates) should be derived from the corresponding node types. +The following parameters are provided in the config file of runtime-acm for customisation: + +.. code-block:: YAML + +runtime: + acmParameters: + toscaElementName: customElementType + toscaCompositionName: customCompositionType + +If there are no values provided for customisation, the default node types "org.onap.policy.clamp.acm.AutomationCompositionElement" +and "org.onap.policy.clamp.acm.AutomationComposition" are used for the AC element and composition by the runtime-acm. +In this case, the element and composition definition has to be derived from the same in the TOSCA. For overriding the names in the +onap helm chart, the following properties can be updated in the values.yaml. + +.. code-block:: YAML + +customNaming: + toscaElementName: customElementName + toscaCompositionName: customCompositionName + + + Design of managing messages *************************** |