summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrameshiyer27 <ramesh.murugan.iyer@est.tech>2023-10-10 10:24:30 +0100
committerrameshiyer27 <ramesh.murugan.iyer@est.tech>2023-10-10 10:24:30 +0100
commit4de6ac9faa4043f8a2d04c1b9f2f7f94606c6192 (patch)
tree4e86de506ede9675cad0198c340fd58c62369f45
parentb4f03f4d97b1181e4cd8d1feae0c5dd40ba0d17f (diff)
Fix yaml code block in documentation
Issue-ID: POLICY-4827 Signed-off-by: rameshiyer27 <ramesh.murugan.iyer@est.tech> Change-Id: I834b2cf5680e813c0551a2622b0b80142091e32c
-rwxr-xr-xdocs/clamp/acm/acm-user-guide.rst10
-rwxr-xr-xdocs/clamp/acm/design-impl/clamp-runtime-acm.rst17
2 files changed, 14 insertions, 13 deletions
diff --git a/docs/clamp/acm/acm-user-guide.rst b/docs/clamp/acm/acm-user-guide.rst
index e14492e9..588b3b53 100755
--- a/docs/clamp/acm/acm-user-guide.rst
+++ b/docs/clamp/acm/acm-user-guide.rst
@@ -75,8 +75,9 @@ 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 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.
+ 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
@@ -93,8 +94,9 @@ 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 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.
+ 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 96dbc212..5b88edba 100755
--- a/docs/clamp/acm/design-impl/clamp-runtime-acm.rst
+++ b/docs/clamp/acm/design-impl/clamp-runtime-acm.rst
@@ -211,7 +211,7 @@ 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
@@ -220,10 +220,10 @@ The following parameters are provided in the config file of runtime-acm for cust
.. code-block:: YAML
-runtime:
- acmParameters:
- toscaElementName: customElementType
- toscaCompositionName: customCompositionType
+ 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.
@@ -232,10 +232,9 @@ onap helm chart, the following properties can be updated in the values.yaml.
.. code-block:: YAML
-customNaming:
- toscaElementName: customElementName
- toscaCompositionName: customCompositionName
-
+ customNaming:
+ toscaElementName: customElementName
+ toscaCompositionName: customCompositionName
Design of managing messages