# Template for instantiating
#  - 1xHA SSC instance
#  - MxHA RTP MSC instances
#
# This Heat template commissions, partners and configures the Perimeta
# instances with minimal configuration defined by the following templates.
#  - ssc_a_template.json
#  - msc_a_template.json
# This/these can be modified as required to obtain the required Perimeta
# configuration.
#
# This template puts the Perimeta configuration in place using userdata
# injected via OpenStack's ConfigDrive mechanism.
#
# This template sets up anti-affinity using server group anti-affinity and
# optionally availability zone anti-affinity.
#
# This template will work with any version of Perimeta software from 3.9.20.
#
# Pre-requisites are:
# - existing networks as follows
#     - network for management traffic
#     - network for HA traffic
#     - network for core/trusted service traffic
#     - network for access/untrusted service traffic
# - pre-loaded Perimeta image
# - suitable flavor to use for Perimeta SSC
# - suitable flavor to use for Perimeta RTP MSCs
# - suitable flavor to use for Perimeta MSRP MSCs
# - suitable keypair to use for Perimeta
#
# Virtual IP address and fixed IP addresses to use for the Perimeta instances
# must be provided as parameters.
#
# Template requires Juno or above and has been tested on Kilo.  Note that in
# some deployments, Heat template validation will fail but actually creating
# a stack using the template will succeed.   This is due to problems with
# Heat validating nested templates.
#

