summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat.rst
diff options
context:
space:
mode:
authorBozawglanian, Hagop (hb755d) <hb755d@att.com>2018-07-30 20:26:07 +0000
committerBozawglanian, Hagop (hb755d) <hb755d@att.com>2018-07-30 20:27:19 +0000
commitd907908404fe0d7522544ad2d54989095b145ed8 (patch)
tree3914456206a4119531d2e5972b57f8cd9ad45db3 /docs/Chapter5/Heat.rst
parent2e816cb9b91778d476dbd6e7f59040c50168df0a (diff)
VNFRQTS - Fixing Doc8 errors
Reviewing all files to make sure no doc8 errors are present. Change-Id: Ic073a7fb4096269d6b1781cecfdb2c4c8aa7b552 Issue-ID: VNFRQTS-281 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
Diffstat (limited to 'docs/Chapter5/Heat.rst')
-rw-r--r--docs/Chapter5/Heat.rst84
1 files changed, 44 insertions, 40 deletions
diff --git a/docs/Chapter5/Heat.rst b/docs/Chapter5/Heat.rst
index 646aa2b..fe8532e 100644
--- a/docs/Chapter5/Heat.rst
+++ b/docs/Chapter5/Heat.rst
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. Licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
@@ -1545,10 +1545,12 @@ Contrail Heat Resources.
:keyword: MUST
If a VNF's port is connected to an internal network and the
- port is created in an Incremental Module and the internal network is created
- in the Base Module then the UUID of the internal network **MUST** be exposed
+ port is created in an Incremental Module and the internal
+ network is created in the Base Module then the UUID of the
+ internal network **MUST** be exposed
as a parameter in the 'outputs:' section of the Base Module and the port
resource **MUST** use a 'get_param' to obtain the network UUID.
+
ONAP does not programmatically enforce a naming convention for
parameters for internal network. However, a naming convention is
provided that must be followed.
@@ -3879,35 +3881,37 @@ YAML File
.. code-block:: yaml
- parameters:
- vf_module_index:
- type: number
- description: Unique index for this VNF Module instance
- oam_vm_name_0:
- type: string
- description: VM Name for lb VM 0
- int_ctrl_net_id:
- type: string
- description: Neutron UUID for the internal control network
- oam_vm_int_ctrl_ips:
- type: comma_delimited_list
- description: Fixed IP assignments for oam VMs on the internal control
- network
- resources:
- oam_vm_server_0:
- type: OS::Nova::Server
- properties:
- name: { get_param: oam_vm_name_0 }
- networks:
- - port: { get_resource: oam_vm_0_int_ctrl_port_0 }
- . . .
- metadata:
- vf_module_index: { get_param: vf_module_index }
- oam_vm_0_int_ctrl_port_0:
- type: OS::Neutron::Port
- properties:
- network: { get_param: int_ctrl_net_id }
- fixed_ips: [ { "ip_address": {get_param: [ oam_vm_int_ctrl_ips, { get_param, vf_module_index]}}}]
+ parameters:
+ vf_module_index:
+ type: number
+ description: Unique index for this VNF Module instance
+ oam_vm_name_0:
+ type: string
+ description: VM Name for lb VM 0
+ int_ctrl_net_id:
+ type: string
+ description: Neutron UUID for the internal control network
+ oam_vm_int_ctrl_ips:
+ type: comma_delimited_list
+ description: Fixed IP assignments for oam VMs on the internal control
+ network
+ resources:
+ oam_vm_server_0:
+ type: OS::Nova::Server
+ properties:
+ name: { get_param: oam_vm_name_0 }
+ networks:
+ port: { get_resource: oam_vm_0_int_ctrl_port_0 }
+
+ . . .
+
+ metadata:
+ vf_module_index: { get_param: vf_module_index }
+ oam_vm_0_int_ctrl_port_0:
+ type: OS::Neutron::Port
+ properties:
+ network: { get_param: int_ctrl_net_id }
+ fixed_ips: [ { "ip_address": {get_param: [ oam_vm_int_ctrl_ips, { get_param, vf_module_index}]}}]
workload\_context
++++++++++++++++++
@@ -4854,14 +4858,14 @@ database.
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
- fixed_ips: [ { "ip_address": {get_param: db_oam_ip_0}}, { "ip_address": {get_param: db_oam_v6_ip_0 ]}}]
+ fixed_ips: [ { "ip_address": {get_param: db_oam_ip_0}}, { "ip_address": {get_param: db_oam_v6_ip_0 }}]
db_1_oam_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips:
- - "ip_address": {get_param: db_oam_ip_1}}]
- - "ip_address": {get_param: db_oam_v6_ip_1}}]
+ - "ip_address": {get_param: db_oam_ip_1}
+ - "ip_address": {get_param: db_oam_v6_ip_1}
*Example: comma_delimited_list parameters for IPv4 and IPv6 Address
@@ -4933,14 +4937,14 @@ The {vm-type} has been defined as db for database.
properties:
network: { get_param: int_oam_int_net_id }
fixed_ips: [ { "ip_address": {get_param: db_oam_int_ip_0}}, {
- "ip_address": {get_param: db_oam_int_v6_ip_0 ]}}]
+ "ip_address": {get_param: db_oam_int_v6_ip_0 }}]
db_1_int_ctrl_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: int_oam_int_net_id }
fixed_ips:
- - "ip_address": {get_param: db_oam_int_ip_1}}]
- - "ip_address": {get_param: db_oam_int_v6_ip_1}}]
+ - "ip_address": {get_param: db_oam_int_ip_1}
+ - "ip_address": {get_param: db_oam_int_v6_ip_1}
Property: fixed\_ips, Map Property: subnet\_id
@@ -7560,7 +7564,7 @@ OS::Heat::ResourceGroup:
resource_def:
type: my_nested_vm_template.yaml
properties:
- name: {get_param: [vm_name_list, %index%]}
+ name: {get_param: [vm_name_list, "%index%"]}
Although this appears to use the nth entry of the vm_name_list list for
the nth element of the OS::Heat::ResourceGroup, it will in fact result
@@ -7579,7 +7583,7 @@ ResourceGroup:
type: my_nested_vm_template.yaml
properties:
names: {get_param: vm_name_list}
- index: %index%
+ index: "%index%"
You can then reference within the nested template as: