gerrit.onap Code Review - vnfrqts/requirements.git/blob

   1 .. Licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   4
   5 Suggested Naming Convention for Common Parameters
   6 ----------------------------------------------------------------------------------------------------------
   7
   8 Many VNFs use the parameters in the table below are used in user_data.
   9 The table below provides a suggested naming convention for these common
  10 parameters.
  11
  12 Netmask
  13 ^^^^^^^^^^^^^^^^^^
  14
  15 .. csv-table:: **Table 8: Suggested Naming Convention for Common Parameters:  Netmask**
  16    :header: Parameter Name,Parameter Type,Notes
  17    :align: center
  18    :widths: auto
  19
  20    {network-role}_subnet_<index>_netmask, string,
  21    int_<network-role>_subnet_<index>_netmask, string,
  22    {network-role}_v6_subnet_<index>_netmask , string,
  23    int_{network-role}_v6_subnet_<index>_netmask, string,
  24
  25 CIDR
  26 ^^^^^^^^^^^^^^^^^^
  27
  28 .. csv-table:: **Table 9: Suggested Naming Convention for Common Parameters:  CIDR**
  29    :header: Parameter Name,Parameter Type,Notes
  30    :align: center
  31    :widths: auto
  32
  33    <network-role>_subnet_<index>_cidr, string,
  34    int_<network-role>_subnet_<index>_cidr, string,
  35    <network-role>_v6_subnet_<index>_cidr, string,
  36    int_<network-role>_v6_subnet_<index>_cidr, string,
  37
  38 Default Gateway
  39 ^^^^^^^^^^^^^^^^^^
  40
  41 .. csv-table:: **Table 10: Suggested Naming Convention for Common Parameters:  Default Gateway**
  42    :header: Parameter Name,Parameter Type,Notes
  43    :align: center
  44    :widths: auto
  45
  46    {network-role}_subnet_<index>_default_gateway, string,
  47    {network-role}_v6_subnet_<index>_default_gateway, string,
  48
  49 DCAE Collector IP Address
  50 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  51
  52 .. csv-table:: **Table 11: Suggested Naming Convention for Common Parameters:  DCAE Collector Address**
  53    :header: Parameter Name,Parameter Type,Notes
  54    :align: center
  55    :widths: auto
  56
  57    dcae_collector_ip_<index>, string,
  58    dcae_collector_v6_ip_<index>, string,
  59
  60 NTP Server IP Address
  61 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  62
  63 .. csv-table:: **Table 12: Suggested Naming Convention for Common Parameters:  NTP Server IP Address**
  64    :header: Parameter Name,Parameter Type,Notes
  65    :align: center
  66    :widths: auto
  67
  68    ntp_ip_<index>, string,
  69    ntp_v6_ip_<index>, string,
  70
  71 DNS
  72 ^^^^^^^^^^^^^^^^^^
  73
  74 .. csv-table:: **Table 13: Suggested Naming Convention for Common Parameters:  DCAE Collector Address**
  75    :header: Parameter Name,Parameter Type,Notes
  76    :align: center
  77    :widths: auto
  78
  79    dns_{network-role}_ip_<index>, string,
  80    dns_{network-role}_v6_ip_<index>, string,
  81
  82 Security Group
  83 ^^^^^^^^^^^^^^^^^^
  84
  85 .. csv-table:: **Table 14: Suggested Naming Convention for Common Parameters:  Security Group**
  86    :header: Parameter Name,Parameter Type,Notes
  87    :align: center
  88    :widths: auto
  89
  90    {vm-type}_security_group, string, Security Group applicable to one {vm-type} and more than one network (internal and/or external)
  91    {network-role}_security_group, string, Security Group applicable to more than one {vm-type} and one external network
  92    int_{network-role}_security_group, string, Security Group applicable to more than one {vm-type} and one internal network
  93    {vm-type}_{network-role}_security_group, string, Security Group applicable to one {vm-type} and one external network
  94    {vm-type}_int_{network-role}_security_group, string, Security Group applicable to one {vm-type} and one internal network
  95    shared_security_group, string, Security Group applicable to more than one {vm-type} and more than one network (internal and/or external)