summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst
diff options
context:
space:
mode:
authorBozawglanian, Hagop (hb755d) <hb755d@att.com>2018-09-04 21:44:28 +0000
committerBozawglanian, Hagop (hb755d) <hb755d@att.com>2018-09-04 21:44:28 +0000
commitc4e85b64d93f7bb4cdcf13cbc65f2256e5bb7a33 (patch)
treebe3abe0eb6ea4407da81dcb3917dbf1d8f35e77a /docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst
parent7b7ff003d1133f68bdd17812112e5a5abc47a7f6 (diff)
VNFRQTS - Breaking up Chapter 5 - Heat
Breaking up the Heat section to make it more granular. Issue-ID: VNFRQTS-275 Change-Id: I020469d7aea199cd71c4d7c67664ad4dbc4071c9 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
Diffstat (limited to 'docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst')
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst95
1 files changed, 95 insertions, 0 deletions
diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst
new file mode 100644
index 0000000..416b1f0
--- /dev/null
+++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst
@@ -0,0 +1,95 @@
+.. 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.
+
+Suggested Naming Convention for Common Parameters
+----------------------------------------------------------------------------------------------------------
+
+Many VNFs use the parameters in the table below are used in user_data.
+The table below provides a suggested naming convention for these common
+parameters.
+
+Netmask
+^^^^^^^^^^^^^^^^^^
+
+.. csv-table:: **Table 8: Suggested Naming Convention for Common Parameters: Netmask**
+ :header: Parameter Name,Parameter Type,Notes
+ :align: center
+ :widths: auto
+
+ {network-role}_subnet_<index>_netmask, string,
+ int_<network-role>_subnet_<index>_netmask, string,
+ {network-role}_v6_subnet_<index>_netmask , string,
+ int_{network-role}_v6_subnet_<index>_netmask, string,
+
+CIDR
+^^^^^^^^^^^^^^^^^^
+
+.. csv-table:: **Table 9: Suggested Naming Convention for Common Parameters: CIDR**
+ :header: Parameter Name,Parameter Type,Notes
+ :align: center
+ :widths: auto
+
+ <network-role>_subnet_<index>_cidr, string,
+ int_<network-role>_subnet_<index>_cidr, string,
+ <network-role>_v6_subnet_<index>_cidr, string,
+ int_<network-role>_v6_subnet_<index>_cidr, string,
+
+Default Gateway
+^^^^^^^^^^^^^^^^^^
+
+.. csv-table:: **Table 10: Suggested Naming Convention for Common Parameters: Default Gateway**
+ :header: Parameter Name,Parameter Type,Notes
+ :align: center
+ :widths: auto
+
+ {network-role}_subnet_<index>_default_gateway, string,
+ {network-role}_v6_subnet_<index>_default_gateway, string,
+
+DCAE Collector IP Address
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. csv-table:: **Table 11: Suggested Naming Convention for Common Parameters: DCAE Collector Address**
+ :header: Parameter Name,Parameter Type,Notes
+ :align: center
+ :widths: auto
+
+ dcae_collector_ip_<index>, string,
+ dcae_collector_v6_ip_<index>, string,
+
+NTP Server IP Address
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. csv-table:: **Table 12: Suggested Naming Convention for Common Parameters: NTP Server IP Address**
+ :header: Parameter Name,Parameter Type,Notes
+ :align: center
+ :widths: auto
+
+ ntp_ip_<index>, string,
+ ntp_v6_ip_<index>, string,
+
+DNS
+^^^^^^^^^^^^^^^^^^
+
+.. csv-table:: **Table 13: Suggested Naming Convention for Common Parameters: DCAE Collector Address**
+ :header: Parameter Name,Parameter Type,Notes
+ :align: center
+ :widths: auto
+
+ dns_{network-role}_ip_<index>, string,
+ dns_{network-role}_v6_ip_<index>, string,
+
+Security Group
+^^^^^^^^^^^^^^^^^^
+
+.. csv-table:: **Table 14: Suggested Naming Convention for Common Parameters: Security Group**
+ :header: Parameter Name,Parameter Type,Notes
+ :align: center
+ :widths: auto
+
+ {vm-type}_security_group, string, Security Group applicable to one {vm-type} and more than one network (internal and/or external)
+ {network-role}_security_group, string, Security Group applicable to more than one {vm-type} and one external network
+ int_{network-role}_security_group, string, Security Group applicable to more than one {vm-type} and one internal network
+ {vm-type}_{network-role}_security_group, string, Security Group applicable to one {vm-type} and one external network
+ {vm-type}_int_{network-role}_security_group, string, Security Group applicable to one {vm-type} and one internal network
+ shared_security_group, string, Security Group applicable to more than one {vm-type} and more than one network (internal and/or external)