parameters:
  #
  # General VNF parameters
  #

  # ID of VNF
  vnf_id: ibcx0002

  # Unique ID for this VF Module instance
  vf_module_id: ibcx

  # Availability zone for A instances.
  availability_zone_0: DPA3_D2_AZ1

  # Availability zone for B instances.
  availability_zone_1: DPA3_D2_AZ2

  # Keypair to use for accessing these Perimeta instances
  perimeta_keypair: perimeta_key

  # NTP server IPv4 addresses, separated by commas.  These must be accessible from the management network
  ntp_server_ip_addrs: 132.201.84.13,155.179.58.11,155.179.59.249,155.179.82.25

  # UUID of server group to set anti-affinity policy for Perimeta instance.
  # Only used when doing healing.
  #
  # Even though server group is _NOT_ used when a new system is created,
  # setting it to '', whilst valid, has caused instantiation to fail on some
  # systems at AT&T. Therefore, we set it to a string even though it will not
  # be used.
  perimeta_param_server_group: 'THBAPSA'

  #
  # Management network parameters
  #

  # Management network ID
  mgmt_net_id: a0db940a-c47c-4d05-acd0-0dcd2b46e87a

  # Management network prefix length
  mgmt_net_plen: 26

  # Default gateway for management network
  mgmt_net_default_gateway: 10.147.188.131

  # Management network security groups
  mgmt_net_sec_groups: 67f4f424-d852-4241-8c70-74b8ae210483

  #
  # Internal high availability network parameters
  #

  # Internal HA network ID
  int_ha_net_id: eec17d6a-fbf3-434b-b70f-8229d24d3326

  # Intermal HA network prefix length.
  int_ha_net_plen: 24

  # Security groups associated with internal HA network
  int_ha_net_sec_groups: 67f4f424-d852-4241-8c70-74b8ae210483

  #
  # Trusted/core network parameters
  #

  # Network ID of trusted/core network.
  trusted_net_id: dffe19e0-9dc0-4c6e-886d-0554f6d94b6b

  # Security groups associated with trusted/core network
  trusted_net_sec_groups: 67f4f424-d852-4241-8c70-74b8ae210483

  #
  # Untrusted/access network parameters
  #

  # Network ID of untrusted/access network.
  untrusted_net_id: b4f1a645-5db5-4cc6-91f7-85e722ba6616

  # Security groups associated with untrusted/access network
  untrusted_net_sec_groups: 67f4f424-d852-4241-8c70-74b8ae210483

  # Number of VLANs to connect to on the untrusted/access network
  untrusted_num_vlans: 10

  # List of VLAN IDs to use on the untrusted/access network.  There must
  # be at least untrusted_num_vlans entries in this list.
  untrusted_vlan_ids: ["10", "11", "3456", "234", "123"]

  # List of Contrail VLAN networks to use on the untrusted/access network.   The order and number of these must match the VLAN IDs list
  untrusted_vlan_networks: [95c74fbb-0650-4ac2-bd4f-7b4fb50b4b5d, aa1a5096-61fd-421b-a74b-0b4a72c47856,
                                     ced72584-9c09-4d67-9b9f-8faf4c081c45, 6311c9db-c4ba-41f5-85e5-4a3cc85d7f55,
                                     79391429-9c52-44f5-b9a9-4547fec0e9d4]

  #
  # Unused network parameters
  #

  # Unused port network ID - this is used for connecting the unused 4th SSC service interface.
  unused_port_net_id: cfcbf116-4e90-482b-91e5-f4b990115f70

  #
  # SSC parameters
  #

  # Flavor to use for creating SSC VM instance
  ssc_flavor_name: 41e7508e-bf2a-406e-9563-8219c3aa6c02

  # Glance image to use for launching SSC Perimeta instances.
  ssc_image_name: 3aedaeb5-fbb4-4802-9e1f-a421087d2adb

  # Name of VM A of SSC
  ssc_a_name_0: ibcx0002vm001ssc001

  # Name of VM B of SSC
  ssc_b_name_0: ibcx0002vm002ssc001

  # System name of SSC
  ssc_system_name_0: ibcx0002vm001ssc001pair

  #
  # SSC IP addresses on management network
  #

  # Management virtual IPv4 address to use for SSC.
  ssc_mgmt_vip_0: 10.147.188.133

  # Management fixed IPv4 address to use for SSC A.
  ssc_a_mgmt_ip_0: 10.147.188.132

  # Management fixed IPv4 address to use for SSC B.
  ssc_b_mgmt_ip_0: 10.147.188.136

  #
  # SSC IP addresses on internal HA network
  #

  # HA fixed IPv4 address to use for SSC A.
  ssc_a_int_ha_ip_0: 10.0.0.4

  # HA fixed IPv4 address to use for SSC B.
  ssc_b_int_ha_ip_0: 10.0.0.5

  #
  # SSC IP addresses on trusted/core network
  #

  # Virtual IPv4 address on trusted/core network for SSC.
  ssc_trusted_vip_0: 10.1.1.5

  # Fixed IPv4 address on trusted/core network for SSC A.
  ssc_a_trusted_ip_0: 10.1.1.4

  # Fixed IPv4 address on trusted/core network for SSC B.
  ssc_b_trusted_ip_0: 10.1.1.6

  #
  # SSC IP addresses on untrusted/access network
  #

  # Virtual IPv4 address on untrusted/access network for SSC.
  ssc_untrusted_vip_0: 127.0.0.1

  # Virtual IPv6 address on untrusted/access network for SSC.
  ssc_untrusted_v6_vip_0: 2001:1890:1001:2B38::2D:2

  # Fixed IPv4 address on untrusted/access network for SSC A.
  ssc_a_untrusted_ip_0: 127.0.0.1

  # Fixed IPv6 address on untrusted/access network for SSC A.
  ssc_a_untrusted_v6_ip_0: 2001:1890:1001:2B38::2D:1

  # Fixed IPv4 address on untrusted/access network for SSC B.
  ssc_b_untrusted_ip_0: 127.0.0.1

  # Fixed IPv6 address on untrusted/access network for SSC B.
  ssc_b_untrusted_v6_ip_0: 2001:1890:1001:2B38::2D:3

  #
  # SSC IP addresses on management/Rf network
  #

  # Virtual IPv4 address on management/Rf network for SSC.
  ssc_rf_vip_0: 10.147.188.135

  # Fixed IPv4 address on management/Rf network for SSC A.
  ssc_a_rf_ip_0: 10.147.188.134

  # Fixed IPv4 address on management/Rf network for SSC B.
  ssc_b_rf_ip_0: 10.147.188.137


  #
  # RTP MSC parameters
  #

  # Count of required RTP MSCs
  rtp_msc_count: 1

  # Flavor to use for creating RTP MSC VM instances
  rtp_msc_flavor_name: 41e7508e-bf2a-406e-9563-8219c3aa6c02

  # Glance image to use for launching RTP MSC Perimeta instances.
  rtp_msc_image_name: 3aedaeb5-fbb4-4802-9e1f-a421087d2adb

  # List of names of RTP MSC VM A instances
  rtp_msc_a_names: ["ibcx0002vm003msc001","ibcx0002vm005msc001","ibcx0002vm007msc001","ibcx0002vm009msc001","ibcx0002vm011msc001"]

  # List of names of RTP MSC VM B instances
  rtp_msc_b_names: ["ibcx0002vm004msc001","ibcx0002vm006msc001","ibcx0002vm008msc001","ibcx0002vm010msc001","ibcx0002vm012msc001"]

  # List of system names of RTP MSC instances
  rtp_msc_system_names: ["ibcx0002vm003msc001pair","ibcx0002vm005msc001pair","ibcx0002vm007msc001pair","ibcx0002vm009msc001pair","ibcx0002msc001vm011pair"]

  #
  # RTP MSC IP addresses on management network
  #

  # Management virtual IP addresses to use for RTP MSC instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_mgmt_vips: ["10.147.188.139","10.147.188.142","10.147.188.145","10.147.188.148","10.147.188.151"]

  # Management fixed IP addresses to use for RTP MSC A instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_a_mgmt_ips: ["10.147.188.138","10.147.188.141","10.147.188.144","10.147.188.147","10.147.188.150"]

  # Management fixed IP addresses to use for RTP MSC B instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_b_mgmt_ips: ["10.147.188.140","10.147.188.143","10.147.188.146","10.147.188.149","10.147.188.152"]

  # HA fixed IP addresses to use for RTP MSC A instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_a_int_ha_ips: ["10.0.0.6","10.0.0.8","10.0.0.10","10.0.0.12","10.0.0.14"]

  # HA fixed IP addresses to use for RTP MSC B instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_b_int_ha_ips: ["10.0.0.7","10.0.0.9","10.0.0.11","10.0.0.13","10.0.0.15"]

  #
  # RTP MSC IP addresses on trusted/core network
  #

  # Virtual IPv4 addresses on trusted/core network for RTP MSC instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_trusted_vips: ["10.1.1.8","10.1.1.11","10.1.1.14","10.1.1.17","10.1.1.20"]

  # Fixed IPv4 addresses on trusted/core network for RTP MSC A instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_a_trusted_ips: ["10.1.1.7","10.1.1.10","10.1.1.13","10.1.1.16","10.1.1.19"]

  # Fixed IP address on trusted/core network for RTP MSC B instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_b_trusted_ips: ["10.1.1.9","10.1.1.12","10.1.1.15","10.1.1.18","10.1.1.21"]

  #
  # RTP MSC IP addresses on untrusted/access network
  #

  # Virtual IPv4 address on untrusted/access network for RTP MSC instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_untrusted_vips: ["127.0.0.1","127.0.0.1","127.0.0.1","127.0.0.1","127.0.0.1"]

  # Virtual IPv6 address on untrusted/access network for RTP MSC instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_untrusted_v6_vips: ["2001:1890:1001:2B38::2D:5","2001:1890:1001:2B38::2D:8","2001:1890:1001:2B38::2D:B","2001:1890:1001:2B38::2D:E","2001:1890:1001:2B38::2D:11"]

  # Fixed IPv4 address on untrusted/access network for RTP MSC A instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_a_untrusted_ips: ["127.0.0.1","127.0.0.1","127.0.0.1","127.0.0.1","127.0.0.1"]

  # Fixed IPv6 address on untrusted/access network for RTP MSC A instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_a_untrusted_v6_ips: ["2001:1890:1001:2B38::2D:4","2001:1890:1001:2B38::2D:7","2001:1890:1001:2B38::2D:A","2001:1890:1001:2B38::2D:D","2001:1890:1001:2B38::2D:10"]

  # Fixed IPv4 address on untrusted/access network for RTP MSC B instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_b_untrusted_ips: ["127.0.0.1","127.0.0.1","127.0.0.1","127.0.0.1","127.0.0.1"]

  # Fixed IPv6 address on untrusted/access network for RTP MSC B instances. There must be at least as many as the number of RTP MSCs.
  rtp_msc_b_untrusted_v6_ips: ["2001:1890:1001:2B38::2D:6","2001:1890:1001:2B38::2D:9","2001:1890:1001:2B38::2D:C","2001:1890:1001:2B38::2D:F","2001:1890:1001:2B38::2D:12"]