heat/vFW/base_vfw.yaml

   1 ##########################################################################
   2 #
   3 #==================LICENSE_START==========================================
   4 #
   5 #
   6 # Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
   7 #
   8 # Licensed under the Apache License, Version 2.0 (the "License");
   9 # you may not use this file except in compliance with the License.
  10 # You may obtain a copy of the License at
  11 #        http://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19 #==================LICENSE_END============================================
  20 #
  21 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22 #
  23 ##########################################################################
  24
  25 heat_template_version: 2013-05-23
  26
  27 description: Heat template that deploys vFirewall demo app for ONAP
  28
  29 ##############
  30 #            #
  31 # PARAMETERS #
  32 #            #
  33 ##############
  34
  35 parameters:
  36   vfw_image_name:
  37     type: string
  38     label: Image name or ID
  39     description: Image to be used for compute instance
  40   vfw_flavor_name:
  41     type: string
  42     label: Flavor
  43     description: Type of instance (flavor) to be used
  44   vpg_image_name:
  45     type: string
  46     label: Image name or ID
  47     description: Image to be used for compute instance
  48   vpg_flavor_name:
  49     type: string
  50     label: Flavor
  51     description: Type of instance (flavor) to be used
  52   vsn_image_name:
  53     type: string
  54     label: Image name or ID
  55     description: Image to be used for compute instance
  56   vsn_flavor_name:
  57     type: string
  58     label: Flavor
  59     description: Type of instance (flavor) to be used
  60   public_net_id:
  61     type: string
  62     label: Public network name or ID
  63     description: Public network that enables remote connection to VNF
  64   unprotected_private_net_id:
  65     type: string
  66     label: Unprotected private network name or ID
  67     description: Private network that connects vPacketGenerator with vFirewall
  68   protected_private_net_id:
  69     type: string
  70     label: Protected private network name or ID
  71     description: Private network that connects vFirewall with vSink
  72   onap_private_net_id:
  73     type: string
  74     label: ONAP management network name or ID
  75     description: Private network that connects ONAP components and the VNF
  76   onap_private_subnet_id:
  77     type: string
  78     label: ONAP management sub-network name or ID
  79     description: Private sub-network that connects ONAP components and the VNF
  80   unprotected_private_net_cidr:
  81     type: string
  82     label: Unprotected private network CIDR
  83     description: The CIDR of the unprotected private network
  84   protected_private_net_cidr:
  85     type: string
  86     label: Protected private network CIDR
  87     description: The CIDR of the protected private network
  88   onap_private_net_cidr:
  89     type: string
  90     label: ONAP private network CIDR
  91     description: The CIDR of the protected private network
  92   vfw_int_unprotected_private_ip_0:
  93     type: string
  94     label: vFirewall private IP address towards the unprotected network
  95     description: Private IP address that is assigned to the vFirewall to communicate with the vPacketGenerator
  96   vfw_int_protected_private_ip_0:
  97     type: string
  98     label: vFirewall private IP address towards the protected network
  99     description: Private IP address that is assigned to the vFirewall to communicate with the vSink
 100   vfw_onap_private_ip_0:
 101     type: string
 102     label: vFirewall private IP address towards the ONAP management network
 103     description: Private IP address that is assigned to the vFirewall to communicate with ONAP components
 104   vfw_int_protected_private_floating_ip:
 105     type: string
 106     label: same value as vpg_int_unprotected_private_ip_0
 107     description: IP to inform OpenStack to enable vfw protected private port to allow packets coming from the packet generator
 108   vpg_int_unprotected_private_ip_0:
 109     type: string
 110     label: vPacketGenerator private IP address towards the unprotected network
 111     description: Private IP address that is assigned to the vPacketGenerator to communicate with the vFirewall
 112   vpg_onap_private_ip_0:
 113     type: string
 114     label: vPacketGenerator private IP address towards the ONAP management network
 115     description: Private IP address that is assigned to the vPacketGenerator to communicate with ONAP components
 116   vsn_int_protected_private_ip_0:
 117     type: string
 118     label: vSink private IP address towards the protected network
 119     description: Private IP address that is assigned to the vSink to communicate with the vFirewall
 120   vsn_onap_private_ip_0:
 121     type: string
 122     label: vSink private IP address towards the ONAP management network
 123     description: Private IP address that is assigned to the vSink to communicate with ONAP components
 124   vfw_name_0:
 125     type: string
 126     label: vFirewall name
 127     description: Name of the vFirewall
 128   vpg_name_0:
 129     type: string
 130     label: vPacketGenerator name
 131     description: Name of the vPacketGenerator
 132   vsn_name_0:
 133     type: string
 134     label: vSink name
 135     description: Name of the vSink
 136   vnf_id:
 137     type: string
 138     label: VNF ID
 139     description: The VNF ID is provided by ONAP
 140   vnf_name:
 141     type: string
 142     label: VNF NAME
 143     description: The VNF NAME is provided by ONAP
 144   vf_module_id:
 145     type: string
 146     label: vFirewall module ID
 147     description: The vFirewall Module ID is provided by ONAP
 148   dcae_collector_ip:
 149     type: string
 150     label: DCAE collector IP address
 151     description: IP address of the DCAE collector
 152   dcae_collector_port:
 153     type: string
 154     label: DCAE collector port
 155     description: Port of the DCAE collector
 156   key_name:
 157     type: string
 158     label: Key pair name
 159     description: Public/Private key pair name
 160   pub_key:
 161     type: string
 162     label: Public key
 163     description: Public key to be installed on the compute instance
 164   install_script_version:
 165     type: string
 166     label: Installation script version number
 167     description: Version number of the scripts that install the vFW demo app
 168   demo_artifacts_version:
 169     type: string
 170     label: Artifacts version used in demo vnfs
 171     description: Artifacts (jar, tar.gz) version used in demo vnfs
 172   nexus_artifact_repo:
 173     type: string
 174     description: Root URL for the Nexus repository for Maven artifacts.
 175   cloud_env:
 176     type: string
 177     label: Cloud environment
 178     description: Cloud environment (e.g., openstack, rackspace)
 179   sec_group:
 180     type: string
 181     description: ONAP Security Group
 182
 183 #############
 184 #           #
 185 # RESOURCES #
 186 #           #
 187 #############
 188
 189 resources:
 190   random-str:
 191     type: OS::Heat::RandomString
 192     properties:
 193       length: 4
 194
 195   my_keypair:
 196     type: OS::Nova::KeyPair
 197     properties:
 198       name:
 199         str_replace:
 200           template: vnfname_base_rand
 201           params:
 202             base: { get_param: key_name }
 203             rand: { get_resource: random-str }
 204             vnfname: { get_param: vnf_name }
 205       public_key: { get_param: pub_key }
 206       save_private_key: false
 207
 208   # NETWORK_ROLE: unprotected_private
 209   # NETWORK_TYPE: internal
 210   int_unprotected_private_network:
 211     type: OS::Neutron::Net
 212     properties:
 213       name:
 214         str_replace:
 215           template: vnfname_netid
 216           params:
 217             netid: { get_param: unprotected_private_net_id }
 218             vnfname: { get_param: vnf_name }
 219
 220   # NETWORK_ROLE: protected_private
 221   # NETWORK_TYPE: internal
 222   int_protected_private_network:
 223     type: OS::Neutron::Net
 224     properties:
 225       name:
 226         str_replace:
 227           template: vnfname_netid
 228           params:
 229             netid: { get_param: protected_private_net_id }
 230             vnfname: { get_param: vnf_name }
 231
 232   # NETWORK_ROLE: unprotected_private
 233   # NETWORK_TYPE: internal
 234   int_unprotected_private_subnet:
 235     type: OS::Neutron::Subnet
 236     properties:
 237       network: { get_resource: int_unprotected_private_network }
 238       cidr: { get_param: unprotected_private_net_cidr }
 239
 240   # NETWORK_ROLE: protected_private
 241   # NETWORK_TYPE: internal
 242   int_protected_private_subnet:
 243     type: OS::Neutron::Subnet
 244     properties:
 245       network: { get_resource: int_protected_private_network }
 246       cidr: { get_param: protected_private_net_cidr }
 247
 248   ### Virtual Firewall instantiation ###
 249
 250   # VM_TYPE: vfw
 251   # NETWORK_ROLE: protected_private
 252   # NETWORK_TYPE: internal
 253   vfw_0_int_unprotected_private_port_0:
 254     type: OS::Neutron::Port
 255     properties:
 256       network: { get_resource: int_unprotected_private_network }
 257       fixed_ips: [{"subnet": { get_resource: int_unprotected_private_subnet }, "ip_address": { get_param: vfw_int_unprotected_private_ip_0 }}]
 258       security_groups:
 259       - { get_param: sec_group }
 260
 261   # VM_TYPE: vfw
 262   # NETWORK_ROLE: protected_private
 263   # NETWORK_TYPE: internal
 264   vfw_0_int_protected_private_port_0:
 265     type: OS::Neutron::Port
 266     properties:
 267       allowed_address_pairs: [{ "ip_address": { get_param: vfw_int_protected_private_floating_ip }}]
 268       network: { get_resource: int_protected_private_network }
 269       fixed_ips: [{"subnet": { get_resource: int_protected_private_subnet }, "ip_address": { get_param: vfw_int_protected_private_ip_0 }}]
 270       security_groups:
 271       - { get_param: sec_group }
 272
 273   # VM_TYPE: vfw
 274   # NETWORK_ROLE: onap_private
 275   # NETWORK_TYPE: external
 276   vfw_0_onap_private_port_0:
 277     type: OS::Neutron::Port
 278     properties:
 279       network: { get_param: onap_private_net_id }
 280       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vfw_onap_private_ip_0 }}]
 281       security_groups:
 282       - { get_param: sec_group }
 283
 284   # VM_TYPE: vfw
 285   vfw_server_0:
 286     type: OS::Nova::Server
 287     properties:
 288       image: { get_param: vfw_image_name }
 289       flavor: { get_param: vfw_flavor_name }
 290       name: { get_param: vfw_name_0 }
 291       key_name: { get_resource: my_keypair }
 292       networks:
 293         - network: { get_param: public_net_id }
 294         - port: { get_resource: vfw_0_int_unprotected_private_port_0 }
 295         - port: { get_resource: vfw_0_int_protected_private_port_0 }
 296         - port: { get_resource: vfw_0_onap_private_port_0 }
 297       metadata:
 298         vnf_id: { get_param: vnf_id }
 299         vf_module_id: { get_param: vf_module_id }
 300         vnf_name: { get_param: vnf_name }
 301       user_data_format: RAW
 302       user_data:
 303         str_replace:
 304           params:
 305             __dcae_collector_ip__ : { get_param: dcae_collector_ip }
 306             __dcae_collector_port__ : { get_param: dcae_collector_port }
 307             __demo_artifacts_version__ : { get_param: demo_artifacts_version }
 308             __install_script_version__ : { get_param: install_script_version }
 309             __vfw_private_ip_0__ : { get_param: vfw_int_unprotected_private_ip_0 }
 310             __vfw_private_ip_1__ : { get_param: vfw_int_protected_private_ip_0 }
 311             __vfw_private_ip_2__ : { get_param: vfw_onap_private_ip_0 }
 312             __unprotected_private_net_cidr__ : { get_param: unprotected_private_net_cidr }
 313             __protected_private_net_cidr__ : { get_param: protected_private_net_cidr }
 314             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 315             __cloud_env__ : { get_param: cloud_env }
 316             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 317           template: |
 318             #!/bin/bash
 319
 320             # Create configuration files
 321             mkdir /opt/config
 322             echo "__dcae_collector_ip__" > /opt/config/dcae_collector_ip.txt
 323             echo "__dcae_collector_port__" > /opt/config/dcae_collector_port.txt
 324             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 325             echo "__install_script_version__" > /opt/config/install_script_version.txt
 326             echo "__vfw_private_ip_0__" > /opt/config/vfw_private_ip_0.txt
 327             echo "__vfw_private_ip_1__" > /opt/config/vfw_private_ip_1.txt
 328             echo "__vfw_private_ip_2__" > /opt/config/vfw_private_ip_2.txt
 329             echo "__unprotected_private_net_cidr__" > /opt/config/unprotected_private_net_cidr.txt
 330             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 331             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 332             echo "__cloud_env__" > /opt/config/cloud_env.txt
 333             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 334
 335             # Download and run install script
 336             apt-get update
 337             apt-get -y install unzip
 338             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 339             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vfw&a=vfw-scripts&e=zip&v=__install_script_version__" -o /opt/vfw-scripts-__install_script_version__.zip
 340             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_firewall_install.sh
 341             cd /opt
 342             chmod +x v_firewall_install.sh
 343             ./v_firewall_install.sh
 344
 345
 346   ### Virtual Packet Generator instantiation ###
 347
 348   vpg_0_int_unprotected_private_port_0:
 349     type: OS::Neutron::Port
 350     properties:
 351       network: { get_resource: int_unprotected_private_network }
 352       fixed_ips: [{"subnet": { get_resource: int_unprotected_private_subnet }, "ip_address": { get_param: vpg_int_unprotected_private_ip_0 }}]
 353       security_groups:
 354       - { get_param: sec_group }
 355
 356   vpg_0_onap_private_port_0:
 357     type: OS::Neutron::Port
 358     properties:
 359       network: { get_param: onap_private_net_id }
 360       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vpg_onap_private_ip_0 }}]
 361       security_groups:
 362       - { get_param: sec_group }
 363
 364   vpg_server_0:
 365     type: OS::Nova::Server
 366     properties:
 367       image: { get_param: vpg_image_name }
 368       flavor: { get_param: vpg_flavor_name }
 369       name: { get_param: vpg_name_0 }
 370       key_name: { get_resource: my_keypair }
 371       networks:
 372         - network: { get_param: public_net_id }
 373         - port: { get_resource: vpg_0_int_unprotected_private_port_0 }
 374         - port: { get_resource: vpg_0_onap_private_port_0 }
 375       metadata:
 376         vnf_id: { get_param: vnf_id }
 377         vf_module_id: { get_param: vf_module_id }
 378         vnf_name: { get_param: vnf_name }
 379       user_data_format: RAW
 380       user_data:
 381         str_replace:
 382           params:
 383             __fw_ipaddr__: { get_param: vfw_int_unprotected_private_ip_0 }
 384             __protected_net_cidr__: { get_param: protected_private_net_cidr }
 385             __sink_ipaddr__: { get_param: vsn_int_protected_private_ip_0 }
 386             __demo_artifacts_version__ : { get_param: demo_artifacts_version }
 387             __install_script_version__ : { get_param: install_script_version }
 388             __vpg_private_ip_0__ : { get_param: vpg_int_unprotected_private_ip_0 }
 389             __vpg_private_ip_1__ : { get_param: vpg_onap_private_ip_0 }
 390             __unprotected_private_net_cidr__ : { get_param: unprotected_private_net_cidr }
 391             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 392             __cloud_env__ : { get_param: cloud_env }
 393             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 394           template: |
 395             #!/bin/bash
 396
 397             # Create configuration files
 398             mkdir /opt/config
 399             echo "__fw_ipaddr__" > /opt/config/fw_ipaddr.txt
 400             echo "__protected_net_cidr__" > /opt/config/protected_net_cidr.txt
 401             echo "__sink_ipaddr__" > /opt/config/sink_ipaddr.txt
 402             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 403             echo "__install_script_version__" > /opt/config/install_script_version.txt
 404             echo "__vpg_private_ip_0__" > /opt/config/vpg_private_ip_0.txt
 405             echo "__vpg_private_ip_1__" > /opt/config/vpg_private_ip_1.txt
 406             echo "__unprotected_private_net_cidr__" > /opt/config/unprotected_private_net_cidr.txt
 407             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 408             echo "__cloud_env__" > /opt/config/cloud_env.txt
 409             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 410
 411             # Download and run install script
 412             apt-get update
 413             apt-get -y install unzip
 414             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 415             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vfw&a=vfw-scripts&e=zip&v=__install_script_version__" -o /opt/vfw-scripts-__install_script_version__.zip
 416             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_packetgen_install.sh
 417             cd /opt
 418             chmod +x v_packetgen_install.sh
 419             ./v_packetgen_install.sh
 420
 421
 422   ### Virtual Sink instantiation ###
 423
 424   vsn_0_int_protected_private_port_0:
 425     type: OS::Neutron::Port
 426     properties:
 427       network: { get_resource: int_protected_private_network }
 428       fixed_ips: [{"subnet": { get_resource: int_protected_private_subnet }, "ip_address": { get_param: vsn_int_protected_private_ip_0 }}]
 429       security_groups:
 430       - { get_param: sec_group }
 431
 432   vsn_0_onap_private_port_0:
 433     type: OS::Neutron::Port
 434     properties:
 435       network: { get_param: onap_private_net_id }
 436       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vsn_onap_private_ip_0 }}]
 437       security_groups:
 438       - { get_param: sec_group }
 439
 440   vsn_server_0:
 441     type: OS::Nova::Server
 442     properties:
 443       image: { get_param: vsn_image_name }
 444       flavor: { get_param: vsn_flavor_name }
 445       name: { get_param: vsn_name_0 }
 446       key_name: { get_resource: my_keypair }
 447       networks:
 448         - network: { get_param: public_net_id }
 449         - port: { get_resource: vsn_0_int_protected_private_port_0 }
 450         - port: { get_resource: vsn_0_onap_private_port_0 }
 451       metadata:
 452         vnf_id: { get_param: vnf_id }
 453         vf_module_id: { get_param: vf_module_id }
 454         vnf_name: { get_param: vnf_name }
 455       user_data_format: RAW
 456       user_data:
 457         str_replace:
 458           params:
 459             __protected_net_gw__: { get_param: vfw_int_protected_private_ip_0 }
 460             __unprotected_net__: { get_param: unprotected_private_net_cidr }
 461             __install_script_version__ : { get_param: install_script_version }
 462             __vsn_private_ip_0__ : { get_param: vsn_int_protected_private_ip_0 }
 463             __vsn_private_ip_1__ : { get_param: vsn_onap_private_ip_0 }
 464             __protected_private_net_cidr__ : { get_param: protected_private_net_cidr }
 465             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 466             __cloud_env__ : { get_param: cloud_env }
 467             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 468           template: |
 469             #!/bin/bash
 470
 471             # Create configuration files
 472             mkdir /opt/config
 473             echo "__protected_net_gw__" > /opt/config/protected_net_gw.txt
 474             echo "__unprotected_net__" > /opt/config/unprotected_net.txt
 475             echo "__install_script_version__" > /opt/config/install_script_version.txt
 476             echo "__vsn_private_ip_0__" > /opt/config/vsn_private_ip_0.txt
 477             echo "__vsn_private_ip_1__" > /opt/config/vsn_private_ip_1.txt
 478             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 479             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 480             echo "__cloud_env__" > /opt/config/cloud_env.txt
 481             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 482
 483             # Download and run install script
 484             apt-get update
 485             apt-get -y install unzip
 486             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 487             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vfw&a=vfw-scripts&e=zip&v=__install_script_version__" -o /opt/vfw-scripts-__install_script_version__.zip
 488             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_sink_install.sh
 489             cd /opt
 490             chmod +x v_sink_install.sh
 491             ./v_sink_install.sh